Professional Documents
Culture Documents
ASA Config Guide
ASA Config Guide
__________
Average packet
size (bytes)
2
x
__________
Delay (ms)
3
=
__________
Queue limit
(# of packets)
54-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Configuring QoS
Table 54-2 shows how to calculate the TX ring limit. This limit determines the maximum number of
packets allowed into the Ethernet transmit driver before the driver pushes back to the queues on the
interface to let them buffer packets until the congestion clears. This setting guarantees that the
hardware-based transmit ring imposes a limited amount of extra latency for a high-priority packet.
Configuring the Standard Priority Queue for an Interface
If you enable standard priority queuing for traffic on a physical interface, then you need to also create
the priority queue on each interface. Each physical interface uses two queues: one for priority traffic,
and the other for all other traffic. For the other traffic, you can optionally configure policing.
Note The standard priority queue is not required for hierarchical priority queuing with traffic shaping; see the
Information About Priority Queuing section on page 54-3 for more information.
Restrictions
(ASASM) The ASASM does not support priority queuing.
(ASA 5580) You cannot create a standard priority queue for a Ten Gigabit Ethernet interface. Note:
For the ASA 5585-X, standard priority queuing is supported on a Ten Gigabit Ethernet interface.
(ASA 5512-X through ASA 5555-X) Priority queuing is not supported on the Management 0/0
interface.
1. For example, DSL might have an uplink speed of 768 Kbps. Check with your provider.
2. Determine this value from a codec or sampling size. For example, for VoIP over VPN, you might use 160 bytes. We recommend 256
bytes if you do not know what size to use.
3. The delay depends on your application. For example, the recommended maximum delay for VoIP is 200 ms. We recommend 500 ms
if you do not know what delay to use.
Table 54-2 TX Ring Limit Worksheet
Step 1
__________
Outbound
bandwidth
(Mbps or Kbps)
1
1. For example, DSL might have an uplink speed of 768 Kbps.Check with your provider.
Mbps
x
125
=
__________
# of bytes/ms
Kbps
x
0.125
=
__________
# of bytes/ms
Step 2
___________
# of bytes/ms
from Step 1
__________
Maximum packet
size (bytes)
2
2. Typically, the maximum size is 1538 bytes, or 1542 bytes for tagged Ethernet. If you allow jumbo frames (if supported for your
platform), then the packet size might be larger.
x
__________
Delay (ms)
3
3. The delay depends on your application. For example, to control jitter for VoIP, you should use 20 ms.
=
__________
TX ring limit
(# of packets)
54-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Configuring QoS
Detailed Steps
Examples
The following example establishes a priority queue on interface outside (the GigabitEthernet0/1
interface), with the default queue-limit and tx-ring-limit:
hostname(config)# priority-queue outside
The following example establishes a priority queue on the interface outside (the GigabitEthernet0/1
interface), sets the queue-limit to 260 packets, and sets the tx-ring-limit to 3:
hostname(config)# priority-queue outside
hostname(config-priority-queue)# queue-limit 260
hostname(config-priority-queue)# tx-ring-limit 3
Command Purpose
Step 1 priority-queue interface_name
Example:
hostname(config)# priority-queue inside
Creatse the priority queue, where the interface_name argument
specifies the physical interface name on which you want to enable
the priority queue, or for the ASA 5505 or ASASM, the VLAN
interface name.
Step 2 queue-limit number_of_packets
Example:
hostname(config-priority-queue)#
queue-limit 260
Changes the size of the priority queues. The default queue limit is
1024 packets. Because queues are not of infinite size, they can fill
and overflow. When a queue is full, any additional packets cannot
get into the queue and are dropped (called tail drop). To avoid
having the queue fill up, you can use the queue-limit command to
increase the queue buffer size.
The upper limit of the range of values for the queue-limit
command is determined dynamically at run time. To view this
limit, enter queue-limit ? on the command line. The key
determinants are the memory needed to support the queues and
the memory available on the device.
The queue-limit that you specify affects both the higher priority
low-latency queue and the best effort queue.
Step 3 tx-ring-limit number_of_packets
Example:
hostname(config-priority-queue)#
tx-ring-limit 3
Specifies the depth of the priority queues. The default
tx-ring-limit is 128 packets. This command sets the maximum
number of low-latency or normal priority packets allowed into the
Ethernet transmit driver before the driver pushes back to the
queues on the interface to let them buffer packets until the
congestion clears. This setting guarantees that the hardware-based
transmit ring imposes a limited amount of extra latency for a
high-priority packet.
The upper limit of the range of values for the tx-ring-limit
command is determined dynamically at run time. To view this
limit, enter tx-ring-limit ? on the command line. The key
determinants are the memory needed to support the queues and
the memory available on the device.
The tx-ring-limit that you specify affects both the higher priority
low-latency queue and the best-effort queue.
54-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Configuring QoS
Configuring a Service Rule for Standard Priority Queuing and Policing
You can configure standard priority queuing and policing for different class maps within the same policy
map. See the How QoS Features Interact section on page 54-4 for information about valid QoS
configurations.
To create a policy map, perform the following steps.
Restrictions
You cannot use the class-default class map for priority traffic.
You cannot configure traffic shaping and standard priority queuing for the same interface; only
hierarchical priority queuing is allowed.
(ASASM) The ASASM only supports policing.
Guidelines
For priority traffic, identify only latency-sensitive traffic.
For policing traffic, you can choose to police all other traffic, or you can limit the traffic to certain
types.
Detailed Steps
Command Purpose
Step 1 class-map policing_map_name
Example:
hostname(config)# class-map
policing_traffic
For policing traffic, creates a class map to identify the traffic for
which you want to perform policing.
Step 2 match parameter
Example:
hostname(config-cmap)# match access-list
policing
Specifies the traffic in the class map. See the Identifying Traffic
(Layer 3/4 Class Maps) section on page 32-12 for more
information.
Step 3 class-map priority_map_name
Example:
hostname(config)# class-map
priority_traffic
For priority traffic, creates a class map to identify the traffic for
which you want to perform priority queuing.
Step 4 match parameter
Example:
hostname(config-cmap)# match access-list
priority
Specifies the traffic in the class map. See the Identifying Traffic
(Layer 3/4 Class Maps) section on page 32-12 for more
information.
Step 5 policy-map name
Example:
hostname(config)# policy-map QoS_policy
Adds or edits a policy map.
54-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Configuring QoS
Examples
Example 54-1 Class Map Examples for VPN Traffic
In the following example, the class-map command classifies all non-tunneled TCP traffic, using an
access list named tcp_traffic:
hostname(config)# access-list tcp_traffic permit tcp any any
Step 6 class policing_map_name
Example:
hostname(config-pmap)# class
policing_class
Identifies the class map you created for policed traffic in Step 1.
Step 7 police {output | input} conform-rate
[conform-burst] [conform-action [drop |
transmit]] [exceed-action [drop |
transmit]]
Example:
hostname(config-pmap-c)# police output
56000 10500
Configures policing for the class. See the followingoptions:
conform-burst argumentSpecifies the maximum number of
instantaneous bytes allowed in a sustained burst before
throttling to the conforming rate value, between 1000 and
512000000 bytes.
conform-actionSets the action to take when the rate is less
than the conform_burst value.
conform-rateSets the rate limit for this traffic flow;
between 8000 and 2000000000 bits per second.]
dropDrops the packet.
exceed-actionSets the action to take when the rate is
between the conform-rate value and the conform-burst value.
inputEnables policing of traffic flowing in the input
direction.
outputEnables policing of traffic flowing in the output
direction.
transmitTransmits the packet.
Step 8 class priority_map_name
Example:
hostname(config-pmap)# class
priority_class
Identifies the class map you created for prioritized traffic in
Step 3.
Step 9 priority
Example:
hostname(config-pmap-c)# priority
Configures priority queuing for the class.
Step 10 service-policy policymap_name {global |
interface interface_name}
Example:
hostname(config)# service-policy
QoS_policy interface inside
Activates the policy map on one or more interfaces. global applies
the policy map to all interfaces, and interface applies the policy
to one interface. Only one global policy is allowed. You can
override the global policy on an interface by applying a service
policy to that interface. You can only apply one policy map to
each interface.
Command Purpose
54-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Configuring QoS
hostname(config)# class-map tcp_traffic
hostname(config-cmap)# match access-list tcp_traffic
In the following example, other, more specific match criteria are used for classifying traffic for specific,
security-related tunnel groups. These specific match criteria stipulate that a match on tunnel-group (in
this case, the previously-defined Tunnel-Group-1) is required as the first match characteristic to classify
traffic for a specific tunnel, and it allows for an additional match line to classify the traffic (IP differential
services code point, expedited forwarding).
hostname(config)# class-map TG1-voice
hostname(config-cmap)# match tunnel-group tunnel-grp1
hostname(config-cmap)# match dscp ef
In the following example, the class-map command classifies both tunneled and non-tunneled traffic
according to the traffic type:
hostname(config)# access-list tunneled extended permit ip 10.10.34.0 255.255.255.0
192.168.10.0 255.255.255.0
hostname(config)# access-list non-tunneled extended permit tcp any any
hostname(config)# tunnel-group tunnel-grp1 type IPsec_L2L
hostname(config)# class-map browse
hostname(config-cmap)# description "This class-map matches all non-tunneled tcp traffic."
hostname(config-cmap)# match access-list non-tunneled
hostname(config-cmap)# class-map TG1-voice
hostname(config-cmap)# description "This class-map matches all dscp ef traffic for
tunnel-grp 1."
hostname(config-cmap)# match dscp ef
hostname(config-cmap)# match tunnel-group tunnel-grp1
hostname(config-cmap)# class-map TG1-BestEffort
hostname(config-cmap)# description "This class-map matches all best-effort traffic for
tunnel-grp1."
hostname(config-cmap)# match tunnel-group tunnel-grp1
hostname(config-cmap)# match flow ip destination-address
The following example shows a way of policing a flow within a tunnel, provided the classed traffic is
not specified as a tunnel, but does go through the tunnel. In this example, 192.168.10.10 is the address
of the host machine on the private side of the remote tunnel, and the access list is named host-over-l2l.
By creating a class-map (named host-specific), you can then police the host-specific class before the
LAN-to-LAN connection polices the tunnel. In this example, the host-specific traffic is rate-limited
before the tunnel, then the tunnel is rate-limited:
hostname(config)# access-list host-over-l2l extended permit ip any host 192.168.10.10
hostname(config)# class-map host-specific
hostname(config-cmap)# match access-list host-over-l2l
The following example builds on the configuration developed in the previous section. As in the previous
example, there are two named class-maps: tcp_traffic and TG1-voice.
hostname(config)# class-map TG1-best-effort
hostname(config-cmap)# match tunnel-group Tunnel-Group-1
hostname(config-cmap)# match flow ip destination-address
Adding a third class map provides a basis for defining a tunneled and non-tunneled QoS policy, as
follows, which creates a simple QoS policy for tunneled and non-tunneled traffic, assigning packets of
the class TG1-voice to the low latency queue and setting rate limits on the tcp_traffic and
TG1-best-effort traffic flows.
54-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Configuring QoS
Example 54-2 Priority and Policing Example
In this example, the maximum rate for traffic of the tcp_traffic class is 56,000 bits/second and a
maximum burst size of 10,500 bytes per second. For the TG1-BestEffort class, the maximum rate is
200,000 bits/second, with a maximum burst of 37,500 bytes/second. Traffic in the TG1-voice class has
no policed maximum speed or burst rate because it belongs to a priority class.
hostname(config)# access-list tcp_traffic permit tcp any any
hostname(config)# class-map tcp_traffic
hostname(config-cmap)# match access-list tcp_traffic
hostname(config)# class-map TG1-voice
hostname(config-cmap)# match tunnel-group tunnel-grp1
hostname(config-cmap)# match dscp ef
hostname(config-cmap)# class-map TG1-BestEffort
hostname(config-cmap)# match tunnel-group tunnel-grp1
hostname(config-cmap)# match flow ip destination-address
hostname(config)# policy-map qos
hostname(config-pmap)# class tcp_traffic
hostname(config-pmap-c)# police output 56000 10500
hostname(config-pmap-c)# class TG1-voice
hostname(config-pmap-c)# priority
hostname(config-pmap-c)# class TG1-best-effort
hostname(config-pmap-c)# police output 200000 37500
hostname(config-pmap-c)# class class-default
hostname(config-pmap-c)# police output 1000000 37500
hostname(config-pmap-c)# service-policy qos global
Configuring a Service Rule for Traffic Shaping and Hierarchical Priority
Queuing
You can configure traffic shaping for all traffic on an interface, and optionally hierarchical priority
queuing for a subset of latency-sensitive traffic.
This section includes the following topics:
(Optional) Configuring the Hierarchical Priority Queuing Policy, page 54-12
Configuring the Service Rule, page 54-13
(Optional) Configuring the Hierarchical Priority Queuing Policy
You can optionally configure priority queuing for a subset of latency-sensitive traffic.
Guidelines
One side-effect of priority queuing is packet re-ordering. For IPsec packets, out-of-order packets
that are not within the anti-replay window generate warning syslog messages. These warnings are
false alarms in the case of priority queuing. You can configure the IPsec anti-replay window size to
avoid possible false alarms. See the crypto ipsec security-association replay command in the
command reference.For hierarchical priority queuing, you do not need to create a priority queue on
an interface.
54-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Configuring QoS
Restrictions
For hierarchical priority queuing, for encrypted VPN traffic, you can only match traffic based on the
DSCP or precedence setting; you cannot match a tunnel group.
For hierarchical priority queuing, IPsec-over-TCP traffic is not supported.
Detailed Steps
Configuring the Service Rule
To configure traffic shaping and optional hiearchical priority queuing, perform the following steps.
Restrictions
Traffic shaping is not supported on the multi-processor models.
For traffic shaping, you can only use the class-default class map, which is automatically created by
the ASA, and which matches all traffic.
You cannot configure traffic shaping and standard priority queuing for the same interface; only
hierarchical priority queuing is allowed. See the How QoS Features Interact section on page 54-4
for information about valid QoS configurations.
You cannot configure traffic shaping in the global policy.
Command Purpose
Step 1 class-map priority_map_name
Example:
hostname(config)# class-map
priority_traffic
For hierarchical priority queuing, creates a class map to identify
the traffic for which you want to perform priority queuing.
Step 2 match parameter
Example:
hostname(config-cmap)# match access-list
priority
Specifies the traffic in the class map. See the Identifying Traffic
(Layer 3/4 Class Maps) section on page 32-12 for more
information. For encrypted VPN traffic, you can only match
traffic based on the DSCP or precedence setting; you cannot
match a tunnel group.
Step 3 policy-map priority_map_name
Example:
hostname(config)# policy-map
priority-sub-policy
Creates a policy map.
Step 4 class priority_map_name
Example:
hostname(config-pmap)# class
priority-sub-map
Specifies the class map you created in Step 1.
Step 5 priority
Example:
hostname(config-pmap-c)# priority
Applies the priority queuing action to a class map.
Note This policy has not yet been activated. You must activate
it as part of the shaping policy. See the Configuring the
Service Rule section on page 54-13.
54-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Configuring QoS
Detailed Steps
Examples
The following example enables traffic shaping on the outside interface, and limits traffic to 2 Mbps;
priority queuing is enabled for VoIP traffic that is tagged with DSCP EF and AF13 and for IKE traffic:
hostname(config)# access-list ike permit udp any any eq 500
hostname(config)# class-map ike
hostname(config-cmap)# match access-list ike
hostname(config-cmap)# class-map voice_traffic
hostname(config-cmap)# match dscp EF AF13
hostname(config-cmap)# policy-map qos_class_policy
Command Purpose
Step 1 policy-map name
Example:
hostname(config)# policy-map shape_policy
Adds or edits a policy map. This policy map must be different
from the hierarchical priority-queuing map.
Step 2 class class-default
Example:
hostname(config-pmap)# class class-default
Identifies all traffic for traffic shaping; you can only use the
class-default class map, which is defined as match any, because
the ASA requires all traffic to be matched for traffic shaping.
Step 3 shape average rate [burst_size]
Example:
hostname(config-pmap-c)# shape average
70000 4000
Enables traffic shaping, where the average rate argument sets the
average rate of traffic in bits per second over a given fixed time
period, between 64000 and 154400000. Specify a value that is a
multiple of 8000. See the Information About Traffic Shaping
section on page 54-4 for more information about how the time
period is calculated.
The burst_size argument sets the average burst size in bits that can
be transmitted over a given fixed time period, between 2048 and
154400000. Specify a value that is a multiple of 128. If you do not
specify the burst_size, the default value is equivalent to
4-milliseconds of traffic at the specified average rate. For
example, if the average rate is 1000000 bits per second, 4 ms
worth = 1000000 * 4/1000 = 4000.
Step 4 (Optional)
service-policy priority_policy_map_name
Example:
hostname(config-pmap-c)# service-policy
priority-sub-policy
Configures hierarchical priority queuing, where the
priority_policy_map_name is the policy map you created for
prioritized traffic in the (Optional) Configuring the Hierarchical
Priority Queuing Policy section on page 54-12.
Step 5 service-policy policymap_name interface
interface_name
Example:
hostname(config)# service-policy
shape-policy interface inside
Activates the shaping policy map on an interface.
54-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Monitoring QoS
hostname(config-pmap)# class voice_traffic
hostname(config-pmap-c)# priority
hostname(config-pmap-c)# class ike
hostname(config-pmap-c)# priority
hostname(config-pmap-c)# policy-map qos_outside_policy
hostname(config-pmap)# class class-default
hostname(config-pmap-c)# shape average 2000000 16000
hostname(config-pmap-c)# service-policy qos_class_policy
hostname(config-pmap-c)# service-policy qos_outside_policy interface outside
Monitoring QoS
This section includes the following topics:
Viewing QoS Police Statistics, page 54-15
Viewing QoS Standard Priority Statistics, page 54-16
Viewing QoS Shaping Statistics, page 54-16
Viewing QoS Standard Priority Queue Statistics, page 54-17
Viewing QoS Police Statistics
To view the QoS statistics for traffic policing, use the show service-policy command with the police
keyword:
hostname# show service-policy police
The following is sample output for the show service-policy police command:
hostname# show service-policy police
Global policy:
Service-policy: global_fw_policy
Interface outside:
Service-policy: qos
Class-map: browse
police Interface outside:
cir 56000 bps, bc 10500 bytes
conformed 10065 packets, 12621510 bytes; actions: transmit
exceeded 499 packets, 625146 bytes; actions: drop
conformed 5600 bps, exceed 5016 bps
Class-map: cmap2
police Interface outside:
cir 200000 bps, bc 37500 bytes
conformed 17179 packets, 20614800 bytes; actions: transmit
exceeded 617 packets, 770718 bytes; actions: drop
conformed 198785 bps, exceed 2303 bps
54-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Monitoring QoS
Viewing QoS Standard Priority Statistics
To view statistics for service policies implementing the priority command, use the show service-policy
command with the priority keyword:
hostname# show service-policy priority
The following is sample output for the show service-policy priority command:
hostname# show service-policy priority
Global policy:
Service-policy: global_fw_policy
Interface outside:
Service-policy: qos
Class-map: TG1-voice
Priority:
Interface outside: aggregate drop 0, aggregate transmit 9383
Note Aggregate drop denotes the aggregated drop in this interface; aggregate transmit denotes the
aggregated number of transmitted packets in this interface.
Viewing QoS Shaping Statistics
To view statistics for service policies implementing the shape command, use the show service-policy
command with the shape keyword:
hostname# show service-policy shape
The following is sample output for the show service-policy shape command:
hostname# show service-policy shape
Interface outside
Service-policy: shape
Class-map: class-default
Queueing
queue limit 64 packets
(queue depth/total drops/no-buffer drops) 0/0/0
(pkts output/bytes output) 0/0
shape (average) cir 2000000, bc 8000, be 8000
The following is sample output of the show service policy shape command, which includes service
policies that include the shape command and the service-policy command that calls the hierarchical
priority policy and the related statistics:
hostname# show service-policy shape
Interface outside:
Service-policy: shape
Class-map: class-default
Queueing
queue limit 64 packets
(queue depth/total drops/no-buffer drops) 0/0/0
(pkts output/bytes output) 0/0
shape (average) cir 2000000, bc 16000, be 16000
54-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Monitoring QoS
Service-policy: voip
Class-map: voip
Queueing
queue limit 64 packets
(queue depth/total drops/no-buffer drops) 0/0/0
(pkts output/bytes output) 0/0
Class-map: class-default
queue limit 64 packets
(queue depth/total drops/no-buffer drops) 0/0/0
(pkts output/bytes output) 0/0
Viewing QoS Standard Priority Queue Statistics
To display the priority-queue statistics for an interface, use the show priority-queue statistics command
in privileged EXEC mode. The results show the statistics for both the best-effort (BE) queue and the
low-latency queue (LLQ). The following example shows the use of the show priority-queue statistics
command for the interface named test, and the command output.
hostname# show priority-queue statistics test
Priority-Queue Statistics interface test
Queue Type = BE
Packets Dropped = 0
Packets Transmit = 0
Packets Enqueued = 0
Current Q Length = 0
Max Q Length = 0
Queue Type = LLQ
Packets Dropped = 0
Packets Transmit = 0
Packets Enqueued = 0
Current Q Length = 0
Max Q Length = 0
hostname#
In this statistical report, the meaning of the line items is as follows:
Packets Dropped denotes the overall number of packets that have been dropped in this queue.
Packets Transmit denotes the overall number of packets that have been transmitted in this queue.
Packets Enqueued denotes the overall number of packets that have been queued in this queue.
Current Q Length denotes the current depth of this queue.
Max Q Length denotes the maximum depth that ever occurred in this queue.
54-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 54 Configuring QoS
Feature History for QoS
Feature History for QoS
Table 54-3 lists each feature change and the platform release in which it was implemented.
Table 54-3 Feature History for QoS
Feature Name
Platform
Releases Feature Information
Priority queuing and policing 7.0(1) We introduced QoS priority queuing and policing.
We introduced the following commands: priority-queue,
queue-limit, tx-ring-limit, priority, police, show
priority-queue statistics, show service-policy police,
show service-policy priority, show running-config
priority-queue, clear configure priority-queue .
Shaping and hierarchical priority queuing 7.2(4)/8.0(4) We introduced QoS shaping and hierarchical priority
queuing.
We introduced the following commands: shape, show
service-policy shape.
Ten Gigabit Ethernet support for a standard
priority queue on the ASA 5585-X
8.2(3)/8.4(1) We added support for a standard priority queue on Ten
Gigabit Ethernet interfaces for the ASA 5585-X.
P A R T 1 3
Configuring Advanced Network Protection
C H A P T E R
55-1
Cisco ASA 5500 Series Configuration Guide using the CLI
55
Configuring the Botnet Traffic Filter
Malware is malicious software that is installed on an unknowing host. Malware that attempts network
activity such as sending private data (passwords, credit card numbers, key strokes, or proprietary data)
can be detected by the Botnet Traffic Filter when the malware starts a connection to a known bad IP
address. The Botnet Traffic Filter checks incoming and outgoing connections against a dynamic database
of known bad domain names and IP addresses (the blacklist), and then logs or blocks any suspicious
activity.
You can also supplement the Cisco dynamic database with blacklisted addresses of your choosing by
adding them to a static blacklist; if the dynamic database includes blacklisted addresses that you think
should not be blacklisted, you can manually enter them into a static whitelist. Whitelisted addresses still
generate syslog messages, but because you are only targeting blacklist syslog messages, they are
informational.
Note If you do not want to use the Cisco dynamic database at all, because of internal requirements, you can
use the static blacklist alone if you can identify all the malware sites that you want to target.
This chapter describes how to configure the Botnet Traffic Filter and includes the following sections:
Information About the Botnet Traffic Filter, page 55-1
Licensing Requirements for the Botnet Traffic Filter, page 55-6
Guidelines and Limitations, page 55-6
Default Settings, page 55-6
Configuring the Botnet Traffic Filter, page 55-6
Monitoring the Botnet Traffic Filter, page 55-17
Configuration Examples for the Botnet Traffic Filter, page 55-19
Where to Go Next, page 55-21
Feature History for the Botnet Traffic Filter, page 55-22
Information About the Botnet Traffic Filter
This section includes information about the Botnet Traffic Filter and includes the following topics:
Botnet Traffic Filter Address Types, page 55-2
Botnet Traffic Filter Actions for Known Addresses, page 55-2
55-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Information About the Botnet Traffic Filter
Botnet Traffic Filter Databases, page 55-2
How the Botnet Traffic Filter Works, page 55-5
Botnet Traffic Filter Address Types
Addresses monitored by the Botnet Traffic Filter include:
Known malware addressesThese addresses are on the blacklist identified by the dynamic database
and the static blacklist.
Known allowed addressesThese addresses are on the whitelist. The whitelist is useful when an
address is blacklisted by the dynamic database and also identified by the static whitelist.
Ambiguous addressesThese addresses are associated with multiple domain names, but not all of
these domain names are on the blacklist. These addresses are on the greylist.
Unlisted addressesThese addresses are unknown, and not included on any list.
Botnet Traffic Filter Actions for Known Addresses
You can configure the Botnet Traffic Filter to log suspicious activity, and you can optionally configure
it to block suspicious traffic automatically.
Unlisted addresses do not generate any syslog messages, but addresses on the blacklist, whitelist, and
greylist generate syslog messages differentiated by type. See the Botnet Traffic Filter Syslog
Messaging section on page 55-17 for more information.
Botnet Traffic Filter Databases
The Botnet Traffic Filter uses two databases for known addresses. You can use both databases together,
or you can disable use of the dynamic database and use the static database alone. This section includes
the following topics:
Information About the Dynamic Database, page 55-2
Information About the Static Database, page 55-3
Information About the DNS Reverse Lookup Cache and DNS Host Cache, page 55-4
Information About the Dynamic Database
The Botnet Traffic Filter can receive periodic updates for the dynamic database from the Cisco update
server. This database lists thousands of known bad domain names and IP addresses.
How the ASA Uses the Dynamic Database
The ASA uses the dynamic database as follows:
1. When the domain name in a DNS reply matches a name in the dynamic database, the Botnet Traffic
Filter adds the name and IP address to the DNS reverse lookup cache.
2. When the infected host starts a connection to the IP address of the malware site, then the ASA sends
a syslog message informing you of the suspicious activity and optionally drops the traffic if you
configured the ASA to do so.
55-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Information About the Botnet Traffic Filter
3. In some cases, the IP address itself is supplied in the dynamic database, and the Botnet Traffic Filter
logs or drops any traffic to that IP address without having to inspect DNS requests.
Database Files
The database files are stored in running memory; they are not stored in flash memory. If you need to
delete the database, use the dynamic-filter database purge command instead. Be sure to first disable
use of the database by entering the no dynamic-filter use-database command.
Note To use the database, be sure to configure a domain name server for the ASA so that it can access the URL.
To use the domain names in the dynamic database, you need to enable DNS packet inspection with
Botnet Traffic Filter snooping; the ASA looks inside the DNS packets for the domain name and
associated IP address.
Database Traffic Types
The dynamic database includes the following types of addresses:
AdsAdvertising networks that deliver banner ads, interstitials, rich media ads, pop-ups, and
pop-unders for websites, spyware and adware. Some of these networks send ad-oriented HTML
emails and email verification services.
Data TrackingSources associated with companies and websites that offer data tracking and
metrics services to websites and other online entities. Some of these also run small advertising
networks.
SpywareSources that distribute spyware, adware, greyware, and other potentially unwanted
advertising software. Some of these also run exploits to install such software.
Malware (higher threat level)Sources that use various exploits to deliver adware, spyware and
other malware to victim computers. Some of these are associated with rogue online vendors and
distributors of dialers which deceptively call premium-rate phone numbers.
Malware (lower threat level)Sources that deliver deceptive or malicious anti-spyware,
anti-malware, registry cleaning, and system cleaning software.
AdultSources associated with adult networks/services offering web hosting for adult content,
advertising, content aggregation, registration and billing, and age verification. These may be tied to
distribution of adware, spyware, and dialers.
Bot and Threat NetworksRogue systems that control infected computers. They are either systems
hosted on threat networks or systems that are part of the botnet itself."
(Conficker) Bot and Threat NetworksCommand-and-control servers or botnet-masters of
conficker botnets.
(ZeusBotnet) Bot and Threat NetworksCommand-and-control servers or botnet-masters of Zeus
botnets.
Information About the Static Database
You can manually enter domain names or IP addresses (host or subnet) that you want to tag as bad names
in a blacklist. Static blacklist entries are always designated with a Very High threat level. You can also
enter names or IP addresses in a whitelist, so that names or addresses that appear on both the dynamic
55-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Information About the Botnet Traffic Filter
blacklist and the whitelist are identified only as whitelist addresses in syslog messages and reports. Note
that you see syslog messages for whitelisted addresses even if the address is not also in the dynamic
blacklist.
When you add a domain name to the static database, the ASA waits 1 minute, and then sends a DNS
request for that domain name and adds the domain name/IP address pairing to the DNS host cache. (This
action is a background process, and does not affect your ability to continue configuring the ASA). We
recommend also enabling DNS packet inspection with Botnet Traffic Filter snooping. The ASA uses
Botnet Traffic Filter snooping instead of the regular DNS lookup to resolve static blacklist domain names
in the following circumstances:
The ASA DNS server is unavailable.
A connection is initiated during the 1 minute waiting period before the ASA sends the regular DNS
request.
If DNS snooping is used, when an infected host sends a DNS request for a name on the static database,
the ASA looks inside the DNS packets for the domain name and associated IP address and adds the name
and IP address to the DNS reverse lookup cache.
If you do not enable Botnet Traffic Filter snooping, and one of the above circumstances occurs, then that
traffic will not be monitored by the Botnet Traffic Filter.
Information About the DNS Reverse Lookup Cache and DNS Host Cache
When you use the dynamic database with DNS snooping, entries are added to the DNS reverse lookup
cache. If you use the static database, entries are added to the DNS host cache (see the Information
About the Static Database section on page 55-3 about using the static database with DNS snooping and
the DNS reverse lookup cache).
Entries in the DNS reverse lookup cache and the DNS host cache have a time to live (TTL) value
provided by the DNS server. The largest TTL value allowed is 1 day (24 hours); if the DNS server
provides a larger TTL, it is truncated to 1 day maximum.
For the DNS reverse lookup cache, after an entry times out, the ASA renews the entry when an infected
host initiates a connection to a known address, and DNS snooping occurs.
For the DNS host cache, after an entry times out, the ASA periodically requests a refresh for the entry.
For the DNS host cache, the maximum number of blacklist entries and whitelist entries is 1000 each.
Table 55-1 lists the maximum number of entries in the DNS reverse lookup cache per model.
Table 55-1 DNS Reverse Lookup Cache Entries per Model
ASA Model Maximum Entries
ASA 5505 5000
ASA 5510 10,000
ASA 5520 20,000
ASA 5540 40,000
ASA 5550 40,000
ASA 5580 100,000
55-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Information About the Botnet Traffic Filter
How the Botnet Traffic Filter Works
Figure 55-1 shows how the Botnet Traffic Filter works with the dynamic database plus DNS inspection
with Botnet Traffic Filter snooping.
Figure 55-1 How the Botnet Traffic Filter Works with the Dynamic Database
Figure 55-2 shows how the Botnet Traffic Filter works with the static database.
Figure 55-2 How the Botnet Traffic Filter Works with the Static Database
Security Appliance
DNS
Reverse
Lookup Cache
Infected
Host
Malware Home Site
209.165.201.3 Syslog Server
Dynamic
Database
DNS Server
DNS Snoop
1
DNS Request:
bad.example.com
3
Connection to:
209.165.201.3
2
DNS Reply:
209.165.201.3
Internet
Botnet Traffic
Filter
3b. Send
Syslog Message/Drop Traffic
1a. Match?
3a. Match?
2a. Add
2
4
8
6
3
1
Security Appliance
DNS
Host Cache
Infected
Host
Malware Home Site
209.165.201.3 Syslog Server
Static
Database
DNS Server
Botnet Traffic
Filter
3
Connection to:
209.165.201.3
1a. DNS Request:
bad.example.com
Internet
3b. Send
Syslog Message/Drop Traffic
2a. Add
1
Add entry:
bad.example.com
2
DNS Reply:
209.165.201.3
3a. Match?
2
4
8
6
3
2
55-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Licensing Requirements for the Botnet Traffic Filter
Licensing Requirements for the Botnet Traffic Filter
The following table shows the licensing requirements for this feature:
Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
Supported in single and multiple context mode.
Firewall Mode Guidelines
Supported in routed and transparent firewall mode.
Failover Guidelines
Does not support replication of the DNS reverse lookup cache, DNS host cache, or the dynamic database
in Stateful Failover.
IPv6 Guidelines
Does not support IPv6.
Additional Guidelines and Limitations
TCP DNS traffic is not supported.
You can add up to 1000 blacklist entries and 1000 whitelist entries in the static database.
Default Settings
By default, the Botnet Traffic Filter is disabled, as is use of the dynamic database.
For DNS inspection, which is enabled by default, Botnet Traffic Filter snooping is disabled by default.
Configuring the Botnet Traffic Filter
This section includes the following topics:
Task Flow for Configuring the Botnet Traffic Filter, page 55-7
Configuring the Dynamic Database, page 55-7
Model License Requirement
All models You need the following licenses:
Botnet Traffic Filter License.
Strong Encryption (3DES/AES) License to download the dynamic database.
55-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter
Enabling DNS Snooping, page 55-10
Adding Entries to the Static Database, page 55-9
Enabling Traffic Classification and Actions for the Botnet Traffic Filter, page 55-12
Blocking Botnet Traffic Manually, page 55-15
Searching the Dynamic Database, page 55-16
Task Flow for Configuring the Botnet Traffic Filter
To configure the Botnet Traffic Filter, perform the following steps:
Step 1 Enable use of the dynamic database. See the Configuring the Dynamic Database section on page 55-7.
This procedure enables database updates from the Cisco update server, and also enables use of the
downloaded dynamic database by the ASA. Disallowing use of the downloaded database is useful in
multiple context mode so you can configure use of the database on a per-context basis.
Step 2 (Optional) Add static entries to the database. See the Adding Entries to the Static Database section on
page 55-9.
This procedure lets you augment the dynamic database with domain names or IP addresses that you want
to blacklist or whitelist. You might want to use the static database instead of the dynamic database if you
do not want to download the dynamic database over the Internet.
Step 3 Enable DNS snooping. See the Enabling DNS Snooping section on page 55-10.
This procedure enables inspection of DNS packets, compares the domain name with those in the
dynamic database or the static database (when a DNS server for the ASA is unavailable), and adds the
name and IP address to the DNS reverse lookup cache. This cache is then used by the Botnet Traffic
Filter when connections are made to the suspicious address.
Step 4 Enable traffic classification and actions for the Botnet Traffic Filter. See the Enabling Traffic
Classification and Actions for the Botnet Traffic Filter section on page 55-12.
This procedure enables the Botnet Traffic Filter, which compares the source and destination IP address
in each initial connection packet to the IP addresses in the dynamic database, static database, DNS
reverse lookup cache, and DNS host cache, and sends a syslog message or drops any matching traffic.
Step 5 (Optional) Block traffic manually based on syslog message information. See the Blocking Botnet
Traffic Manually section on page 55-15.
If you choose not to block malware traffic automatically, you can block traffic manually by configuring
an access list to deny traffic, or by using the shun command to block all traffic to and from a host.
Configuring the Dynamic Database
This procedure enables database updates, and also enables use of the downloaded dynamic database by
the ASA. Disabling use of the downloaded database is useful in multiple context mode so you can
configure use of the database on a per-context basis.
By default, downloading and using the dynamic database is disabled.
55-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter
Prerequisites
Enable ASA use of a DNS server according to the Configuring the DNS Server section on page 10-11.
Detailed Steps
Examples
The following multiple mode example enables downloading of the dynamic database, and enables use
of the database in context1 and context2:
hostname(config)# dynamic-filter updater-client enable
hostname(config)# changeto context context1
hostname/context1(config)# dynamic-filter use-database
hostname/context1(config)# changeto context context2
hostname/context2(config)# dynamic-filter use-database
The following single mode example enables downloading of the dynamic database, and enables use of
the database:
hostname(config)# dynamic-filter updater-client enable
hostname(config)# dynamic-filter use-database
What to Do Next
See the Adding Entries to the Static Database section on page 55-9.
Command Purpose
Step 1 dynamic-filter updater-client enable
Example:
hostname(config)# dynamic-filter
updater-client enable
Enables downloading of the dynamic database from the Cisco
update server. In multiple context mode, enter this command in
the system execution space. If you do not have a database already
installed on the ASA, it downloads the database after
approximately 2 minutes. The update server determines how often
the ASA polls the server for future updates, typically every hour.
Step 2 (Multiple context mode only)
changeto context context_name
Example:
hostname# changeto context admin
hostname/admin#
Changes to the context so that you can configure use of the
database on a per-context basis.
Step 3 dynamic-filter use-database
Example:
hostname(config)# dynamic-filter
use-database
Enables use of the dynamic database. In multiple context mode,
enter this command in the context execution space.
55-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter
Adding Entries to the Static Database
The static database lets you augment the dynamic database with domain names or IP addresses that you
want to blacklist or whitelist. Static blacklist entries are always designated with a Very High threat level.
See the Information About the Static Database section on page 55-3 for more information.
Prerequisites
In multiple context mode, perform this procedure in the context execution space.
Enable ASA use of a DNS server according to the Configuring the DNS Server section on
page 10-11.
Detailed Steps
Command Purpose
Step 1 dynamic-filter blacklist
Example:
hostname(config)# dynamic-filter blacklist
Edits the Botnet Traffic Filter blacklist.
Step 2 Enter one or both of the following:
name domain_name
Example:
hostname(config-llist)# name bad.example.com
Adds a name to the blacklist. You can enter this
command multiple times for multiple entries. You can
add up to 1000 blacklist entries.
address ip_address mask
Example:
hostname(config-llist)# address 10.1.1.1
255.255.255.255
Adds an IP address to the blacklist. You can enter this
command multiple times for multiple entries. The
mask can be for a single host or for a subnet.
Step 3 dynamic-filter whitelist
Example:
hostname(config)# dynamic-filter whitelist
Edits the Botnet Traffic Filter whitelist.
Step 4 Enter one or both of the following:
55-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter
Examples
The following example creates entries for the blacklist and whitelist:
hostname(config)# dynamic-filter blacklist
hostname(config-llist)# name bad1.example.com
hostname(config-llist)# name bad2.example.com
hostname(config-llist)# address 10.1.1.1 255.255.255.0
hostname(config-llist)# dynamic-filter whitelist
hostname(config-llist)# name good.example.com
hostname(config-llist)# name great.example.com
hostname(config-llist)# name awesome.example.com
hostname(config-llist)# address 10.1.1.2 255.255.255.255
What to Do Next
See the Enabling DNS Snooping section on page 55-10.
Enabling DNS Snooping
This procedure enables inspection of DNS packets and enables Botnet Traffic Filter snooping, which
compares the domain name with those on the dynamic database or static database, and adds the name
and IP address to the Botnet Traffic Filter DNS reverse lookup cache. This cache is then used by the
Botnet Traffic Filter when connections are made to the suspicious address.
The following procedure creates an interface-specific service policy for DNS inspection. See the DNS
Inspection section on page 43-1 and Chapter 32, Configuring a Service Policy Using the Modular
Policy Framework, for detailed information about configuring advanced DNS inspection options using
the Modular Policy Framework.
Prerequisites
In multiple context mode, perform this procedure in the context execution space.
Restrictions
TCP DNS traffic is not supported.
name domain_name
Example:
hostname(config-llist)# name good.example.com
Adds a name to the whitelist. You can enter this
command multiple times for multiple entries. You can
add up to 1000 whitelist entries.
address ip_address mask
Example:
hostname(config-llist)# address 10.1.1.2
255.255.255.255
Adds an IP address to the whitelist. You can enter this
command multiple times for multiple entries. The
mask can be for a single host or for a subnet.
Command Purpose
55-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter
Default DNS Inspection Configuration and Recommended Configuration
The default configuration for DNS inspection inspects all UDP DNS traffic on all interfaces, and does
not have DNS snooping enabled.
We suggest that you enable DNS snooping only on interfaces where external DNS requests are going.
Enabling DNS snooping on all UDP DNS traffic, including that going to an internal DNS server, creates
unnecessary load on the ASA.
For example, if the DNS server is on the outside interface, you should enable DNS inspection with
snooping for all UDP DNS traffic on the outside interface. See the Examples section for the
recommended commands for this configuration.
Detailed Steps
Command Purpose
Step 1 class-map name
Example:
hostname(config)# class-map
dynamic-filter_snoop_class
Creates a class map to identify the traffic for which you want to
inspect DNS.
Step 2 match parameters
Example:
hostname(config-cmap)# match port udp eq
domain
Specifies traffic for the class map. See the Identifying Traffic
(Layer 3/4 Class Maps) section on page 32-12 for more
information about available parameters. For example, you can
specify an access list for DNS traffic to and from certain
addresses, or you can specify all UDP DNS traffic.
Step 3 policy-map name
Example:
hostname(config)# policy-map
dynamic-filter_snoop_policy
Adds or edits a policy map so you can set the actions to take with
the class map traffic.
Step 4 class name
Example:
hostname(config-pmap)# class
dynamic-filter_snoop_class
Identifies the class map you created in Step 1.
55-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter
Examples
The following recommended configuration creates a class map for all UDP DNS traffic, enables DNS
inspection and Botnet Traffic Filter snooping with the default DNS inspection policy map, and applies
it to the outside interface:
hostname(config)# class-map dynamic-filter_snoop_class
hostname(config-cmap)# match port udp eq domain
hostname(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname(config-pmap)# class dynamic-filter_snoop_class
hostname(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface outside
What to Do Next
See the Enabling Traffic Classification and Actions for the Botnet Traffic Filter section on page 55-12.
Enabling Traffic Classification and Actions for the Botnet Traffic Filter
This procedure enables the Botnet Traffic Filter. The Botnet Traffic Filter compares the source and
destination IP address in each initial connection packet to the following:
Dynamic database IP addresses
Static database IP addresses
DNS reverse lookup cache (for dynamic database domain names)
DNS host cache (for static database domain names)
When an address matches, the ASA sends a syslog message. The only additional action currently
available is to drop the connection.
Prerequisites
In multiple context mode, perform this procedure in the context execution space.
Step 5 inspect dns [map_name]
dynamic-filter-snoop
Example:
hostname(config-pmap-c)# inspect dns
preset_dns_map dynamic-filter-snoop
Enables DNS inspection with Botnet Traffic Filter snooping. To
use the default DNS inspection policy map for the map_name,
specify preset_dns_map for the map name. See the DNS
Inspection section on page 43-1 for more information about
creating a DNS inspection policy map.
Step 6 service-policy policymap_name interface
interface_name
Example:
hostname(config)# service-policy
dynamic-filter_snoop_policy interface
outside
Activates the policy map on an interface. The interface-specific
policy overrides the global policy. You can only apply one policy
map to each interface.
Command Purpose
55-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter
Recommended Configuration
Although DNS snooping is not required, we recommend configuring DNS snooping for maximum use
of the Botnet Traffic Filter (see the Enabling DNS Snooping section on page 55-10). Without DNS
snooping for the dynamic database, the Botnet Traffic Filter uses only the static database entries, plus
any IP addresses in the dynamic database; domain names in the dynamic database are not used.
We recommend enabling the Botnet Traffic Filter on all traffic on the Internet-facing interface, and
enabling dropping of traffic with a severity of moderate and higher. See the Examples section for the
recommended commands used for this configuration.
Detailed Steps
Command Purpose
Step 1 (Optional)
access-list access_list_name extended
{deny | permit} protocol source_address
mask [operator port] dest_address mask
[operator port]
Example:
hostname(config)# access-list
dynamic-filter_acl extended permit tcp any
any eq 80
hostname(config)# access-list
dynamic-filter_acl_subset extended permit
tcp 10.1.1.0 255.255.255.0 any eq 80
Identifies the traffic that you want to monitor or drop. If you do
not create an access list for monitoring, by default you monitor all
traffic. You can optionally use an access list to identify a subset of
monitored traffic that you want to drop; be sure the access list is
a subset of the monitoring access list. See Chapter 15, Adding an
Extended Access List, for more information about creating an
access list.
Step 2 dynamic-filter enable [interface name]
[classify-list access_list]
Example:
hostname(config)# dynamic-filter enable
interface outside classify-list
dynamic-filter_acl
Enables the Botnet Traffic Filter; without any options, this
command monitors all traffic.
We recommend enabling the Botnet Traffic Filter on all traffic on
the Internet-facing interface using the interface keyword.
You can optionally limit monitoring to specific traffic by using the
classify-list keyword with an access list.
You can enter this command one time for each interface and one
time for the global policy (where you do not specify the interface
keyword). Each interface and global command can have an
optional classify-list keyword. Any interface-specific commands
take precedence over the global command.
55-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter
Step 3 (Optional)
dynamic-filter drop blacklist [interface
name] [action-classify-list
subset_access_list] [threat-level {eq
level | range min max}]
Example:
hostname(config)# dynamic-filter drop
blacklist interface outside
action-classify-list
dynamic-filter_acl_subset threat-level
range moderate very-high
Automatically drops malware traffic. To manually drop traffic,
see the Blocking Botnet Traffic Manually section on
page 55-15.
Be sure to first configure a dynamic-filter enable command to
monitor any traffic you also want to drop.
You can set an interface policy using the interface keyword, or a
global policy (where you do not specify the interface keyword).
Any interface-specific commands take precedence over the global
command. You can enter this command multiple times for each
interface and global policy.
The action-classify-list keyword limits the traffic dropped to a
subset of monitored traffic. The dropped traffic must always be
equal to or a subset of the monitored traffic. For example, if you
specify an access list for the dynamic-filter enable command,
and you specify the action-classify-list for this command, then it
must be a subset of the dynamic-filter enable access list.
Make sure you do not specify overlapping traffic in multiple
commands for a given interface/global policy. Because you
cannot control the exact order that commands are matched,
overlapping traffic means you do not know which command will
be matched. For example, do not specify both a command that
matches all traffic (without the action-classify-list keyword) as
well as a command with the action-classify-list keyword for a
given interface. In this case, the traffic might never match the
command with the action-classify-list keyword. Similarly, if you
specify multiple commands with the action-classify-list
keyword, make sure each access list is unique, and that the
networks do not overlap.
You can additionally limit the traffic dropped by setting the threat
level. If you do not explicitly set a threat level, the level used is
threat-level range moderate very-high.
Note We highly recommend using the default setting unless you
have strong reasons for changing the setting.
The level and min and max options are:
very-low
low
moderate
high
very-high
Note Static blacklist entries are always designated with a Very
High threat level.
Command Purpose
55-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter
Examples
The following recommended configuration monitors all traffic on the outside interface and drops all
traffic at a threat level of moderate or higher:
hostname(config)# dynamic-filter enable interface outside
hostname(config)# dynamic-filter drop blacklist interface outside
If you decide not to monitor all traffic, you can limit the traffic using an access list. The following
example monitors only port 80 traffic on the outside interface, and drops traffic threat level very-high
only:
hostname(config)# access-list dynamic-filter_acl extended permit tcp any any eq 80
hostname(config)# dynamic-filter enable interface outside classify-list dynamic-filter_acl
hostname(config)# dynamic-filter drop blacklist interface outside threat-level eq
very-high
Blocking Botnet Traffic Manually
If you choose not to block malware traffic automatically (see the Enabling Traffic Classification and
Actions for the Botnet Traffic Filter section on page 55-12), you can block traffic manually by
configuring an access list to deny traffic, or by using the shun command tool to block all traffic to and
from a host.
For example, you receive the following syslog message:
ASA-4-338002: Dynamic Filter permitted black listed TCP traffic from inside:10.1.1.45/6798
(209.165.201.1/7890) to outside:209.165.202.129/80 (209.165.202.129/80), destination
209.165.202.129 resolved from dynamic list: bad.example.com
You can then perform one of the following actions:
Create an access list to deny traffic.
For example, using the syslog message above, you might want to deny traffic from the infected host
at 10.1.1.45 to the malware site at 209.165.202.129. Or, if there are many connections to different
blacklisted addresses, you can create an access list to deny all traffic from 10.1.1.45 until you
resolve the infection on the host computer. For example, the following commands deny all traffic
from 10.1.1.5 to 209.165.202.129, but permits all other traffic on the inside interface:
hostname(config)# access-list BLOCK_OUT extended deny ip host 10.1.1.45 host
209.165.202.129
hostname(config)# access-list BLOCK_OUT extended permit ip any any
hostname(config)# access-group BLOCK_OUT in interface inside
Step 4 (Optional)
dynamic-filter ambiguous-is-black
Example:
hostname(config)# dynamic-filter
ambiguous-is-black
If you configured the dynamic-filter drop blacklist command,
then this command treats greylisted traffic as blacklisted traffic
for dropping purposes. If you do not enable this command,
greylisted traffic will not be dropped. See the Botnet Traffic
Filter Address Types section on page 55-2 for more information
about the greylist.
Command Purpose
55-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuring the Botnet Traffic Filter
See Chapter 15, Adding an Extended Access List, for more information about creating an access
list, and see Chapter 34, Configuring Access Rules, for information about applying the access list
to the interface.
Note Access lists block all future connections. To block the current connection, if it is still active,
enter the clear conn command. For example, to clear only the connection listed in the syslog
message, enter the clear conn address 10.1.1.45 address 209.165.202.129 command. See
the command reference for more information.
Shun the infected host.
Shunning blocks all connections from the host, so you should use an access list if you want to block
connections to certain destination addresses and ports. To shun a host, enter the following command.
To drop the current connection as well as blocking all future connections, enter the destination
address, source port, destination port, and optional protocol.
hostname(config)# shun src_ip [dst_ip src_port dest_port [protocol]]
For example, to block future connections from 10.1.1.45, and also drop the current connection to the
malware site in the syslog message, enter:
hostname(config)# shun 10.1.1.45 209.165.202.129 6798 80
See Blocking Unwanted Connections section on page 57-2 for more information about shunning.
After you resolve the infection, be sure to remove the access list or the shun. To remove the shun, enter
no shun src_ip.
Searching the Dynamic Database
If you want to check if a domain name or IP address is included in the dynamic database, you can search
the database for a string.
Detailed Steps
Examples
The following example searches on the string example.com, and finds 1 match:
hostname# dynamic-filter database find bad.example.com
bad.example.com
Found 1 matches
The following example searches on the string bad, and finds more than 2 matches:
Command Purpose
dynamic-filter database find string
Example:
hostname# dynamic-filter database find
Searches the dynamic database for a domain name or IP address. The
string can be the complete domain name or IP address, or you can enter
part of the name or address, with a minimum search string of 3 characters.
If there are multiple matches, the first two matches are shown. To refine
your search for a more specific match, enter a longer string.
Note Regular expressions are not supported for the database search.
55-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Monitoring the Botnet Traffic Filter
hostname# dynamic-filter database find bad
bad.example.com
bad.example.net
Found more than 2 matches, enter a more specific string to find an exact
match
Monitoring the Botnet Traffic Filter
Whenever a known address is classified by the Botnet Traffic Filter, then a syslog message is generated.
You can also monitor Botnet Traffic Filter statistics and other parameters by entering commands on the
ASA. This section includes the following topics:
Botnet Traffic Filter Syslog Messaging, page 55-17
Botnet Traffic Filter Commands, page 55-17
Botnet Traffic Filter Syslog Messaging
The Botnet Traffic Filter generates detailed syslog messages numbered 338nnn. Messages differentiate
between incoming and outgoing connections, blacklist, whitelist, or greylist addresses, and many other
variables. (The greylist includes addresses that are associated with multiple domain names, but not all
of these domain names are on the blacklist.)
See the syslog message guide for detailed information about syslog messages.
Botnet Traffic Filter Commands
To monitor the Botnet Traffic Filter, enter one of the following commands:
Command Purpose
show dynamic-filter statistics [interface
name] [detail]
Shows how many connections were classified as whitelist, blacklist, and
greylist connections, and how many connections were dropped. (The
greylist includes addresses that are associated with multiple domain
names, but not all of these domain names are on the blacklist.) The detail
keyword shows how many packets at each threat level were classified or
dropped.
To clear the statistics, enter the clear dynamic-filter statistics [interface
name] command.
show dynamic-filter reports top
[malware-sites | malware-ports |
infected-hosts]
Generates reports of the top 10 malware sites, ports, and infected hosts
monitored. The top 10 malware-sites report includes the number of
connections dropped, and the threat level and category of each site. This
report is a snapshot of the data, and may not match the top 10 items since
the statistics started to be collected.
To clear the report data, enter the clear dynamic-filter reports top
command.
55-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Monitoring the Botnet Traffic Filter
Examples
The following is sample output from the show dynamic-filter statistics command:
hostname# show dynamic-filter statistics
Enabled on interface outside
Total conns classified 11, ingress 11, egress 0
Total whitelist classified 0, ingress 0, egress 0
Total greylist classified 0, dropped 0, ingress 0, egress 0
Total blacklist classified 11, dropped 5, ingress 11, egress 0
Enabled on interface inside
Total conns classified 1182, ingress 1182, egress 0
Total whitelist classified 3, ingress 3, egress 0
Total greylist classified 0, dropped 0, ingress 0, egress 0
Total blacklist classified 1179, dropped 1000, ingress 1179, egress 0
The following is sample output from the show dynamic-filter reports top malware-sites command:
hostname# show dynamic-filter reports top malware-sites
Site Connections logged dropped Threat Level Category
--------------------------------------------------------------------------------------
bad1.example.com (10.67.22.34) 11 0 2 Botnet
bad2.example.com (209.165.200.225) 8 8 3 Virus
bad1.cisco.example(10.131.36.158) 6 6 3 Virus
bad2.cisco.example(209.165.201.1) 2 2 3 Trojan
show dynamic-filter reports infected-hosts
{max-connections | latest-active |
highest-threat | subnet ip_address netmask
| all}
Generates reports about infected hosts. These reports contain detailed
history about infected hosts, showing the correlation between infected
hosts, visited malware sites, and malware ports. The max-connections
keyword shows the 20 infected hosts with the most number of
connections. The latest-active keyword shows the 20 hosts with the most
recent activity. The highest-threat keyword shows the 20 hosts that
connected to the malware sites with the highest threat level. The subnet
keyword shows up to 20 hosts within the specified subnet. The all
keyword shows all buffered infected-hosts information. This display
might include thousands of entries. You might want to use ASDM to
generate a PDF file instead of using the CLI.
To clear the report data, enter the clear dynamic-filter reports
infected-hosts command.
show dynamic-filter updater-client
Shows information about the updater server, including the server IP
address, the next time the ASA will connect with the server, and the
database version last installed.
show dynamic-filter dns-snoop [detail]
Shows the Botnet Traffic Filter DNS snooping summary, or with the
detail keyword, the actual IP addresses and names. All inspected DNS
data is included in this output, and not just matching names in the
blacklist. DNS data from static entries are not included.
To clear the DNS snooping data, enter the clear dynamic-filter
dns-snoop command.
show dynamic-filter data
Shows information about the dynamic database, including when the
dynamic database was last downloaded, the version of the database, how
many entries the database contains, and 10 sample entries.
show asp table dynamic-filter [hits]
Shows the Botnet Traffic Filter rules that are installed in the accelerated
security path.
Command Purpose
55-19
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuration Examples for the Botnet Traffic Filter
horrible.example.net(10.232.224.2) 2 2 3 Botnet
nono.example.org(209.165.202.130) 1 1 3 Virus
Last clearing of the top sites report: at 13:41:06 UTC Jul 15 2009
The following is sample output from the show dynamic-filter reports top malware-ports command:
hostname# show dynamic-filter reports top malware-ports
Port Connections logged
----------------------------------------------------------------------
tcp 1000 617
tcp 2001 472
tcp 23 22
tcp 1001 19
udp 2000 17
udp 2001 17
tcp 8080 9
tcp 80 3
tcp >8192 2
Last clearing of the top sites report: at 13:41:06 UTC Jul 15 2009
The following is sample output from the show dynamic-filter reports top infected-hosts command:
hostname# show dynamic-filter reports top infected-hosts
Host Connections logged
----------------------------------------------------------------------
10.10.10.51(inside) 1190
10.12.10.10(inside) 10
10.10.11.10(inside) 5
Last clearing of the top infected-hosts report: at 13:41:06 UTC Jul 15 2009
Configuration Examples for the Botnet Traffic Filter
This section includes the recommended configuration for single and multiple context mode, as well as
other possible configurations. This section includes the following topics:
Recommended Configuration Example, page 55-19
Other Configuration Examples, page 55-20
Recommended Configuration Example
The following recommended example configuration for single context mode enables downloading of the
dynamic database, and enables use of the database. It creates a class map for all UDP DNS traffic,
enables DNS inspection and Botnet Traffic Filter snooping with the default DNS inspection policy map,
and applies it to the outside interface, the Internet-facing interface.
Example 55-1 Single Mode Botnet Traffic Filter Recommended Example
hostname(config)# dynamic-filter updater-client enable
hostname(config)# dynamic-filter use-database
hostname(config)# class-map dynamic-filter_snoop_class
hostname(config-cmap)# match port udp eq domain
hostname(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname(config-pmap)# class dynamic-filter_snoop_class
55-20
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Configuration Examples for the Botnet Traffic Filter
hostname(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface outside
hostname(config)# dynamic-filter enable interface outside
hostname(config)# dynamic-filter drop blacklist interface outside
The following recommended example configuration for multiple context mode enables the Botnet
Traffic Filter for two contexts:
Example 55-2 Multiple Mode Botnet Traffic Filter Recommended Example
hostname(config)# dynamic-filter updater-client enable
hostname(config)# changeto context context1
hostname/context1(config)# dynamic-filter use-database
hostname/context1(config)# class-map dynamic-filter_snoop_class
hostname/context1(config-cmap)# match port udp eq domain
hostname/context1(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname/context1(config-pmap)# class dynamic-filter_snoop_class
hostname/context1(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname/context1(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface
outside
hostname/context1(config)# dynamic-filter enable interface outside
hostname/context1(config)# dynamic-filter drop blacklist interface outside
hostname/context1(config)# changeto context context2
hostname/context2(config)# dynamic-filter use-database
hostname/context2(config)# class-map dynamic-filter_snoop_class
hostname/context2(config-cmap)# match port udp eq domain
hostname/context2(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname/context2(config-pmap)# class dynamic-filter_snoop_class
hostname/context2(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname/context2(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface
outside
hostname/context2(config)# dynamic-filter enable interface outside
hostname/context2(config)# dynamic-filter drop blacklist interface outside
Other Configuration Examples
The following sample configuration adds static entries are to the blacklist and to the whitelist. Then, it
monitors all port 80 traffic on the outside interface, and drops blacklisted traffic. It also treats greylist
addresses as blacklisted addresses.
hostname(config)# dynamic-filter updater-client enable
hostname(config)# changeto context context1
hostname/context1(config)# dynamic-filter use-database
hostname/context1(config)# class-map dynamic-filter_snoop_class
hostname/context1(config-cmap)# match port udp eq domain
hostname/context1(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname/context1(config-pmap)# class dynamic-filter_snoop_class
hostname/context1(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname/context1(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface
outside
hostname/context1(config-pmap-c)# dynamic-filter blacklist
hostname/context1(config-llist)# name bad1.example.com
hostname/context1(config-llist)# name bad2.example.com
55-21
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Where to Go Next
hostname/context1(config-llist)# address 10.1.1.1 255.255.255.0
hostname/context1(config-llist)# dynamic-filter whitelist
hostname/context1(config-llist)# name good.example.com
hostname/context1(config-llist)# name great.example.com
hostname/context1(config-llist)# name awesome.example.com
hostname/context1(config-llist)# address 10.1.1.2 255.255.255.255
hostname/context1(config-llist)# access-list dynamic-filter_acl extended permit tcp any
any eq 80
hostname/context1(config)# dynamic-filter enable interface outside classify-list
dynamic-filter_acl
hostname/context1(config)# dynamic-filter drop blacklist interface outside
hostname/context1(config)# dynamic-filter ambiguous-is-black
hostname/context1(config)# changeto context context2
hostname/context2(config)# dynamic-filter use-database
hostname/context2(config)# class-map dynamic-filter_snoop_class
hostname/context2(config-cmap)# match port udp eq domain
hostname/context2(config-cmap)# policy-map dynamic-filter_snoop_policy
hostname/context2(config-pmap)# class dynamic-filter_snoop_class
hostname/context2(config-pmap-c)# inspect dns preset_dns_map dynamic-filter-snoop
hostname/context2(config-pmap-c)# service-policy dynamic-filter_snoop_policy interface
outside
hostname/context2(config-pmap-c)# dynamic-filter blacklist
hostname/context2(config-llist)# name bad1.example.com
hostname/context2(config-llist)# name bad2.example.com
hostname/context2(config-llist)# address 10.1.1.1 255.255.255.0
hostname/context2(config-llist)# dynamic-filter whitelist
hostname/context2(config-llist)# name good.example.com
hostname/context2(config-llist)# name great.example.com
hostname/context2(config-llist)# name awesome.example.com
hostname/context2(config-llist)# address 10.1.1.2 255.255.255.255
hostname/context2(config-llist)# access-list dynamic-filter_acl extended permit tcp any
any eq 80
hostname/context2(config)# dynamic-filter enable interface outside classify-list
dynamic-filter_acl
hostname/context2(config)# dynamic-filter drop blacklist interface outside
hostname/context2(config)# dynamic-filter ambiguous-is-black
Where to Go Next
To configure the syslog server, see Chapter 77, Configuring Logging.
To configure an access list to block traffic, see Chapter 15, Adding an Extended Access List, and
also see Chapter 34, Configuring Access Rules, for information about applying the access list to
the interface.
To shun connections, see the Blocking Unwanted Connections section on page 57-2.
55-22
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 55 Configuring the Botnet Traffic Filter
Feature History for the Botnet Traffic Filter
Feature History for the Botnet Traffic Filter
Table 55-2 lists each feature change and the platform release in which it was implemented.
Table 55-2 Feature History for the Botnet Traffic Filter
Feature Name
Platform
Releases Feature Information
Botnet Traffic Filter 8.2(1) This feature was introduced.
Automatic blocking, and blacklist category and
threat level reporting.
8.2(2) The Botnet Traffic Filter now supports automatic blocking
of blacklisted traffic based on the threat level. You can also
view the category and threat level of malware sites in
statistics and reports.
The 1 hour timeout for reports for top hosts was removed;
there is now no timeout.
The following commands were introduced or modified:
dynamic-filter ambiguous-is-black, dynamic-filter drop
blacklist, show dynamic-filter statistics, show
dynamic-filter reports infected-hosts, and show
dynamic-filter reports top.
C H A P T E R
56-1
Cisco ASA 5500 Series Configuration Guide using the CLI
56
Configuring Threat Detection
This chapter describes how to configure threat detection statistics and scanning threat detection and
includes the following sections:
Information About Threat Detection, page 56-1
Licensing Requirements for Threat Detection, page 56-1
Configuring Basic Threat Detection Statistics, page 56-2
Configuring Advanced Threat Detection Statistics, page 56-6
Configuring Scanning Threat Detection, page 56-15
Configuration Examples for Threat Detection, page 56-19
Information About Threat Detection
The threat detection feature consists of the following elements:
Different levels of statistics gathering for various threats.
Threat detection statistics can help you manage threats to your ASA; for example, if you enable
scanning threat detection, then viewing statistics can help you analyze the threat. You can configure
two types of threat detection statistics:
Basic threat detection statisticsIncludes information about attack activity for the system as a
whole. Basic threat detection statistics are enabled by default and have no performance impact.
Advanced threat detection statisticsTracks activity at an object level, so the ASA can report
activity for individual hosts, ports, protocols, or access lists. Advanced threat detection statistics
can have a major performance impact, depending on the statistics gathered, so only the access
list statistics are enabled by default.
Scanning threat detection, which determines when a host is performing a scan.
You can optionally shun any hosts determined to be a scanning threat.
Licensing Requirements for Threat Detection
The following table shows the licensing requirements for this feature:
56-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Basic Threat Detection Statistics
Configuring Basic Threat Detection Statistics
Basic threat detection statistics include activity that might be related to an attack, such as a DoS attack.
This section includes the following topics:
Information About Basic Threat Detection Statistics, page 56-2
Guidelines and Limitations, page 56-3
Default Settings, page 56-3
Configuring Basic Threat Detection Statistics, page 56-4
Monitoring Basic Threat Detection Statistics, page 56-5
Feature History for Basic Threat Detection Statistics, page 56-6
Information About Basic Threat Detection Statistics
Using basic threat detection statistics, the ASA monitors the rate of dropped packets and security events
due to the following reasons:
Denial by access lists
Bad packet format (such as invalid-ip-header or invalid-tcp-hdr-length)
Connection limits exceeded (both system-wide resource limits, and limits set in the configuration)
DoS attack detected (such as an invalid SPI, Stateful Firewall check failure)
Basic firewall checks failed (This option is a combined rate that includes all firewall-related packet
drops in this bulleted list. It does not include non-firewall-related drops such as interface overload,
packets failed at application inspection, and scanning attack detected.)
Suspicious ICMP packets detected
Packets failed application inspection
Interface overload
Scanning attack detected (This option monitors scanning attacks; for example, the first TCP packet
is not a SYN packet, or the TCP connection failed the 3-way handshake. Full scanning threat
detection (see the Configuring Scanning Threat Detection section on page 56-15) takes this
scanning attack rate information and acts on it by classifying hosts as attackers and automatically
shunning them, for example.)
Incomplete session detection such as TCP SYN attack detected or no data UDP session attack
detected
When the ASA detects a threat, it immediately sends a system log message (733100). The ASA tracks
two types of rates: the average event rate over an interval, and the burst event rate over a shorter burst
interval. The burst rate interval is 1/30th of the average rate interval or 10 seconds, whichever is higher.
Model License Requirement
All models Base License.
56-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Basic Threat Detection Statistics
For each received event, the ASA checks the average and burst rate limits; if both rates are exceeded,
then the ASA sends two separate system messages, with a maximum of one message for each rate type
per burst period.
Basic threat detection affects performance only when there are drops or potential threats; even in this
scenario, the performance impact is insignificant.
Guidelines and Limitations
This section includes the guidelines and limitations for this feature:
Security Context Guidelines
Supported in single mode only. Multiple mode is not supported.
Firewall Mode Guidelines
Supported in routed and transparent firewall mode.
Types of Traffic Monitored
Only through-the-box traffic is monitored; to-the-box traffic is not included in threat detection.
Default Settings
Basic threat detection statistics are enabled by default.
Table 56-1 lists the default settings. You can view all these default settings using the show
running-config all threat-detection command.
Table 56-1 Basic Threat Detection Default Settings
Packet Drop Reason
Trigger Settings
Average Rate Burst Rate
DoS attack detected
Bad packet format
Connection limits exceeded
Suspicious ICMP packets
detected
100 drops/sec over the last 600
seconds.
400 drops/sec over the last 20
second period.
80 drops/sec over the last 3600
seconds.
320 drops/sec over the last 120
second period.
Scanning attack detected 5 drops/sec over the last 600
seconds.
10 drops/sec over the last 20
second period.
4 drops/sec over the last 3600
seconds.
8 drops/sec over the last 120
second period.
Incomplete session detected such as
TCP SYN attack detected or no data
UDP session attack detected
(combined)
100 drops/sec over the last 600
seconds.
200 drops/sec over the last 20
second period.
80 drops/sec over the last 3600
seconds.
160 drops/sec over the last 120
second period.
56-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Basic Threat Detection Statistics
Configuring Basic Threat Detection Statistics
This section describes how to configure basic threat detection statistics, including enabling or disabling
it and changing the default limits.
Detailed Steps
Denial by access lists 400 drops/sec over the last 600
seconds.
800 drops/sec over the last 20
second period.
320 drops/sec over the last
3600 seconds.
640 drops/sec over the last 120
second period.
Basic firewall checks failed
Packets failed application
inspection
400 drops/sec over the last 600
seconds.
1600 drops/sec over the last 20
second period.
320 drops/sec over the last
3600 seconds.
1280 drops/sec over the last 120
second period.
Interface overload 2000 drops/sec over the last
600 seconds.
8000 drops/sec over the last 20
second period.
1600 drops/sec over the last
3600 seconds.
6400 drops/sec over the last 120
second period.
Table 56-1 Basic Threat Detection Default Settings (continued)
Packet Drop Reason
Trigger Settings
Average Rate Burst Rate
Command Purpose
Step 1 threat-detection basic-threat
Example:
hostname(config)# threat-detection
basic-threat
Enables basic threat detection statistics (if you previously
disabled it). Basic threat detection is enabled by default.
Step 2 threat-detection rate {acl-drop |
bad-packet-drop | conn-limit-drop |
dos-drop | fw-drop | icmp-drop |
inspect-drop | interface-drop |
scanning-threat | syn-attack}
rate-interval rate_interval average-rate
av_rate burst-rate burst_rate
Example:
hostname(config)# threat-detection rate
dos-drop rate-interval 600 average-rate 60
burst-rate 100
(Optional) Changes the default settings for one or more type of
event.
For a description of each event type, see the Information About
Basic Threat Detection Statistics section on page 56-2.
When you use this command with the scanning-threat keyword,
it is also used in the scanning threat detection feature (see the
Configuring Scanning Threat Detection section). If you do not
configure basic threat detection, you can still use this command
with the scanning-threat keyword to configure the rate limits for
scanning threat detection.
You can configure up to three different rate intervals for each
event type.
56-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Basic Threat Detection Statistics
Monitoring Basic Threat Detection Statistics
To monitor basic threat detection statistics, perform one of the following tasks:
Examples
The following is sample output from the show threat-detection rate command:
hostname# show threat-detection rate
Average(eps) Current(eps) Trigger Total events
10-min ACL drop: 0 0 0 16
1-hour ACL drop: 0 0 0 112
1-hour SYN attck: 5 0 2 21438
10-min Scanning: 0 0 29 193
1-hour Scanning: 106 0 10 384776
1-hour Bad pkts: 76 0 2 274690
10-min Firewall: 0 0 3 22
1-hour Firewall: 76 0 2 274844
10-min DoS attck: 0 0 0 6
1-hour DoS attck: 0 0 0 42
10-min Interface: 0 0 0 204
1-hour Interface: 88 0 0 318225
Command Purpose
show threat-detection rate
[min-display-rate min_display_rate]
[acl-drop | bad-packet-drop |
conn-limit-drop | dos-drop | fw-drop |
icmp-drop | inspect-drop | interface-drop |
scanning-threat | syn-attack]
Displays basic threat detection statistics.
where the min-display-rate min_display_rate argument limits the
display to statistics that exceed the minimum display rate in events per
second. You can set the min_display_rate between 0 and 2147483647.
For a description of each event type, see the Information About Basic
Threat Detection Statistics section on page 56-2.
The output shows the average rate in events/sec over two fixed time
periods: the last 10 minutes and the last 1 hour. It also shows: the current
burst rate in events/sec over the last completed burst interval, which is
1/30th of the average rate interval or 10 seconds, whichever is larger; the
number of times the rates were exceeded (triggered); and the total number
of events over the time periods.
The ASA stores the count at the end of each burst period, for a total of 30
completed burst intervals. The unfinished burst interval presently
occurring is not included in the average rate. For example, if the average
rate interval is 20 minutes, then the burst interval is 20 seconds. If the last
burst interval was from 3:00:00 to 3:00:20, and you use the show
command at 3:00:25, then the last 5 seconds are not included in the
output.
The only exception to this rule is if the number of events in the unfinished
burst interval already exceeds the number of events in the oldest burst
interval (#1 of 30) when calculating the total events. In that case, the ASA
calculates the total events as the last 29 complete intervals, plus the events
so far in the unfinished burst interval. This exception lets you monitor a
large increase in events in real time.
clear threat-detection rate
Clears basic threat statistics.
56-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Advanced Threat Detection Statistics
Feature History for Basic Threat Detection Statistics
Table 56-2 lists each feature change and the platform release in which it was implemented.
Configuring Advanced Threat Detection Statistics
You can configure the ASA to collect extensive statistics. This section includes the following topics:
Information About Advanced Threat Detection Statistics, page 56-6
Guidelines and Limitations, page 56-6
Default Settings, page 56-7
Configuring Advanced Threat Detection Statistics, page 56-7
Monitoring Advanced Threat Detection Statistics, page 56-9
Feature History for Advanced Threat Detection Statistics, page 56-14
Information About Advanced Threat Detection Statistics
Advanced threat detection statistics show both allowed and dropped traffic rates for individual objects
such as hosts, ports, protocols, or access lists.
Caution Enabling advanced statistics can affect the ASA performance, depending on the type of statistics
enabled. The threat-detection statistics host command affects performance in a significant way; if you
have a high traffic load, you might consider enabling this type of statistics temporarily. The
threat-detection statistics port command, however, has modest impact.
Guidelines and Limitations
This section includes the guidelines and limitations for this feature:
Table 56-2 Feature History for Basic Threat Detection Statistics
Feature Name
Platform
Releases Feature Information
Basic threat detection statistics 8.0(2) Basic threat detection statistics was introduced.
The following commands were introduced:
threat-detection basic-threat, threat-detection rate,
show threat-detection rate, clear threat-detection rate.
Burst rate interval changed to 1/30th of the
average rate.
8.2(1) In earlier releases, the burst rate interval was 1/60th of the
average rate. To maximize memory usage, the sampling
interval was reduced to 30 times during the average rate.
Improved memory usage 8.3(1) The memory usage for threat detection was improved.
56-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Advanced Threat Detection Statistics
Security Context Guidelines
Only TCP Intercept statistics are available in multiple mode.
Firewall Mode Guidelines
Supported in routed and transparent firewall mode.
Types of Traffic Monitored
Only through-the-box traffic is monitored; to-the-box traffic is not included in threat detection.
Default Settings
By default, statistics for access lists are enabled.
Configuring Advanced Threat Detection Statistics
By default, statistics for access lists are enabled. To enable other statistics, perform the following steps.
Detailed Steps
Command Purpose
Step 1 threat-detection statistics
Example:
hostname(config)# threat-detection statistics
(Optional) Enables all statistics.
To enable only certain statistics, enter this command
for each statistic type (shown in this table), and do
not also enter the command without any options.
You can enter threat-detection statistics (without
any options) and then customize certain statistics by
entering the command with statistics-specific
options (for example, threat-detection statistics
host number-of-rate 2). If you enter
threat-detection statistics (without any options)
and then enter a command for specific statistics, but
without any statistic-specific options, then that
command has no effect because it is already enabled.
If you enter the no form of this command, it removes
all threat-detection statistics commands, including
the threat-detection statistics access-list
command, which is enabled by default.
Step 2 threat-detection statistics access-list
Example:
hostname(config)# threat-detection statistics
access-list
(Optional) Enables statistics for access lists (if they
were disabled previously). Statistics for access lists
are enabled by default. Access list statistics are only
displayed using the show threat-detection top
access-list command. This command is enabled by
default.
56-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Advanced Threat Detection Statistics
Step 3 threat-detection statistics host [number-of-rate {1 |
2 | 3}]
Example:
hostname(config)# threat-detection statistics host
number-of-rate 2
(Optional) Enables statistics for hosts.
The number-of-rate keyword sets the number of
rate intervals maintained for host statistics. The
default number of rate intervals is 1, which keeps the
memory usage low. To view more rate intervals, set
the value to 2 or 3. For example, if you set the value
to 3, then you view data for the last 1 hour, 8 hours,
and 24 hours. If you set this keyword to 1 (the
default), then only the shortest rate interval statistics
are maintained. If you set the value to 2, then the two
shortest intervals are maintained.
The host statistics accumulate for as long as the host
is active and in the scanning threat host database.
The host is deleted from the database (and the
statistics cleared) after 10 minutes of inactivity.
Step 4 threat-detection statistics port [number-of-rate {1 |
2 | 3}]
Example:
hostname(config)# threat-detection statistics port
number-of-rate 2
(Optional) Enables statistics for TCP and UDP
ports.
The number-of-rate keyword sets the number of
rate intervals maintained for port statistics. The
default number of rate intervals is 1, which keeps the
memory usage low. To view more rate intervals, set
the value to 2 or 3. For example, if you set the value
to 3, then you view data for the last 1 hour, 8 hours,
and 24 hours. If you set this keyword to 1 (the
default), then only the shortest rate interval statistics
are maintained. If you set the value to 2, then the two
shortest intervals are maintained.
Command Purpose
56-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Advanced Threat Detection Statistics
Monitoring Advanced Threat Detection Statistics
The display output shows the following:
The average rate in events/sec over fixed time periods.
The current burst rate in events/sec over the last completed burst interval, which is 1/30th of the
average rate interval or 10 seconds, whichever is larger
The number of times the rates were exceeded (for dropped traffic statistics only)
The total number of events over the fixed time periods.
Step 5 threat-detection statistics protocol [number-of-rate
{1 | 2 | 3}]
Example:
hostname(config)# threat-detection statistics
protocol number-of-rate 3
(Optional) Enables statistics for non-TCP/UDP IP
protocols.
The number-of-rate keyword sets the number of
rate intervals maintained for protocol statistics. The
default number of rate intervals is 1, which keeps the
memory usage low. To view more rate intervals, set
the value to 2 or 3. For example, if you set the value
to 3, then you view data for the last 1 hour, 8 hours,
and 24 hours. If you set this keyword to 1 (the
default), then only the shortest rate interval statistics
are maintained. If you set the value to 2, then the two
shortest intervals are maintained.
Step 6 threat-detection statistics tcp-intercept
[rate-interval minutes] [burst-rate attacks_per_sec]
[average-rate attacks_per_sec]
Example:
hostname(config)# threat-detection statistics
tcp-intercept rate-interval 60 burst-rate 800
average-rate 600
(Optional) Enables statistics for attacks intercepted
by TCP Intercept (see the Chapter 53, Configuring
Connection Settings, to enable TCP Intercept).
The rate-interval keyword sets the size of the
history monitoring window, between 1 and 1440
minutes. The default is 30 minutes. During this
interval, the ASA samples the number of attacks 30
times.
The burst-rate keyword sets the threshold for
syslog message generation, between 25 and
2147483647. The default is 400 per second. When
the burst rate is exceeded, syslog message 733104 is
generated.
The average-rate keyword sets the average rate
threshold for syslog message generation, between
25 and 2147483647. The default is 200 per second.
When the average rate is exceeded, syslog message
733105 is generated.
Note This command is available in multiple
context mode.
Command Purpose
56-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Advanced Threat Detection Statistics
The ASA stores the count at the end of each burst period, for a total of 30 completed burst intervals. The
unfinished burst interval presently occurring is not included in the average rate. For example, if the
average rate interval is 20 minutes, then the burst interval is 20 seconds. If the last burst interval was
from 3:00:00 to 3:00:20, and you use the show command at 3:00:25, then the last 5 seconds are not
included in the output.
The only exception to this rule is if the number of events in the unfinished burst interval already exceeds
the number of events in the oldest burst interval (#1 of 30) when calculating the total events. In that case,
the ASA calculates the total events as the last 29 complete intervals, plus the events so far in the
unfinished burst interval. This exception lets you monitor a large increase in events in real time.
56-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Advanced Threat Detection Statistics
To monitor advanced threat detection statistics, perform one of the following tasks:
Command Purpose
show threat-detection statistics
[min-display-rate min_display_rate] top
[[access-list | host | port-protocol]
[rate-1 | rate-2 | rate-3] |
tcp-intercept [all] detail]]
Displays the top 10 statistics.
The min-display-rate min_display_rate argument limits the display to
statistics that exceed the minimum display rate in events per second. You
can set the min_display_rate between 0 and 2147483647.
If you do not enter any options, the top 10 statistics are shown for all
categories.
To view the top 10 ACEs that match packets, including both permit and
deny ACEs, use the access-list keyword. Permitted and denied traffic are
not differentiated in this display. If you enable basic threat detection using
the threat-detection basic-threat command, you can track access list
denies using the show threat-detection rate acl-drop command.
To view only host statistics, use the host keyword. Note: Due to the threat
detction algorithm, an interface used as a combination failover and state
link could appear in the top 10 hosts; this is expected behavior, and you
can ignore this IP address in the display.
To view statistics for ports and protocols, use the port-protocol keyword.
The port-protocol keyword shows statistics for both ports and protocols
(both must be enabled for the display), and shows the combined statistics
of TCP/UDP port and IP protocol types. TCP (protocol 6) and UDP
(protocol 17) are not included in the display for IP protocols; TCP and
UDP ports are, however, included in the display for ports. If you only
enable statistics for one of these types, port or protocol, then you will only
view the enabled statistics.
To view TCP Intercept statistics, use the tcp-intercept keyword. The
display includes the top 10 protected servers under attack. The all
keyword shows the history data of all the traced servers. The detail
keyword shows history sampling data. The ASA samples the number of
attacks 30 times during the rate interval, so for the default 30 minute
period, statistics are collected every 60 seconds.
The rate-1 keyword shows the statistics for the smallest fixed rate
intervals available in the display; rate-2 shows the next largest rate
interval; and rate-3, if you have three intervals defined, shows the largest
rate interval. For example, the display shows statistics for the last 1 hour,
8 hours, and 24 hours. If you set the rate-1 keyword, the ASA shows only
the 1 hour time interval.
show threat-detection statistics
[min-display-rate min_display_rate] host
[ip_address [mask]]
Displays statistics for all hosts or for a specific host or subnet.
show threat-detection statistics
[min-display-rate min_display_rate] port
[start_port[-end_port]]
Displays statistics for all ports or for a specific port or range of ports.
56-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Advanced Threat Detection Statistics
Examples
The following is sample output from the show threat-detection statistics host command:
hostname# show threat-detection statistics host
Average(eps) Current(eps) Trigger Total events
Host:10.0.0.1: tot-ses:289235 act-ses:22571 fw-drop:0 insp-drop:0 null-ses:21438 bad-acc:0
1-hour Sent byte: 2938 0 0 10580308
8-hour Sent byte: 367 0 0 10580308
24-hour Sent byte: 122 0 0 10580308
1-hour Sent pkts: 28 0 0 104043
8-hour Sent pkts: 3 0 0 104043
24-hour Sent pkts: 1 0 0 104043
20-min Sent drop: 9 0 1 10851
1-hour Sent drop: 3 0 1 10851
1-hour Recv byte: 2697 0 0 9712670
8-hour Recv byte: 337 0 0 9712670
24-hour Recv byte: 112 0 0 9712670
1-hour Recv pkts: 29 0 0 104846
8-hour Recv pkts: 3 0 0 104846
24-hour Recv pkts: 1 0 0 104846
20-min Recv drop: 42 0 3 50567
1-hour Recv drop: 14 0 1 50567
Host:10.0.0.0: tot-ses:1 act-ses:0 fw-drop:0 insp-drop:0 null-ses:0 bad-acc:0
1-hour Sent byte: 0 0 0 614
8-hour Sent byte: 0 0 0 614
24-hour Sent byte: 0 0 0 614
1-hour Sent pkts: 0 0 0 6
8-hour Sent pkts: 0 0 0 6
24-hour Sent pkts: 0 0 0 6
20-min Sent drop: 0 0 0 4
1-hour Sent drop: 0 0 0 4
1-hour Recv byte: 0 0 0 706
8-hour Recv byte: 0 0 0 706
24-hour Recv byte: 0 0 0 706
1-hour Recv pkts: 0 0 0 7
Table 56-3 shows each field description.
show threat-detection statistics
[min-display-rate min_display_rate]
protocol [protocol_number | ah | eigrp |
esp | gre | icmp | igmp | igrp | ip |
ipinip | ipsec | nos | ospf | pcp | pim |
pptp | snp | tcp | udp]
Displays statistics for all IP protocols or for a specific protocol.
The protocol_number argument is an integer between 0 and 255.
show threat-detection memory
Displays how much memory is used by advanced threat detection
statistics.
Command Purpose
Table 56-3 show threat-detection statistics host Command Fields
Field Description
Host Shows the host IP address.
tot-ses Shows the total number of sessions for this host since it was added to the
database.
act-ses Shows the total number of active sessions that the host is currently involved in.
56-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Advanced Threat Detection Statistics
fw-drop Shows the number of firewall drops. Firewall drops is a combined rate that
includes all firewall-related packet drops tracked in basic threat detection,
including access list denials, bad packets, exceeded connection limits, DoS
attack packets, suspicious ICMP packets, TCP SYN attack packets, and no
data UDP attack packets. It does not include non-firewall-related drops such
as interface overload, packets failed at application inspection, and scanning
attack detected.
insp-drop Shows the number of packets dropped because they failed application
inspection.
null-ses Shows the number of null sessions, which are TCP SYN sessions that did not
complete within the 3-second timeout, and UDP sessions that did not have any
data sent by its server 3 seconds after the session starts.
bad-acc Shows the number of bad access attempts to host ports that are in a closed
state. When a port is determined to be in a null session (see the null-ses field
description), the port state of the host is set to HOST_PORT_CLOSE. Any
client accessing the port of the host is immediately classified as a bad access
without the need to wait for a timeout.
Average(eps) Shows the average rate in events/sec over each time period.
The ASA stores the count at the end of each burst period, for a total of 30
completed burst intervals. The unfinished burst interval presently occurring is
not included in the average rate. For example, if the average rate interval is 20
minutes, then the burst interval is 20 seconds. If the last burst interval was
from 3:00:00 to 3:00:20, and you use the show command at 3:00:25, then the
last 5 seconds are not included in the output.
The only exception to this rule is if the number of events in the unfinished
burst interval already exceeds the number of events in the oldest burst interval
(#1 of 30) when calculating the total events. In that case, the ASA calculates
the total events as the last 29 complete intervals, plus the events so far in the
unfinished burst interval. This exception lets you monitor a large increase in
events in real time.
Current(eps) Shows the current burst rate in events/sec over the last completed burst
interval, which is 1/30th of the average rate interval or 10 seconds, whichever
is larger. For the example specified in the Average(eps) description, the
current rate is the rate from 3:19:30 to 3:20:00
Trigger Shows the number of times the dropped packet rate limits were exceeded. For
valid traffic identified in the sent and received bytes and packets rows, this
value is always 0, because there are no rate limits to trigger for valid traffic.
Total events Shows the total number of events over each rate interval. The unfinished burst
interval presently occurring is not included in the total events. The only
exception to this rule is if the number of events in the unfinished burst interval
already exceeds the number of events in the oldest burst interval (#1 of 30)
when calculating the total events. In that case, the ASA calculates the total
events as the last 29 complete intervals, plus the events so far in the unfinished
burst interval. This exception lets you monitor a large increase in events in real
time.
Table 56-3 show threat-detection statistics host Command Fields (continued)
Field Description
56-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Advanced Threat Detection Statistics
Feature History for Advanced Threat Detection Statistics
Table 56-4 lists each feature change and the platform release in which it was implemented.
20-min, 1-hour,
8-hour, and 24-hour
Shows statistics for these fixed rate intervals.
Sent byte Shows the number of successful bytes sent from the host.
Sent pkts Shows the number of successful packets sent from the host.
Sent drop Shows the number of packets sent from the host that were dropped because
they were part of a scanning attack.
Recv byte Shows the number of successful bytes received by the host.
Recv pkts Shows the number of successful packets received by the host.
Recv drop Shows the number of packets received by the host that were dropped because
they were part of a scanning attack.
Table 56-3 show threat-detection statistics host Command Fields (continued)
Field Description
Table 56-4 Feature History for Advanced Threat Detection Statistics
Feature Name
Platform
Releases Feature Information
Advanced threat detection statistics 8.0(2) Advanced threat detection statistics was introduced.
The following commands were introduced:
threat-detection statistics, show threat-detection
statistics.
TCP Intercept statistics 8.0(4)/8.1(2) TCP Intercept statistics were introduced.
The following commands were modified or introduced:
threat-detection statistics tcp-intercept, show
threat-detection statistics top tcp-intercept, clear
threat-detection statistics.
Customize host statistics rate intervals 8.1(2) You can now customize the number of rate intervals for
which statistics are collected. The default number of rates
was changed from 3 to 1.
The following command was modified: threat-detection
statistics host number-of-rates.
Burst rate interval changed to 1/30th of the
average rate.
8.2(1) In earlier releases, the burst rate interval was 1/60th of the
average rate. To maximize memory usage, the sampling
interval was reduced to 30 times during the average rate.
56-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Scanning Threat Detection
Configuring Scanning Threat Detection
This section includes the following topics:
Information About Scanning Threat Detection, page 56-15
Guidelines and Limitations, page 56-16
Default Settings, page 56-16
Configuring Scanning Threat Detection, page 56-17
Monitoring Shunned Hosts, Attackers, and Targets, page 56-17
Information About Scanning Threat Detection
A typical scanning attack consists of a host that tests the accessibility of every IP address in a subnet (by
scanning through many hosts in the subnet or sweeping through many ports in a host or subnet). The
scanning threat detection feature determines when a host is performing a scan. Unlike IPS scan detection
that is based on traffic signatures, the ASA scanning threat detection feature maintains an extensive
database that contains host statistics that can be analyzed for scanning activity.
The host database tracks suspicious activity such as connections with no return activity, access of closed
service ports, vulnerable TCP behaviors such as non-random IPID, and many more behaviors.
If the scanning threat rate is exceeded, then the ASA sends a syslog message (733101), and optionally
shuns the attacker. The ASA tracks two types of rates: the average event rate over an interval, and the
burst event rate over a shorter burst interval. The burst event rate is 1/30th of the average rate interval or
10 seconds, whichever is higher. For each event detected that is considered to be part of a scanning
attack, the ASA checks the average and burst rate limits. If either rate is exceeded for traffic sent from
a host, then that host is considered to be an attacker. If either rate is exceeded for traffic received by a
host, then that host is considered to be a target.
Caution The scanning threat detection feature can affect the ASA performance and memory significantly while
it creates and gathers host- and subnet-based data structure and information.
Customize port and protocol statistics rate
intervals
8.3(1) You can now customize the number of rate intervals for
which statistics are collected. The default number of rates
was changed from 3 to 1.
The following commands were modified: threat-detection
statistics port number-of-rates, threat-detection
statistics protocol number-of-rates.
Improved memory usage 8.3(1) The memory usage for threat detection was improved.
The following command was introduced: show
threat-detection memory.
Table 56-4 Feature History for Advanced Threat Detection Statistics (continued)
Feature Name
Platform
Releases Feature Information
56-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Scanning Threat Detection
Guidelines and Limitations
This section includes the guidelines and limitations for this feature:
Security Context Guidelines
Supported in single mode only. Multiple mode is not supported.
Firewall Mode Guidelines
Supported in routed and transparent firewall mode.
Types of Traffic Monitored
Only through-the-box traffic is monitored; to-the-box traffic is not included in threat detection.
Traffic that is denied by an access list does not trigger scanning threat detection; only traffic that is
allowed through the ASA and that creates a flow is affected by scanning threat detection.
Default Settings
Table 56-5 lists the default rate limits for scanning threat detection.
The burst rate is calculated as the average rate every N seconds, where N is the burst rate interval. The
burst rate interval is 1/30th of the rate interval or 10 seconds, whichever is larger.
Table 56-5 Default Rate Limits for Scanning Threat Detection
Average Rate Burst Rate
5 drops/sec over the last 600 seconds. 10 drops/sec over the last 20 second period.
5 drops/sec over the last 3600 seconds. 10 drops/sec over the last 120 second period.
56-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Scanning Threat Detection
Configuring Scanning Threat Detection
Detailed Steps
Monitoring Shunned Hosts, Attackers, and Targets
To monitor shunned hosts and attackers and targets, perform one of the following tasks:
Command Purpose
Step 1 threat-detection scanning-threat [shun
[except {ip-address ip_address mask |
object-group network_object_group_id}]]
Example:
hostname(config)# threat-detection
scanning-threat shun except ip-address
10.1.1.0 255.255.255.0
Enables scanning threat detection. By default, the system log
message 733101 is generated when a host is identified as an
attacker. Enter this command multiple times to identify multiple
IP addresses or network object groups to exempt from shunning.
Step 2 threat-detection scanning-threat shun
duration seconds
Example:
hostname(config)# threat-detection
scanning-threat shun duration 2000
(Optional) Sets the duration of the shun for attacking hosts.
Step 3 threat-detection rate scanning-threat
rate-interval rate_interval average-rate
av_rate burst-rate burst_rate
Example:
hostname(config)# threat-detection rate
scanning-threat rate-interval 1200
average-rate 10 burst-rate 20
hostname(config)# threat-detection rate
scanning-threat rate-interval 2400
average-rate 10 burst-rate 20
(Optional) Changes the default event limit for when the ASA
identifies a host as an attacker or as a target. If you already
configured this command as part of the basic threat detection
configuration (see the Configuring Basic Threat Detection
Statistics section on page 56-2), then those settings are shared
with the scanning threat detection feature; you cannot configure
separate rates for basic and scanning threat detection. If you do
not set the rates using this command, the default values are used
for both the scanning threat detection feature and the basic threat
detection feature. You can configure up to three different rate
intervals, by entering separate commands.
Command Purpose
show threat-detection shun
Displays the hosts that are currently shunned.
56-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuring Scanning Threat Detection
Examples
The following is sample output from the show threat-detection shun command:
hostname# show threat-detection shun
Shunned Host List:
10.1.1.6
192.168.6.7
To release the host at 10.1.1.6, enter the following command:
hostname# clear threat-detection shun 10.1.1.6
The following is sample output from the show threat-detection scanning-threat attacker command:
hostname# show threat-detection scanning-threat attacker
10.1.2.3
10.8.3.6
209.165.200.225
Feature History for Scanning Threat Detection
Table 56-6 lists each feature change and the platform release in which it was implemented.
clear threat-detection shun [ip_address
[mask]]
Releases a host from being shunned. If you do not
specify an IP address, all hosts are cleared from
the shun list.
show threat-detection scanning-threat
[attacker | target]
Displays hosts that the ASA decides are attackers
(including hosts on the shun list), and displays the
hosts that are the target of an attack. If you do not
enter an option, both attackers and target hosts are
displayed.
Command Purpose
Table 56-6 Feature History for Scanning Threat Detection
Feature Name
Platform
Releases Feature Information
Scanning threat detection 8.0(2) Scanning threat detection was introduced.
The following commands were introduced:
threat-detection scanning-threat, threat-detection rate
scanning-threat, show threat-detection scanning-threat,
show threat-detection shun, clear threat-detection shun.
Shun duration 8.0(4)/8.1(2) You can now set the shun duration,
The following command was introduced: threat-detection
scanning-threat shun duration.
56-19
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuration Examples for Threat Detection
Configuration Examples for Threat Detection
The following example configures basic threat detection statistics, and changes the DoS attack rate
settings. All advanced threat detection statistics are enabled, with the host statistics number of rate
intervals lowered to 2. The TCP Intercept rate interval is also customized. Scanning threat detection is
enabled with automatic shunning for all addresses except 10.1.1.0/24. The scanning threat rate intervals
are customized.
threat-detection basic-threat
threat-detection rate dos-drop rate-interval 600 average-rate 60 burst-rate 100
threat-detection statistics
threat-detection statistics host number-of-rate 2
threat-detection statistics tcp-intercept rate-interval 60 burst-rate 800 average-rate 600
threat-detection scanning-threat shun except ip-address 10.1.1.0 255.255.255.0
threat-detection rate scanning-threat rate-interval 1200 average-rate 10 burst-rate 20
threat-detection rate scanning-threat rate-interval 2400 average-rate 10 burst-rate 20
Burst rate interval changed to 1/30th of the
average rate.
8.2(1) In earlier releases, the burst rate interval was 1/60th of the
average rate. To maximize memory usage, the sampling
interval was reduced to 30 times during the average rate.
Improved memory usage 8.3(1) The memory usage for threat detection was improved.
Table 56-6 Feature History for Scanning Threat Detection (continued)
Feature Name
Platform
Releases Feature Information
56-20
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 56 Configuring Threat Detection
Configuration Examples for Threat Detection
C H A P T E R
57-1
Cisco ASA 5500 Series Configuration Guide using the CLI
57
Using Protection Tools
This chapter describes some of the many tools available to protect your network and includes the
following sections:
Preventing IP Spoofing, page 57-1
Configuring the Fragment Size, page 57-2
Blocking Unwanted Connections, page 57-2
Configuring IP Audit for Basic IPS Support, page 57-3
Preventing IP Spoofing
This section lets you enable Unicast Reverse Path Forwarding on an interface. Unicast RPF guards
against IP spoofing (a packet uses an incorrect source IP address to obscure its true source) by ensuring
that all packets have a source IP address that matches the correct source interface according to the
routing table.
Normally, the ASA only looks at the destination address when determining where to forward the packet.
Unicast RPF instructs the ASA to also look at the source address; this is why it is called Reverse Path
Forwarding. For any traffic that you want to allow through the ASA, the ASA routing table must include
a route back to the source address. See RFC 2267 for more information.
For outside traffic, for example, the ASA can use the default route to satisfy the Unicast RPF protection.
If traffic enters from an outside interface, and the source address is not known to the routing table, the
ASA uses the default route to correctly identify the outside interface as the source interface.
If traffic enters the outside interface from an address that is known to the routing table, but is associated
with the inside interface, then the ASA drops the packet. Similarly, if traffic enters the inside interface
from an unknown source address, the ASA drops the packet because the matching route (the default
route) indicates the outside interface.
Unicast RPF is implemented as follows:
ICMP packets have no session, so each packet is checked.
UDP and TCP have sessions, so the initial packet requires a reverse route lookup. Subsequent
packets arriving during the session are checked using an existing state maintained as part of the
session. Non-initial packets are checked to ensure they arrived on the same interface used by the
initial packet.
To enable Unicast RPF, enter the following command:
hostname(config)# ip verify reverse-path interface interface_name
57-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 57 Using Protection Tools
Configuring the Fragment Size
Configuring the Fragment Size
By default, the ASA allows up to 24 fragments per IP packet, and up to 200 fragments awaiting
reassembly. You might need to let fragments on your network if you have an application that routinely
fragments packets, such as NFS over UDP. However, if you do not have an application that fragments
traffic, we recommend that you do not allow fragments through the ASA. Fragmented packets are often
used as DoS attacks.
To set disallow fragments, enter the following command:
hostname(config)# fragment chain 1 [interface_name]
Enter an interface name if you want to prevent fragmentation on a specific interface. By default, this
command applies to all interfaces.
Blocking Unwanted Connections
If you know that a host is attempting to attack your network (for example, syslog messages show an
attack), then you can block (or shun) connections based on the source IP address. All existing
connections and new connections are blocked until you remove the shun.
Note If you have an IPS that monitors traffic, such as an AIP SSM, then the IPS can shun connections
automatically.
To shun a connection manually, perform the following steps:
Step 1 If necessary, view information about the connection by entering the following command:
hostname# show conn
The ASA shows information about each connection, such as the following:
TCP out 64.101.68.161:4300 in 10.86.194.60:23 idle 0:00:00 bytes 1297 flags UIO
Step 2 To shun connections from the source IP address, enter the following command:
hostname(config)# shun src_ip [dst_ip src_port dest_port [protocol]] [vlan vlan_id]
If you enter only the source IP address, then all future connections are shunned; existing connections
remain active.
To drop an existing connection, as well as blocking future connections from the source IP address, enter
the destination IP address, source and destination ports, and the protocol. By default, the protocol is 0
for IP. Note that specifying the additional parameters is a convenient way to also drop a specific current
connection; the shun, however, remains in place for all future connections from the source IP address,
regardless of destination parameters.
For multiple context mode, you can enter this command in the admin context, and by specifying a
VLAN ID that is assigned to an interface in other contexts, you can shun the connection in other
contexts.
Step 3 To remove the shun, enter the following command:
hostname(config)# no shun src_ip [vlan vlan_id]
57-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 57 Using Protection Tools
Configuring IP Audit for Basic IPS Support
Configuring IP Audit for Basic IPS Support
The IP audit feature provides basic IPS support for the ASA that does not have an AIP SSM. It supports
a basic list of signatures, and you can configure the ASA to perform one or more actions on traffic that
matches a signature.
This section includes the following topics:
Configuring IP Audit, page 57-3
IP Audit Signature List, page 57-4
Configuring IP Audit
To enable IP audit, perform the following steps:
Step 1 To define an IP audit policy for informational signatures, enter the following command:
hostname(config)# ip audit name name info [action [alarm] [drop] [reset]]
Where alarm generates a system message showing that a packet matched a signature, drop drops the
packet, and reset drops the packet and closes the connection. If you do not define an action, then the
default action is to generate an alarm.
Step 2 To define an IP audit policy for attack signatures, enter the following command:
hostname(config)# ip audit name name attack [action [alarm] [drop] [reset]]
Where alarm generates a system message showing that a packet matched a signature, drop drops the
packet, and reset drops the packet and closes the connection. If you do not define an action, then the
default action is to generate an alarm.
Step 3 To assign the policy to an interface, enter the following command:
ip audit interface interface_name policy_name
Step 4 To disable signatures, or for more information about signatures, see the ip audit signature command in
the command reference.
57-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 57 Using Protection Tools
Configuring IP Audit for Basic IPS Support
IP Audit Signature List
Table 57-1 lists supported signatures and system message numbers.
Table 57-1 Signature IDs and System Message Numbers
Signature
ID
Message
Number Signature Title Signature Type Description
1000 400000 IP options-Bad Option List Informational Triggers on receipt of an IP datagram where
the list of IP options in the IP datagram header
is incomplete or malformed. The IP options
list contains one or more options that perform
various network management or debugging
tasks.
1001 400001 IP options-Record Packet Route Informational Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 7 (Record Packet Route).
1002 400002 IP options-Timestamp Informational Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 4 (Timestamp).
1003 400003 IP options-Security Informational Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 2 (Security options).
1004 400004 IP options-Loose Source Route Informational Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 3 (Loose Source Route).
1005 400005 IP options-SATNET ID Informational Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 8 (SATNET stream identifier).
1006 400006 IP options-Strict Source Route Informational Triggers on receipt of an IP datagram in
which the IP option list for the datagram
includes option 2 (Strict Source Routing).
1100 400007 IP Fragment Attack Attack Triggers when any IP datagram is received
with an offset value less than 5 but greater
than 0 indicated in the offset field.
1102 400008 IP Impossible Packet Attack Triggers when an IP packet arrives with
source equal to destination address. This
signature will catch the so-called Land
Attack.
57-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 57 Using Protection Tools
Configuring IP Audit for Basic IPS Support
1103 400009 IP Overlapping Fragments (Teardrop) Attack Triggers when two fragments contained
within the same IP datagram have offsets that
indicate that they share positioning within the
datagram. This could mean that fragment A is
being completely overwritten by fragment B,
or that fragment A is partially being
overwritten by fragment B. Some operating
systems do not properly handle fragments that
overlap in this manner and may throw
exceptions or behave in other undesirable
ways upon receipt of overlapping fragments,
which is how the Teardrop attack works to
create a DoS.
2000 400010 ICMP Echo Reply Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 0 (Echo Reply).
2001 400011 ICMP Host Unreachable Informational Triggers when an IP datagram is received
with the protocol field of the IP header set to
1 (ICMP) and the type field in the ICMP
header set to 3 (Host Unreachable).
2002 400012 ICMP Source Quench Informational Triggers when an IP datagram is received
with the protocol field of the IP header set to
1 (ICMP) and the type field in the ICMP
header set to 4 (Source Quench).
2003 400013 ICMP Redirect Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 5 (Redirect).
2004 400014 ICMP Echo Request Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 8 (Echo Request).
2005 400015 ICMP Time Exceeded for a Datagram Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 11(Time Exceeded for a Datagram).
2006 400016 ICMP Parameter Problem on
Datagram
Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 12 (Parameter Problem on Datagram).
2007 400017 ICMP Timestamp Request Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 13 (Timestamp Request).
Table 57-1 Signature IDs and System Message Numbers (continued)
Signature
ID
Message
Number Signature Title Signature Type Description
57-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 57 Using Protection Tools
Configuring IP Audit for Basic IPS Support
2008 400018 ICMP Timestamp Reply Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 14 (Timestamp Reply).
2009 400019 ICMP Information Request Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 15 (Information Request).
2010 400020 ICMP Information Reply Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 16 (ICMP Information Reply).
2011 400021 ICMP Address Mask Request Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 17 (Address Mask Request).
2012 400022 ICMP Address Mask Reply Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 18 (Address Mask Reply).
2150 400023 Fragmented ICMP Traffic Attack Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and either the more fragments flag is
set to 1 (ICMP) or there is an offset indicated
in the offset field.
2151 400024 Large ICMP Traffic Attack Triggers when a IP datagram is received with
the protocol field of the IP header set to
1(ICMP) and the IP length > 1024.
2154 400025 Ping of Death Attack Attack Triggers when a IP datagram is received with
the protocol field of the IP header set to
1(ICMP), the Last Fragment bit is set, and (IP
offset * 8) + (IP data length) > 65535 that is
to say, the IP offset (which represents the
starting position of this fragment in the
original packet, and which is in 8 byte units)
plus the rest of the packet is greater than the
maximum size for an IP packet.
3040 400026 TCP NULL flags Attack Triggers when a single TCP packet with none
of the SYN, FIN, ACK, or RST flags set has
been sent to a specific host.
3041 400027 TCP SYN+FIN flags Attack Triggers when a single TCP packet with the
SYN and FIN flags are set and is sent to a
specific host.
Table 57-1 Signature IDs and System Message Numbers (continued)
Signature
ID
Message
Number Signature Title Signature Type Description
57-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 57 Using Protection Tools
Configuring IP Audit for Basic IPS Support
1002 400002 IP options-Timestamp Informational Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 4 (Timestamp).
1003 400003 IP options-Security Informational Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 2 (Security options).
1004 400004 IP options-Loose Source Route Informational Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 3 (Loose Source Route).
1005 400005 IP options-SATNET ID Informational Triggers on receipt of an IP datagram where
the IP option list for the datagram includes
option 8 (SATNET stream identifier).
1006 400006 IP options-Strict Source Route Informational Triggers on receipt of an IP datagram in
which the IP option list for the datagram
includes option 2 (Strict Source Routing).
1100 400007 IP Fragment Attack Attack Triggers when any IP datagram is received
with an offset value less than 5 but greater
than 0 indicated in the offset field.
1102 400008 IP Impossible Packet Attack Triggers when an IP packet arrives with
source equal to destination address. This
signature will catch the so-called Land
Attack.
57-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 57 Using Protection Tools
Configuring IP Audit for Basic IPS Support
2002 400012 ICMP Source Quench Informational Triggers when an IP datagram is received
with the protocol field of the IP header set to
1 (ICMP) and the type field in the ICMP
header set to 4 (Source Quench).
2003 400013 ICMP Redirect Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 5 (Redirect).
2004 400014 ICMP Echo Request Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 8 (Echo Request).
2005 400015 ICMP Time Exceeded for a Datagram Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 11(Time Exceeded for a Datagram).
2006 400016 ICMP Parameter Problem on
Datagram
Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 12 (Parameter Problem on Datagram).
2007 400017 ICMP Timestamp Request Informational Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and the type field in the ICMP header
set to 13 (Timestamp Request).
Table 57-1 Signature IDs and System Message Numbers (continued)
Signature
ID
Message
Number Signature Title Signature Type Description
57-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 57 Using Protection Tools
Configuring IP Audit for Basic IPS Support
2150 400023 Fragmented ICMP Traffic Attack Triggers when a IP datagram is received with
the protocol field of the IP header set to 1
(ICMP) and either the more fragments flag is
set to 1 (ICMP) or there is an offset indicated
in the offset field.
2151 400024 Large ICMP Traffic Attack Triggers when a IP datagram is received with
the protocol field of the IP header set to
1(ICMP) and the IP length > 1024.
2154 400025 Ping of Death Attack Attack Triggers when a IP datagram is received with
the protocol field of the IP header set to
1(ICMP), the Last Fragment bit is set, and (IP
offset * 8) + (IP data length) > 65535 that is
to say, the IP offset (which represents the
starting position of this fragment in the
original packet, and which is in 8 byte units)
plus the rest of the packet is greater than the
maximum size for an IP packet.
3040 400026 TCP NULL flags Attack Triggers when a single TCP packet with none
of the SYN, FIN, ACK, or RST flags set has
been sent to a specific host.
3041 400027 TCP SYN+FIN flags Attack Triggers when a single TCP packet with the
SYN and FIN flags are set and is sent to a
specific host.
Table 57-1 Signature IDs and System Message Numbers (continued)
Signature
ID
Message
Number Signature Title Signature Type Description
57-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 57 Using Protection Tools
Configuring IP Audit for Basic IPS Support
6051 400035 DNS Zone Transfer Informational Triggers on normal DNS zone transfers, in
which the source port is 53.
6052 400036 DNS Zone Transfer from High Port Informational Triggers on an illegitimate DNS zone transfer,
in which the source port is not equal to 53.
6053 400037 DNS Request for All Records Informational Triggers on a DNS request for all records.
6100 400038 RPC Port Registration Informational Triggers when attempts are made to register
new RPC services on a target host.
6101 400039 RPC Port Unregistration Informational Triggers when attempts are made to
unregister existing RPC services on a target
host.
6102 400040 RPC Dump Informational Triggers when an RPC dump request is issued
to a target host.
6103 400041 Proxied RPC Request Attack Triggers when a proxied RPC request is sent
to the portmapper of a target host.
6150 400042 ypserv (YP server daemon) Portmap
Request
Informational Triggers when a request is made to the
portmapper for the YP server daemon
(ypserv) port.
6151 400043 ypbind (YP bind daemon) Portmap
Request
Informational Triggers when a request is made to the
portmapper for the YP bind daemon (ypbind)
port.
6152 400044 yppasswdd (YP password daemon)
Portmap Request
Informational Triggers when a request is made to the
portmapper for the YP password daemon
(yppasswdd) port.
6153 400045 ypupdated (YP update daemon)
Portmap Request
Informational Triggers when a request is made to the
portmapper for the YP update daemon
(ypupdated) port.
6154 400046 ypxfrd (YP transfer daemon) Portmap
Request
Informational Triggers when a request is made to the
portmapper for the YP transfer daemon
(ypxfrd) port.
6155 400047 mountd (mount daemon) Portmap
Request
Informational Triggers when a request is made to the
portmapper for the mount daemon (mountd)
port.
6175 400048 rexd (remote execution daemon)
Portmap Request
Informational Triggers when a request is made to the
portmapper for the remote execution daemon
(rexd) port.
Table 57-1 Signature IDs and System Message Numbers (continued)
Signature
ID
Message
Number Signature Title Signature Type Description
57-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 57 Using Protection Tools
Configuring IP Audit for Basic IPS Support
6180 400049 rexd (remote execution daemon)
Attempt
Informational Triggers when a call to the rexd program is
made. The remote execution daemon is the
server responsible for remote program
execution. This may be indicative of an
attempt to gain unauthorized access to system
resources.
6190 400050 statd Buffer Overflow Attack Triggers when a large statd request is sent.
This could be an attempt to overflow a buffer
and gain access to system resources.
Table 57-1 Signature IDs and System Message Numbers (continued)
Signature
ID
Message
Number Signature Title Signature Type Description
57-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 57 Using Protection Tools
Configuring IP Audit for Basic IPS Support
P A R T 1 4
Configuring Modules
C H A P T E R
58-1
Cisco ASA 5500 Series Configuration Guide using the CLI
58
Configuring the ASA IPS Module
This chapter describes how to configure the ASA IPS module. The ASA IPS module might be a physical
module or a software module, depending on your ASA model. For a list of supported ASA IPS modules
per ASA model, see the Cisco ASA Compatibility Matrix:
http://www.cisco.com/en/US/docs/security/asa/compatibility/asamatrx.html
This chapter includes the following sections:
Information About the ASA IPS module, page 58-1
Licensing Requirements for the ASA IPS module, page 58-5
Guidelines and Limitations, page 58-5
Default Settings, page 58-6
Configuring the ASA IPS module, page 58-6
Monitoring the ASA IPS module, page 58-20
Troubleshooting the ASA IPS module, page 58-21
Configuration Examples for the ASA IPS module, page 58-25
Feature History for the ASA IPS module, page 58-25
Information About the ASA IPS module
The ASA IPS module runs advanced IPS software that provides proactive, full-featured intrusion
prevention services to stop malicious traffic, including worms and network viruses, before they can
affect your network. This section includes the following topics:
How the ASA IPS module Works with the ASA, page 58-2
Operating Modes, page 58-2
Using Virtual Sensors (ASA 5510 and Higher), page 58-3
Information About Management Access, page 58-4
58-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Information About the ASA IPS module
How the ASA IPS module Works with the ASA
The ASA IPS module runs a separate application from the ASA. The ASA IPS module might include an
external management interface so you can connect to the ASA IPS module directly; if it does not have a
management interface, you can connect to the ASA IPS module through the ASA interface. Any other
interfaces on the ASA IPS module, if available for your model, are used for ASA traffic only.
Traffic goes through the firewall checks before being forwarded to the ASA IPS module. When you
identify traffic for IPS inspection on the ASA, traffic flows through the ASA and the ASA IPS module
as follows. Note: This example is for inline mode. See the Operating Modes section on page 58-2
for information about promiscuous mode, where the ASA only sends a copy of the traffic to the ASA
IPS module.
1. Traffic enters the ASA.
2. Incoming VPN traffic is decrypted.
3. Firewall policies are applied.
4. Traffic is sent to the ASA IPS module.
5. The ASA IPS module applies its security policy to the traffic, and takes appropriate actions.
6. Valid traffic is sent back to the ASA; the ASA IPS module might block some traffic according to its
security policy, and that traffic is not passed on.
7. Outgoing VPN traffic is encrypted.
8. Traffic exits the ASA.
Figure 58-1 shows the traffic flow when running the ASA IPS module in inline mode. In this example,
the ASA IPS module automatically blocks traffic that it identified as an attack. All other traffic is
forwarded through the ASA.
Figure 58-1 ASA IPS module Traffic Flow in the ASA: Inline Mode
Operating Modes
You can send traffic to the ASA IPS module using one of the following modes:
Inline modeThis mode places the ASA IPS module directly in the traffic flow (see Figure 58-1).
No traffic that you identified for IPS inspection can continue through the ASA without first passing
through, and being inspected by, the ASA IPS module. This mode is the most secure because every
ASA
Main System
IPS
Diverted Traffic
IPS inspection
VPN
Decryption
Firewall
Policy
Block
2
5
1
1
5
7
inside
outside
58-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Information About the ASA IPS module
packet that you identify for inspection is analyzed before being allowed through. Also, the ASA IPS
module can implement a blocking policy on a packet-by-packet basis. This mode, however, can
affect throughput.
Promiscuous modeThis mode sends a duplicate stream of traffic to the ASA IPS module. This
mode is less secure, but has little impact on traffic throughput. Unlike inline mode, in promiscuous
mode the ASA IPS module can only block traffic by instructing the ASA to shun the traffic or by
resetting a connection on the ASA. Also, while the ASA IPS module is analyzing the traffic, a small
amount of traffic might pass through the ASA before the ASA IPS module can shun it. Figure 58-2
shows the ASA IPS module in promiscuous mode. In this example, the ASA IPS module sends a
shun message to the ASA for traffic it identified as a threat.
Figure 58-2 ASA IPS module Traffic Flow in the ASA: Promiscuous Mode
Using Virtual Sensors (ASA 5510 and Higher)
The ASA IPS module running IPS software Version 6.0 and later can run multiple virtual sensors, which
means you can configure multiple security policies on the ASA IPS module. You can assign each ASA
security context or single mode ASA to one or more virtual sensors, or you can assign multiple security
contexts to the same virtual sensor. See the IPS documentation for more information about virtual
sensors, including the maximum number of sensors supported.
Figure 58-3 shows one security context paired with one virtual sensor (in inline mode), while two
security contexts share the same virtual sensor.
ASA
Main System
inside
IPS
IPS inspection
outside
VPN
Decryption
Firewall
Policy
Shun
message
2
5
1
1
5
8
Copied Traffic
58-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Information About the ASA IPS module
Figure 58-3 Security Contexts and Virtual Sensors
Figure 58-4 shows a single mode ASA paired with multiple virtual sensors (in inline mode); each defined
traffic flow goes to a different sensor.
Figure 58-4 Single Mode ASA with Multiple Virtual Sensors
Information About Management Access
You can manage the IPS application using the following methods:
Sessioning to the module from the ASAIf you have CLI access to the ASA, then you can session
to the module and access the module CLI. See the Sessioning to the Module from the ASA section
on page 58-9.
Connecting to the IPS management interface using ASDM or SSHAfter you launch ASDM on the
ASA, ASDM connects to the module management interface to configure the IPS application. For
SSH, you can access the module CLI directly on the module management interface. (Telnet access
requires additional configuration in the module application). The module management interface can
also be used for sending syslog messages or allowing updates for the module application, such as
signature database updates. See the Connecting Management Interface Cables section on
page 58-7.
See the following information about the management interface:
ASA
Main System
IPS
Sensor
1
Context
1
Context
2
Context
3
Sensor
2
2
5
1
1
6
0
Sensor
1
Sensor
2
Sensor
3
ASA
Main System
IPS
Traffic 1
Traffic 2
Traffic 3
2
5
1
1
5
9
58-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Licensing Requirements for the ASA IPS module
ASA 5510, ASA 5520, ASA 5540, ASA 5580, ASA 5585-XThe IPS management interface
is a separate external Gigabit Ethernet interface. If you cannot use the default address (see the
Default Settings section on page 58-6), you can change the interface IP address and other
network parameters. See the Configuring Basic IPS Module Network Settings section on
page 58-10. The IPS management IP address can be on the same network as the ASA (connected
through a switch), or on a different network (through a router). If you use a different network,
be sure to set the IPS gateway as appropriate.
ASA 5512-X, ASA 5515-X, ASA 5525-X, ASA 5545-X, ASA 5555-XThese models run the
ASA IPS module as a software module. The IPS management interface shares the
Management 0/0 interface with the ASA. Separate MAC addresses and IP addresses are
supported for the ASA and ASA IPS module. You must perform configuration of the IPS IP
address within the IPS operating system (using the CLI or ASDM). However, physical
characteristics (such as enabling the interface) are configured on the ASA. You can change the
interface IP address and other network parameters. You should set the default gateway to be an
upstream router instead of the ASA management interface. Because the ASA management
interface does not allow through-traffic, traffic destined to another network is not allowed
through the ASA. See the Configuring Basic IPS Module Network Settings section on
page 58-10.
ASA 5505You can use an ASA VLAN to allow access to an internal management IP address
over the backplane. See the (ASA 5505) Configuring Basic Network Settings section on
page 58-11 to change the network settings.
Licensing Requirements for the ASA IPS module
The following table shows the licensing requirements for this feature:
The ASA IPS module requires a separate Cisco Services for IPS license in order to support signature
updates. All other updates are available without a license.
Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
The ASA 5505 does not support multiple context mode, so multiple context features, such as virtual
sensors, are not supported on the AIP SSC.
Model License Requirement
ASA 5512-X,
ASA 5515-X,
ASA 5525-X,
ASA 5545-X,
ASA 5555-X
IPS Module License.
1
1. For failover pairs, both units require the IPS module license.
All other models Base License.
58-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Default Settings
Firewall Mode Guidelines
Supported in routed and transparent firewall mode.
Model Guidelines
See the Cisco ASA Compatibility Matrix for information about which models support which
modules:
http://www.cisco.com/en/US/docs/security/asa/compatibility/asamatrx.html
The ASA 5505 does not support multiple context mode, so multiple context features, such as virtual
sensors, are not supported on the AIP SSC.
The ASA IPS module for the ASA 5510 and higher supports higher performance requirements,
while the ASA IPS module for the ASA 5505 is designed for a small office installation. The
following features are not supported for the ASA 5505:
Virtual sensors
Anomaly detection
Unretirement of default retired signatures
Additional Guidelines
You cannot change the software type installed on the module; if you purchase an ASA IPS module, you
cannot later install other software on it.
Default Settings
Table 58-1 lists the default settings for the ASA IPS module.
Note The default management IP address on the ASA is 192.168.1.1/24.
Configuring the ASA IPS module
This section describes how to configure the ASA IPS module and includes the following topics:
Task Flow for the ASA IPS Module, page 58-7
Connecting Management Interface Cables, page 58-7
Table 58-1 Default Network Parameters
Parameters Default
Management VLAN (ASA 5505 only) VLAN 1
Management IP address 192.168.1.2/24
Management hosts (ASA 5505 only) 192.168.1.5 through 192.168.1.254
Gateway 192.168.1.1/24 (the default ASA management IP address)
Username cisco
Password cisco
58-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
Configuring Basic IPS Module Network Settings, page 58-10
(ASA 5512-X through ASA 5555-X) Installing the Software Module, page 58-14
Configuring the Security Policy on the ASA IPS module, page 58-14
Assigning Virtual Sensors to a Security Context (ASA 5510 and Higher), page 58-15
Diverting Traffic to the ASA IPS module, page 58-17
Task Flow for the ASA IPS Module
Configuring the ASA IPS module is a process that includes configuration of the IPS security policy on
the ASA IPS module and then configuration of the ASA to send traffic to the ASA IPS module. To
configure the ASA IPS module, perform the following steps:
Step 1 Cable the ASA and IPS management interfaces. See the Connecting Management Interface Cables
section on page 58-7.
Step 2 Depending on your ASA model:
(ASA 5510 and higher) Configure basic network settings for the IPS module. See the (ASA 5510
and Higher) Configuring Basic Network Settings section on page 58-10.
(ASA 5505) Configure the management VLAN and IP address for the IPS module. See the (ASA
5505) Configuring Basic Network Settings section on page 58-11.
Step 3 (ASA 5512-X through ASA 5555-X; may be required) Install the software module. See the (ASA
5512-X through ASA 5555-X) Installing the Software Module section on page 58-14.
Step 4 On the module, configure the inspection and protection policy, which determines how to inspect traffic
and what to do when an intrusion is detected. See the Configuring the Security Policy on the ASA IPS
module section on page 58-14.
Step 5 (ASA 5510 and higher, optional) On the ASA in multiple context mode, specify which IPS virtual
sensors are available for each context (if you configured virtual sensors). See the Assigning Virtual
Sensors to a Security Context (ASA 5510 and Higher) section on page 58-15.
Step 6 On the ASA, identify traffic to divert to the ASA IPS module. See the Diverting Traffic to the ASA IPS
module section on page 58-17.
Connecting Management Interface Cables
Connect the management PC to the ASA management interface and the ASA IPS module management
interface.
Guidelines
Your cabling might differ depending on your network.
See the Information About Management Access section on page 58-4.
58-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
Detailed Steps
ASA 5505
The ASA 5505 does not have a dedicated management interface. You must use an ASA VLAN to access
an internal management IP address over the backplane. For a factory default configuration, connect the
management PC to one of the following ports: Ethernet 0/1 through 0/7, which are assigned to VLAN 1.
ASA 5512-X through ASA 5555-X (Software Module)
These models run the ASA IPS module as a software module, and the IPS management interface shares
the Management 0/0 interface with the ASA.
Security
Services
Card Slot
1
2 POWER
48VDC
7 POWER over ETHERNET 6 5 4 3 2 1 0
Console
RESET
Ports 1 7 VLAN 1
Default ASA IP: 192.168.1.1/IPS IP: 192.168.1.2
Default IPS Gateway: 192.168.1.1 (ASA)
ASA 5505
Management PC
(IP Address from DHCP)
Cisco ASA SSC-05 STATUS
ASA 5545-X
PC (IP Address
from DHCP)
IPS Management 0/0
192.168.1.2
ASA Management 0/0
192.168.1.1
3
3
1
1
8
1
58-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
ASA 5510, ASA 5520, ASA 5540, ASA 5580, ASA 5585-X (Physical Module)
Connect to the ASA Management 0/0 interface and the IPS Management 1/0 interface.
What to Do Next
(ASA 5510 and higher) Configure basic network settings. See the (ASA 5510 and Higher)
Configuring Basic Network Settings section on page 58-10.
(ASA 5505) Configure management interface settings. See the (ASA 5505) Configuring Basic
Network Settings section on page 58-11.
Sessioning to the Module from the ASA
To access the IPS module CLI from the ASA, you can session from the ASA. For software modules, you
can either session to the module (using Telnet) or create a virtual console session. A console session
might be useful if the control plane is down and you cannot establish a Telnet session.
ASA 5585-X
Switch
PWR
BOOT
ALARM
ACT
VPN
PS1
HDD1
PS0
HDD0
USB
RESET
0 SFP1 SFP0 1 0 1 2 3 4 5 6 7 MGMT
0
1
AUX CONSOLE
PWR
BOOT
ALARM
ACT
VPN
PS1
HDD1
PS0
HDD0
USB
RESET
0 SFP1 SFP0 1 0 1 2 3 4 5 6 7 MGMT
0
1
AUX CONSOLE
PC (IP Address
from DHCP)
ASA Management 0/0
192.168.1.1
IPS Management 1/0
192.168.1.2
SSP
IPS SSP
3
3
1
1
8
2
58-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
Detailed Steps
Configuring Basic IPS Module Network Settings
(ASA 5510 and Higher) Configuring Basic Network Settings, page 58-10
(ASA 5505) Configuring Basic Network Settings, page 58-11
(ASA 5510 and Higher) Configuring Basic Network Settings
Session to the module from the ASA and configure basic settings using the setup command.
Note (ASA 5512-X through ASA 5555-X) If you cannot session to the module, then the IPS module is not
running. See the (ASA 5512-X through ASA 5555-X) Installing the Software Module section on
page 58-14, and then repeat this procedure after you install the module.
Command Purpose
Telnet session.
For a physical module (for example, the
ASA 5585-X):
session 1
For a software module (for example, the
ASA 5545-X):
session ips
Example:
hostname# session 1
Opening command session with slot 1.
Connected to slot 1. Escape character
sequence is 'CTRL-^X'.
sensor login: cisco
Password: cisco
Accesses the module using Telnet. You are prompted for the username and
password. The default username is cisco, and the default password is cisco.
Note The first time you log in to the module, you are prompted to change
the default password. Passwords must be at least eight characters
long and cannot be a word in the dictionary.
Console session (software module only).
session ips console
Example:
hostname# session ips console
Establishing console session with slot 1
Opening console session with module ips.
Connected to module ips. Escape character
sequence is 'CTRL-SHIFT-6 then x'.
sensor login: cisco
Password: cisco
Accesses the module console. You are prompted for the username and
password. The default username is cisco, and the default password is cisco.
58-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
Detailed Steps
(ASA 5505) Configuring Basic Network Settings
An ASA IPS module on the ASA 5505 does not have any external interfaces. You can configure a VLAN
to allow access to an internal IPS management IP address over the backplane. By default, VLAN 1 is
enabled for IPS management. You can only assign one VLAN as the management VLAN. This section
describes how to change the management VLAN and IP address if you do not want to use the default. It
also describes how to change the allowed hosts and gateway. See the Default Settings section on
page 58-6 for more information about defaults.
Note Perform this configuration on the ASA 5505, not on the ASA IPS module.
Prerequisites
When you change the IPS VLAN and management address from the default, be sure to also configure
the matching ASA VLAN and switch port(s) according to the procedures listed in Chapter 7, Starting
Interface Configuration (ASA 5505). You must define and configure the VLAN for the ASA so the IPS
management interface is accessible on the network.
Command Purpose
Step 1 Session to the IPS module according to the
Sessioning to the Module from the ASA
section on page 58-9.
Step 2 setup
Example:
sensor# setup
Runs the setup utility for initial configuration of the ASA IPS
module. You are prompted for basic settings.
58-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
Restrictions
Do not configure NAT for the management address if you intend to access it using ASDM. For initial
setup with ASDM, you need to access the real address. After initial setup (where you set the password
on the ASA IPS module), you can configure NAT and supply ASDM with the translated address for
accessing the ASA IPS module.
Detailed Steps
Command Purpose
Step 1 interface vlan number
Example:
hostname(config)# interface vlan 1
Specifies the current management VLAN for which you want to
disable IPS management. By default, this is VLAN 1.
Step 2 no allow-ssc-mgmt
Example:
hostname(config-if)# no allow-ssc-mgmt
Disables IPS management for the old VLAN so that you can
enable it for a different VLAN.
Step 3 interface vlan number
Example:
hostname(config)# interface vlan 20
Specifies the VLAN you want to use as the new IPS management
VLAN.
Step 4 allow-ssc-mgmt
Example:
hostname(config-if)# allow-ssc-mgmt
Sets this interface as the IPS management interface.
58-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
Examples
The following example configures VLAN 20 as the IPS management VLAN. This VLAN is restricted
to management traffic only. Only the host at 10.1.1.30 can access the IPS management IP address. VLAN
20 is assigned to switch port Ethernet 0/0. When you connect to ASDM on ASA interface 10.1.1.1,
ASDM then accesses the IPS on 10.1.1.2.
hostname(config)# interface vlan 1
hostname(config-if)# no allow-ssc-mgmt
hostname(config-if)# interface vlan 20
hostname(config-if)# nameif inside
hostname(config-if)# ip address 10.1.1.1 255.255.255.0
hostname(config-if)# security-level 100
hostname(config-if)# allow-ssc-mgmt
hostname(config-if)# no shutdown
hostname(config-if)# management-only
hostname(config-if)# hw-module module 1 ip 10.1.1.2 255.255.255.0 10.1.1.1
hostname(config)# hw-module module 1 allow-ip 10.1.1.30 255.255.255.255
hostname(config)# interface ethernet 0/0
hostname(config-if)# switchport access vlan 20
hostname(config-if)# no shutdown
Step 5 hw-module module 1 ip ip_address netmask
gateway
Example:
hostname# hw-module module 1 ip 10.1.1.2
255.255.255.0 10.1.1.1
Configures the management IP address for the ASA IPS module.
Make sure this address is on the same subnet as the ASA VLAN
IP address. For example, if you assigned 10.1.1.1 to the VLAN for
the ASA, then assign another address on that network, such as
10.1.1.2, for the IPS management address.
If the management station is on a directly-connected ASA
network, then set the gateway to be the ASA IP address assigned
to the IPS management VLAN. In the above example, set the
gateway to 10.1.1.1. If the management station is on a remote
network, then set the gateway to be the address of an upstream
router on the IPS management VLAN.
Note These settings are written to the IPS application
configuration, not the ASA configuration. You can view
these settings from the ASA using the show module
details command.
You can alternatively use the IPS application setup
command to configure this setting from the IPS CLI.
Step 6 hw-module module 1 allow-ip ip_address
netmask
Example:
hostname# hw-module module 1 allow-ip
10.1.1.30 255.255.255.0
Sets the hosts that are allowed to access the management IP
address.
Note These settings are written to the IPS application
configuration, not the ASA configuration. You can view
these settings from the ASA using the show module
details command.
You can alternatively use the IPS application setup
command to configure this setting from the IPS CLI.
Command Purpose
58-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
(ASA 5512-X through ASA 5555-X) Installing the Software Module
Your ASA typically ships with IPS module software present on Disk0. If the module is not running,
however, you need to install the module.
Detailed Steps
Step 1 To view the IPS module software filename in flash memory, enter:.
hostname# dir disk0:
For example, look for a filename like IPS-SSP_5512-K9-sys-1.1-a-7.1-4-E4.aip. Note the filename; you
will need this filename later in the procedure.
Step 2 If you need to copy a new image to disk0, download the image from Cisco.com to a TFTP server, and
then enter:
hostname# copy tftp://server/file_path disk0:/file_path
For other server types, see the Downloading a File to a Specific Location section on page 81-3.
Step 3 To identify the IPS module software location in disk0, enter the following command:
hostname# sw-module module ips recover configure image disk0:file_path
For example, using the filename in the example in Step 1, enter:
hostname# sw-module module ips recover configure image
disk0:IPS-SSP_5512-K9-sys-1.1-a-7.1-4-E4.aip
Step 4 To install and load the IPS module software, enter the following command:
hostname# sw-module module ips recover boot
Step 5 To check the progress of the image transfer and module restart process, enter the following command:
hostname# show module ips details
The Status field in the output indicates the operational status of the module. A module operating
normally shows a status of Up. While the ASA transfers an application image to the module, the Status
field in the output reads Recover. When the ASA completes the image transfer and restarts the module,
the newly transferred image is running.
Configuring the Security Policy on the ASA IPS module
This section describes how to configure the ASA IPS module application.
Detailed Steps
Step 1 Access the ASA IPS module CLI using one of the following methods:
Session from the ASA to the ASA IPS module. See the Sessioning to the Module from the ASA
section on page 58-9.
58-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
Connect to the IPS management interface using SSH. If you did not change it, the default
management IP address is 192.168.1.2. The default username is cisco, and the default password is
cisco. See the Information About Management Access section on page 58-4 for more information
about the management interface.
Step 2 Configure the IPS security policy according to the IPS documentation.
To access all documents related to IPS, go to:
http://www.cisco.com/en/US/products/hw/vpndevc/ps4077/products_documentation_roadmaps_list.ht
ml
Step 3 (ASA 5510 and higher) If you configure virtual sensors, you identify one of the sensors as the default.
If the ASA does not specify a virtual sensor name in its configuration, the default sensor is used.
Step 4 When you are done configuring the ASA IPS module, exit the IPS software by entering the following
command:
sensor# exit
If you sessioned to the ASA IPS module from the ASA, you return to the ASA prompt.
What to Do Next
For the ASA in multiple context mode, see the Assigning Virtual Sensors to a Security Context
(ASA 5510 and Higher) section on page 58-15.
For the ASA in single context mode, see the Diverting Traffic to the ASA IPS module section on
page 58-17.
Assigning Virtual Sensors to a Security Context (ASA 5510 and Higher)
If the ASA is in multiple context mode, then you can assign one or more IPS virtual sensors to each
context. Then, when you configure the context to send traffic to the ASA IPS module, you can specify a
sensor that is assigned to the context; you cannot specify a sensor that you did not assign to the context.
If you do not assign any sensors to a context, then the default sensor configured on the ASA IPS module
is used. You can assign the same sensor to multiple contexts.
Note You do not need to be in multiple context mode to use virtual sensors; you can be in single mode and use
different sensors for different traffic flows.
Prerequisites
For more information about configuring contexts, see the Configuring Multiple Contexts section on
page 5-14.
58-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
Detailed Steps
Command Purpose
Step 1 context name
Example:
hostname(config)# context admin
hostname(config-ctx)#
Identifies the context you want to configure. Enter this command in
the system execution space.
Step 2 allocate-ips sensor_name [mapped_name]
[default]
Example:
hostname(config-ctx)# allocate-ips
sensor1 highsec
Enter this command for each sensor you want to assign to the context.
The sensor _name argument is the sensor name configured on the
ASA IPS module. To view the sensors that are configured on the ASA
IPS module, enter allocate-ips ?. All available sensors are listed. You
can also enter the show ips command. In the system execution space,
the show ips command lists all available sensors; if you enter it in the
context, it shows the sensors you already assigned to the context. If
you specify a sensor name that does not yet exist on the ASA IPS
module, you get an error, but the allocate-ips command is entered as
is. Until you create a sensor of that name on the ASA IPS module, the
context assumes the sensor is down.
Use the mapped_name argument as an alias for the sensor name that
can be used within the context instead of the actual sensor name. If
you do not specify a mapped name, the sensor name is used within
the context. For security purposes, you might not want the context
administrator to know which sensors are being used by the context.
Or you might want to genericize the context configuration. For
example, if you want all contexts to use sensors called sensor1 and
sensor2, then you can map the highsec and lowsec sensors to
sensor1 and sensor2 in context A, but map the medsec and
lowsec sensors to sensor1 and sensor2 in context B.
The default keyword sets one sensor per context as the default
sensor; if the context configuration does not specify a sensor name,
the context uses this default sensor. You can only configure one
default sensor per context. If you want to change the default sensor,
enter the no allocate-ips sensor_name command to remove the
current default sensor before you allocate a new default sensor. If you
do not specify a sensor as the default, and the context configuration
does not include a sensor name, then traffic uses the default sensor as
specified on the ASA IPS module.
Step 3 changeto context context_name
Example:
hostname# changeto context customer1
hostname/customer1#
Changes to the context so you can configure the IPS security policy
as described in Diverting Traffic to the ASA IPS module section on
page 58-17.
58-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
Examples
The following example assigns sensor1 and sensor2 to context A, and sensor1 and sensor3 to context B.
Both contexts map the sensor names to ips1 and ips2. In context A, sensor1 is set as the default
sensor, but in context B, no default is set so the default that is configured on the ASA IPS module is used.
hostname(config-ctx)# context A
hostname(config-ctx)# allocate-interface gigabitethernet0/0.100 int1
hostname(config-ctx)# allocate-interface gigabitethernet0/0.102 int2
hostname(config-ctx)# allocate-interface gigabitethernet0/0.110-gigabitethernet0/0.115
int3-int8
hostname(config-ctx)# allocate-ips sensor1 ips1 default
hostname(config-ctx)# allocate-ips sensor2 ips2
hostname(config-ctx)# config-url ftp://user1:passw0rd@10.1.1.1/configlets/test.cfg
hostname(config-ctx)# member gold
hostname(config-ctx)# context sample
hostname(config-ctx)# allocate-interface gigabitethernet0/1.200 int1
hostname(config-ctx)# allocate-interface gigabitethernet0/1.212 int2
hostname(config-ctx)# allocate-interface gigabitethernet0/1.230-gigabitethernet0/1.235
int3-int8
hostname(config-ctx)# allocate-ips sensor1 ips1
hostname(config-ctx)# allocate-ips sensor3 ips2
hostname(config-ctx)# config-url ftp://user1:passw0rd@10.1.1.1/configlets/sample.cfg
hostname(config-ctx)# member silver
hostname(config-ctx)# changeto context A
...
What to Do Next
Change to each context to configure the IPS security policy as described in Diverting Traffic to the ASA
IPS module section on page 58-17.
Diverting Traffic to the ASA IPS module
This section identifies traffic to divert from the ASA to the ASA IPS module.
Prerequisites
In multiple context mode, perform these steps in each context execution space. To change to a context,
enter the changeto context context_name command.
58-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
Detailed Steps
Command Purpose
Step 1 class-map name
Example:
hostname(config)# class-map ips_class
Creates a class map to identify the traffic for which you want to
send to the ASA IPS module.
If you want to send multiple traffic classes to the ASA IPS
module, you can create multiple class maps for use in the security
policy.
Step 2 match parameter
Example:
hostname(config-cmap)# match access-list
ips_traffic
Specifies the traffic in the class map. See the Identifying Traffic
(Layer 3/4 Class Maps) section on page 32-12 for more
information.
Step 3 policy-map name
Example:
hostname(config)# policy-map ips_policy
Adds or edits a policy map that sets the actions to take with the
class map traffic.
Step 4 class name
Example:
hostname(config-pmap)# class ips_class
Identifies the class map you created in Step 1.
58-19
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuring the ASA IPS module
Step 5 ips {inline | promiscuous} {fail-close |
fail-open} [sensor {sensor_name |
mapped_name}]
Example:
hostname(config-pmap-c)# ips promiscuous
fail-close
Specifies that the traffic should be sent to the ASA IPS module.
The inline and promiscuous keywords control the operating
mode of the ASA IPS module. See the Operating Modes section
on page 58-2 for more details.
The fail-close keyword sets the ASA to block all traffic if the ASA
IPS module is unavailable.
The fail-open keyword sets the ASA to allow all traffic through,
uninspected, if the ASA IPS module is unavailable.
(ASA 5510 and higher) If you use virtual sensors, you can specify
a sensor name using the sensor sensor_name argument. To see
available sensor names, enter the ips {inline | promiscuous}
{fail-close | fail-open} sensor ? command. Available sensors are
listed. You can also use the show ips command. If you use
multiple context mode on the ASA, you can only specify sensors
that you assigned to the context (see the Assigning Virtual
Sensors to a Security Context (ASA 5510 and Higher) section on
page 58-15). Use the mapped_name if configured in the context.
If you do not specify a sensor name, then the traffic uses the
default sensor. In multiple context mode, you can specify a default
sensor for the context. In single mode or if you do not specify a
default sensor in multiple mode, the traffic uses the default sensor
that is set on the ASA IPS module. If you enter a name that does
not yet exist on the ASA IPS module, you get an error, and the
command is rejected.
Step 6 (Optional)
class name2
Example:
hostname(config-pmap)# class ips_class2
If you created multiple class maps for IPS traffic, you can specify
another class for the policy.
See the Feature Matching Within a Service Policy section on
page 32-3 for detailed information about how the order of classes
matters within a policy map. Traffic cannot match more than one
class map for the same action type; so if you want network A to
go to sensorA, but want all other traffic to go to sensorB, then you
need to enter the class command for network A before you enter
the class command for all traffic; otherwise all traffic (including
network A) will match the first class command, and will be sent
to sensorB.
Command Purpose
58-20
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Monitoring the ASA IPS module
Monitoring the ASA IPS module
To check the status of a module, enter one of the following commands:
Examples
The following is sample output from the show module details command, which provides additional
information for an ASA with an SSC installed:
hostname# show module 1 details
Getting details from the Service Module, please wait...
ASA 5500 Series Security Services Card-5
Hardware version: 0.1
Serial Number: JAB11370240
Firmware version: 1.0(14)3
Software version: 6.2(1)E2
MAC Address Range: 001d.45c2.e832 to 001d.45c2.e832
App. Name: IPS
App. Status: Up
App. Status Desc: Not Applicable
App. Version: 6.2(1)E2
Data plane Status: Up
Status: Up
Mgmt IP Addr: 209.165.201.29
Mgmt Network Mask: 255.255.224.0
Mgmt Gateway: 209.165.201.30
Mgmt Access List: 209.165.201.31/32
Step 7 (Optional)
ips {inline | promiscuous} {fail-close |
fail-open} [sensor {sensor_name |
mapped_name}]
Example:
hostname(config-pmap-c)# ips promiscuous
fail-close
Specifies that the second class of traffic should be sent to the ASA
IPS module.
Add as many classes as desired by repeating these steps.
Step 8 service-policy policymap_name {global |
interface interface_name}
Example:
hostname(config)# service-policy
tcp_bypass_policy outside
Activates the policy map on one or more interfaces. global applies
the policy map to all interfaces, and interface applies the policy
to one interface. Only one global policy is allowed. You can
override the global policy on an interface by applying a service
policy to that interface. You can only apply one policy map to
each interface.
Command Purpose
Command Purpose
show module
Displays the status.
show module {1 | ips} details
Displays additional status information. Specify 1 for a physical module
and ips for a software module.
show module {1 | ips} recover
Displays the network parameters for transferring an image to the module.
Specify 1 for a physical module and ips for a software module.
58-21
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Troubleshooting the ASA IPS module
209.165.202.158/32
209.165.200.254/24
Mgmt Vlan: 20
Troubleshooting the ASA IPS module
This section includes procedures that help you recover or troubleshoot the module and includes the
following topics:
Installing an Image on the Module, page 58-21
Uninstalling a Software Module Image, page 58-23
Resetting the Password, page 58-23
Reloading or Resetting the Module, page 58-24
Shutting Down the Module, page 58-24
Installing an Image on the Module
If the module suffers a failure, and the module application image cannot run, you can reinstall a new
image on the module from a TFTP server (for a physical module), or from the local disk (software
module).
Note Do not use the upgrade command within the module software to install the image.
Prerequisites
Physical moduleBe sure the TFTP server that you specify can transfer files up to 60 MB in size.
Note This process can take approximately 15 minutes to complete, depending on your network
and the size of the image.
Software moduleCopy the image to the ASA internal flash (disk0) before completing this
procedure.
Note Before you download the IPS software to disk0, make sure at least 50% of the flash memory
is free. When you install IPS, IPS reserves 50% of the internal flash memory for its file
system.
58-22
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Troubleshooting the ASA IPS module
Detailed Steps
Command Purpose
Step 1 For a physical module (for example, the ASA
5585-X):
hw-module module 1 recover configure
For a software module (for example, the ASA
5545-X):
sw-module module ips recover configure
image disk0:file_path
Example:
hostname# hw-module module 1 recover
configure
Image URL [tftp://127.0.0.1/myimage]:
tftp://10.1.1.1/ids-newimg
Port IP Address [127.0.0.2]: 10.1.2.10
Port Mask [255.255.255.254]: 255.255.255.0
Gateway IP Address [1.1.2.10]: 10.1.2.254
VLAN ID [0]: 100
Specifies the location of the new image.
For a physical moduleThis command prompts you for the URL
for the TFTP server, the management interface IP address and
netmask, gateway address, and VLAN ID (ASA 5505 only).
These network parameters are configured in ROMMON; the
network parameters you configured in the module application
configuration are not available to ROMMON, so you must set
them separately here.
For a software moduleSpecify the location of the image on the
local disk.
You can view the recovery configuration using the show module
{1 | ips} recover command.
In multiple context mode, enter this command in the system
execution space.
Step 2 For a physical module:
hw-module module 1 recover boot
For a software module:
sw-module module ips recover boot
Example:
hostname# hw-module module 1 recover boot
Installs and loads the IPS module software.
Step 3 For a physical module:
show module 1 details
For a software module:
show module ips details
Example:
hostname# show module 1 details
Checks the progress of the image transfer and module restart
process.
The Status field in the output indicates the operational status of
the module. A module operating normally shows a status of Up.
While the ASA transfers an application image to the module, the
Status field in the output reads Recover. When the ASA
completes the image transfer and restarts the module, the newly
transferred image is running.
58-23
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Troubleshooting the ASA IPS module
Uninstalling a Software Module Image
To uninstall a software module image and associated configuration, perform the following steps.
Detailed Steps
Resetting the Password
You can reset the module password to the default. The default password is cisco. After resetting the
password, you should change it to a unique value using the module application.
Resetting the module password causes the module to reboot. Services are not available while the module
is rebooting.
To reset the module password to the default of cisco, perform the following steps.
Detailed Steps
Command Purpose
sw-module module ips uninstall
Example:
hostname# sw-module module ips uninstall
Module ips will be uninstalled. This will
completely remove the
disk image associated with the sw-module including
any configuration
that existed within it.
Uninstall module <id>? [confirm]
Permanently uninstalls the software module image and associated
configuration.
Command Purpose
For a physical module (for example, the ASA 5585-X):
hw-module module 1 password-reset
For a software module (for example, the ASA 5545-X):
sw-module module ips password-reset
Example:
hostname# hw-module module 1 password-reset
Resets the module password to cisco.
58-24
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Troubleshooting the ASA IPS module
Reloading or Resetting the Module
To reload or reset the module, enter one of the following commands at the ASA CLI.
Detailed Steps
Shutting Down the Module
If you restart the ASA, the module is not automatically restarted. To shut down the module, perform the
following steps at the ASA CLI.
Detailed Steps
Command Purpose
For a physical module (for example, the ASA
5585-X):
hw-module module 1 reload
For a software module (for example, the ASA
5545-X):
sw-module module ips reload
Example:
hostname# hw-module module 1 reload
Reloads the module software.
For a physical module:
hw-module module 1 reset
For a software module:
sw-module module ips reset
Example:
hostname# hw-module module 1 reset
Performs a reset, and then reloads the module.
Command Purpose
For a physical module (for example, the ASA
5585-X):
hw-module module 1 shutdown
For a software module (for example, the ASA
5545-X):
sw-module module ips shutdown
Example:
hostname# hw-module module 1 shutdown
Shuts down the module.
58-25
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Configuration Examples for the ASA IPS module
Configuration Examples for the ASA IPS module
The following example diverts all IP traffic to the ASA IPS module in promiscuous mode, and blocks
all IP traffic if the ASA IPS module card fails for any reason:
hostname(config)# access-list IPS permit ip any any
hostname(config)# class-map my-ips-class
hostname(config-cmap)# match access-list IPS
hostname(config-cmap)# policy-map my-ips-policy
hostname(config-pmap)# class my-ips-class
hostname(config-pmap-c)# ips promiscuous fail-close
hostname(config-pmap-c)# service-policy my-ips-policy global
The following example diverts all IP traffic destined for the 10.1.1.0 network and the 10.2.1.0 network
to the AIP SSM in inline mode, and allows all traffic through if the AIP SSM fails for any reason. For
the my-ips-class traffic, sensor1 is used; for the my-ips-class2 traffic, sensor2 is used.
hostname(config)# access-list my-ips-acl permit ip any 10.1.1.0 255.255.255.0
hostname(config)# access-list my-ips-acl2 permit ip any 10.2.1.0 255.255.255.0
hostname(config)# class-map my-ips-class
hostname(config-cmap)# match access-list my-ips-acl
hostname(config)# class-map my-ips-class2
hostname(config-cmap)# match access-list my-ips-acl2
hostname(config-cmap)# policy-map my-ips-policy
hostname(config-pmap)# class my-ips-class
hostname(config-pmap-c)# ips inline fail-open sensor sensor1
hostname(config-pmap)# class my-ips-class2
hostname(config-pmap-c)# ips inline fail-open sensor sensor2
hostname(config-pmap-c)# service-policy my-ips-policy interface outside
Feature History for the ASA IPS module
Table 58-2 lists each feature change and the platform release in which it was implemented.
Table 58-2 Feature History for the ASA IPS module
Feature Name
Platform
Releases Feature Information
AIP SSM 7.0(1) We introduced support for the AIP SSM for the ASA 5510,
5520, and 5540.
The following command was introduced: ips.
Virtual sensors (ASA 5510 and higher) 8.0(2) Virtual sensor support was introduced. Virtual sensors let
you configure multiple security policies on the ASA IPS
module.
The following command was introduced: allocate-ips.
58-26
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 58 Configuring the ASA IPS Module
Feature History for the ASA IPS module
AIP SSC for the ASA 5505 8.2(1) We introduced support for the AIP SSC for the ASA 5505.
The following commands were introduced:
allow-ssc-mgmt, hw-module module ip, and hw-module
module allow-ip.
Support for the ASA IPS SSP-10, -20, -40, and
-60 for the ASA 5585-X
8.2(5)/
8.4(2)
We introduced support for the ASA IPS SSP-10, -20, -40,
and -60 for the ASA 5585-X. You can only install the ASA
IPS SSP with a matching-level SSP; for example, SSP-10
and ASA IPS SSP-10.
Note The ASA 5585-X is not supported in Version 8.3.
Support for Dual SSPs for SSP-40 and SSP-60 8.4(2) For SSP-40 and SSP-60, you can use two SSPs of the same
level in the same chassis. Mixed-level SSPs are not
supported (for example, an SSP-40 with an SSP-60 is not
supported). Each SSP acts as an independent device, with
separate configurations and management. You can use the
two SSPs as a failover pair if desired.
Note When using two SSPs in the chassis, VPN is not
supported; note, however, that VPN has not been
disabled.
We modified the following commands: show module, show
inventory, show environment.
Support for the ASA IPS SSP for the ASA
5512-X through ASA 5555-X
8.6(1) We introduced support for the ASA IPS SSP software
module for the ASA 5512-X, ASA 5515-X, ASA 5525-X,
ASA 5545-X, and ASA 5555-X.
We introduced or modified the following commands:
session, show module, sw-module.
Table 58-2 Feature History for the ASA IPS module (continued)
Feature Name
Platform
Releases Feature Information
C H A P T E R
59-1
Cisco ASA 5500 Series Configuration Guide using the CLI
59
Configuring the ASA CX Module
This chapter describes how to configure the ASA CX module that runs on the ASA. This chapter includes
the following sections:
Information About the ASA CX Module, page 59-1
Licensing Requirements for the ASA CX Module, page 59-4
Guidelines and Limitations, page 59-4
Default Settings, page 59-5
Configuring the ASA CX Module, page 59-5
Monitoring the ASA CX Module, page 59-12
Troubleshooting the ASA CX Module, page 59-17
Configuration Examples for the ASA CX Module, page 59-21
Feature History for the ASA CX Module, page 59-22
Information About the ASA CX Module
The ASA CX module lets you enforce security based on the complete context of a situation. This context
includes the identity of the user (who), the application or website that the user is trying to access (what),
the origin of the access attempt (where), the time of the attempted access (when), and the properties of
the device used for the access (how). With the ASA CX module, you can extract the full context of a
flow and enforce granular policies such as permitting access to Facebook but denying access to games
on Facebook or permitting finance employees access to a sensitive enterprise database but denying the
same to other employees.
This section includes the following topics:
How the ASA CX Module Works with the ASA, page 59-2
Information About ASA CX Management, page 59-2
Information About Authentication Proxy, page 59-3
Information About VPN and the ASA CX Module, page 59-4
Compatibility with ASA Features, page 59-4
59-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Information About the ASA CX Module
How the ASA CX Module Works with the ASA
The ASA CX module runs a separate application from the ASA. The ASA CX module includes external
management interface(s) so you can connect to the ASA CX module directly. Any data interfaces on the
ASA CX module are used for ASA traffic only.
Traffic goes through the firewall checks before being forwarded to the ASA CX module. When you
identify traffic for ASA CX inspection on the ASA, traffic flows through the ASA and the ASA CX
module as follows:
1. Traffic enters the ASA.
2. Incoming VPN traffic is decrypted.
3. Firewall policies are applied.
4. Traffic is sent to the ASA CX module.
5. The ASA CX module applies its security policy to the traffic, and takes appropriate actions.
6. Valid traffic is sent back to the ASA; the ASA CX module might block some traffic according to its
security policy, and that traffic is not passed on.
7. Outgoing VPN traffic is encrypted.
8. Traffic exits the ASA.
Figure 59-1 shows the traffic flow when using the ASA CX module. In this example, the ASA CX
module automatically blocks traffic that is not allowed for a certain application. All other traffic is
forwarded through the ASA.
Figure 59-1 ASA CX Module Traffic Flow in the ASA
Note If you have a connection between hosts on two ASA interfaces, and the ASA CX service policy is only
configured for one of the interfaces, then all traffic between these hosts is sent to the ASA CX module,
including traffic orginiating on the non-ASA CX interface (the feature is bidirectional). However, the
ASA only performs the authentication proxy on the interface to which the service policy is applied,
because this feature is ingress-only.
Information About ASA CX Management
Initial Configuration, page 59-3
ASA
Main System
ASA CX
Diverted Traffic
ASA CX inspection
VPN
Decryption
Firewall
Policy
Block
inside
outside
3
3
3
4
7
0
59-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Information About the ASA CX Module
Policy Configuration and Management, page 59-3
Initial Configuration
For initial configuration, you must use the CLI on the ASA CX module to run the setup command and
configure other optional settings.
To access the CLI, you can use the following methods:
ASA CX console port.
ASA CX Management 1/0 interface using SSHYou can connect to the default IP address
(192.168.8.8.), or you can use ASDM to change the management IP address and then connect using
SSH.
Note You cannot access the ASA CX module CLI over the ASA backplane using the session command.
Policy Configuration and Management
After you perform initial configuration, configure the ASA CX policy using Cisco Prime Security
Manager (PRSM). Then configure the ASA policy for sending traffic to the ASA CX module using
ASDM or the ASA CLI.
Note When using PRSM in multiple device mode, you can configure the ASA policy for sending traffic to the
ASA CX module within PRSM, instead of using ASDM or the ASA CLI. Using PRSM lets you
consolodate management to a single management system. However, PRSM has some limitations when
configuring the ASA service policy; see the ASA CX user guide for more information.
Information About Authentication Proxy
When the ASA CX needs to authenticate an HTTP user (to take advantage of identity policies), you must
configure the ASA to act as an authentication proxy: the ASA CX module redirects authentication
requests to the ASA interface IP address/proxy port. By default, the port is 885 (user configurable).
Configure this feature as part of the service policy to divert traffic from the ASA to the ASA CX module.
If you do not enable the authentication proxy, only passive authentication is available.
Note If you have a connection between hosts on two ASA interfaces, and the ASA CX service policy is only
configured for one of the interfaces, then all traffic between these hosts is sent to the ASA CX module,
including traffic orginiating on the non-ASA CX interface (the feature is bidirectional). However, the
ASA only performs the authentication proxy on the interface to which the service policy is applied,
because this feature is ingress-only.
59-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Licensing Requirements for the ASA CX Module
Information About VPN and the ASA CX Module
The ASA includes VPN client and user authentication metadata when forwarding traffic to the ASA CX
module, which allows the ASA CX module to include this information as part of its policy lookup
criteria. The VPN metadata is sent only at VPN tunnel establishment time along with a type-length-value
(TLV) containing the session ID. The ASA CX module caches the VPN metadata for each session. Each
tunneled connection sends the session ID so the ASA CX module can look up that sessions metadata.
Compatibility with ASA Features
The ASA includes many advanced application inspection features, including HTTP inspection.
However, the ASA CX module provides more advanced HTTP inspection than the ASA provides, as well
as additional features for other applications, including monitoring and controlling application usage.
To take full advantage of the ASA CX module features, see the following guidelines for traffic that you
send to the ASA CX module:
Do not configure ASA inspection on HTTP traffic.
Other application inspections on the ASA are compatible with the ASA CX module, including the
default inspections.
Do not enable the Mobile User Security (MUS) server; it is not compatible with the ASA CX
module.
If you enable failover, when the ASA fails over, any existing ASA CX flows are transferred to the
new ASA, but the traffic is allowed through the ASA without being acted upon by the ASA CX
module. Only new flows recieved by the new ASA are acted upon by the ASA CX module.
Licensing Requirements for the ASA CX Module
The following table shows the licensing requirements for this feature:
The ASA CX module and PRSM require additional licenses. See the ASA CX documentation for more
information.
Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
Supported in single context mode only. Does not support multiple context mode.
Firewall Mode Guidelines
Supported in routed and transparent firewall mode.
Model License Requirement
All models Base License.
59-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Default Settings
Failover Guidelines
Does not support failover directly; when the ASA fails over, any existing ASA CX flows are transferred
to the new ASA, but the traffic is allowed through the ASA without being inspected by the ASA CX.
IPv6 Guidelines
Supports IPv6.
Model Guidelines
Supported only on the ASA 5585-X. See the Cisco ASA Compatibility Matrix for more information:
http://www.cisco.com/en/US/docs/security/asa/compatibility/asamatrx.html
Additional Guidelines and Limitations
See the Compatibility with ASA Features section on page 59-4.
You cannot change the software type installed on the module; if you purchase an ASA CX module,
you cannot later install other software on it.
Default Settings
Table 59-1 lists the default settings for the ASA CX module.
Configuring the ASA CX Module
This section describes how to configure the ASA CX module and includes the following topics:
Task Flow for the ASA CX Module, page 59-6
Connecting Management Interface Cables, page 59-6
Configuring the ASA CX Management IP Address, page 59-7
Configuring Basic ASA CX Settings at the ASA CX CLI, page 59-7
Configuring the Security Policy on the ASA CX Module Using PRSM, page 59-9
Redirecting Traffic to the ASA CX Module, page 59-11
Table 59-1 Default Network Parameters
Parameters Default
Management 1/0 IP address 192.168.8.8/24
Gateway 192.168.8.1/24
SSH Username admin
Password Admin123
59-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Configuring the ASA CX Module
Task Flow for the ASA CX Module
Configuring the ASA CX module is a process that includes configuration of the ASA CX security policy
on the ASA CX module and then configuration of the ASA to send traffic to the ASA CX module. To
configure the ASA CX module, perform the following steps:
Step 1 Cable the ASA and ASA CX management interfaces and optionally, the console interface. See the
Connecting Management Interface Cables section on page 59-6.
Step 2 (Optional) On the ASA, configure the ASA CX module management IP address for initial SSH access.
See the Configuring the ASA CX Management IP Address section on page 59-7.
Step 3 On the ASA CX module, configure basic settings. See the Configuring Basic ASA CX Settings at the
ASA CX CLI section on page 59-7.
Step 4 On the ASA CX module, configure the security policy using PRSM. See the Configuring the Security
Policy on the ASA CX Module Using PRSM section on page 59-9.
Step 5 (Optional) On the ASA, configure the authentication proxy port. See the (Optional) Configuring the
Authentication Proxy Port section on page 59-10.
Step 6 On the ASA, identify traffic to divert to the ASA CX module. See the Redirecting Traffic to the ASA
CX Module section on page 59-11.
Note When using PRSM in multiple device mode, you can configure the ASA policy for sending
traffic to the ASA CX module within PRSM, instead of using ASDM or the ASA CLI. However,
PRSM has some limitations when configuring the ASA service policy; see the ASA CX user
guide for more information.
Connecting Management Interface Cables
Connect the management PC to the ASA and the ASA CX module management interfaces, as well as to
the ASA CX console port.
Guidelines
For initial setup, you can connect with SSH to the ASA CX Management 1/0 interface using the default
IP address (192.168.8.8/24). If you cannot use the default IP address, you can either use the console port
or use ASDM to change the management IP address so you can use SSH.
Detailed Steps
Connect to the ASA Management 0/0 interface and the ASA CX Management 1/0 interface.
59-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Configuring the ASA CX Module
What to Do Next
(Optional) Configure the ASA CX management IP address. See the Configuring the ASA CX
Management IP Address section on page 59-7.
Configure basic ASA CX settings. See the Configuring Basic ASA CX Settings at the ASA CX
CLI section on page 59-7.
Configuring the ASA CX Management IP Address
If you cannot use the default management IP address (192.168.8.8), then you can set the management IP
address from the ASA. After you set the management IP address, you can access the ASA CX module
using SSH to perform initial setup.
Detailed Steps
Configuring Basic ASA CX Settings at the ASA CX CLI
You must configure basic network settings and other parameters on the ASA CX module before you can
configure your security policy.
ASA 5585-X
Switch
PWR
BOOT
ALARM
ACT
VPN
PS1
HDD1
PS0
HDD0
USB
RESET
0 SFP1 SFP0 1 0 1 2 3 4 5 6 7 MGMT
0
1
AUX CONSOLE
PWR
BOOT
ALARM
ACT
VPN
PS1
HDD1
PS0
HDD0
USB
RESET
0 SFP1 SFP0 1 0 1 2 3 4 5 6 7 MGMT
0
1
AUX CONSOLE
PC (IP Address
from DHCP)
ASA Management 0/0
ASA CX
Management 1/0
ASA CX
Console
SSP
ASA CX SSP
3
3
3
4
6
9
Command Purpose
session 1 do setup host ip
ip_address/mask,gateway_ip
Example:
hostname# session 1 do setup host ip
10.1.1.2/24,10.1.1.1
Sets the ASA CX management IP address, mask, and gateway.
59-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Configuring the ASA CX Module
Detailed Steps
Step 1 Connect to the ASA CX CLI:
Using SSH to the ASA CX Management 1/0 interfaceLog in with the username admin and the
password Admin123. You will change the password as part of this procedure.
Using the ASA CX console port.
Step 2 Enter the following command:
asacx> setup
Example:
asacx> setup
Welcome to Cisco Prime Security Manager Setup
[hit Ctrl-C to abort]
Default values are inside [ ]
You are prompted through the setup wizard. The following example shows a typical path through the
wizard; if you enter Y instead of N at a prompt, you will be able to configure some additional settings.
This example shows how to configure both IPv4 and IPv6 static addresses. You can configure IPv6
stateless auto configuration by answering N when asked if you want to configure a static IPv6 address.
Enter a hostname [asacx]: asa-cx-host
Do you want to configure IPv4 address on management interface?(y/n) [Y]: Y
Do you want to enable DHCP for IPv4 address assignment on management interface?(y/n)[N]: N
Enter an IPv4 address [192.168.8.8]: 10.89.31.65
Enter the netmask [255.255.255.0]: 255.255.255.0
Enter the gateway [192.168.8.1]: 10.89.31.1
Do you want to configure static IPv6 address on management interface?(y/n) [N]: Y
Enter an IPv6 address: 2001:DB8:0:CD30::1234/64
Enter the gateway: 2001:DB8:0:CD30::1
Enter the primary DNS server IP address [ ]: 10.89.47.11
Do you want to configure Secondary DNS Server? (y/n) [N]: N
Do you want to configure Local Domain Name? (y/n) [N] Y
Enter the local domain name: example.com
Do you want to configure Search domains? (y/n) [N] Y
Enter the comma separated list for search domains: example.com
Do you want to enable the NTP service?(y/n) [N]: Y
Enter the NTP servers separated by commas: 1.ntp.example.com, 2.ntp.example.com
Step 3 After you complete the final prompt, you are presented with a summary of the settings. Look over the
summary to verify that the values are correct, and enter Y to apply your changed configuration. Enter N
to cancel your changes.
Example:
Apply the changes?(y,n) [Y]: Y
Configuration saved successfully!
Applying...
Done.
Generating self-signed certificate, the web server will be restarted after that
...
Done.
Press ENTER to continue...
asacx>
59-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Configuring the ASA CX Module
Note If you change the host name, the prompt does not show the new name until you log out and log
back in.
Step 4 If you do not use NTP, configure the time settings. The default time zone is the UTC time zone. Use the
show time command to see the current settings. You can use the following commands to change time
settings:
asacx> config timezone
asacx> config time
Step 5 Change the admin password by entering the following command:
asacx> config passwd
Example:
asacx> config passwd
The password must be at least 8 characters long and must contain
at least one uppercase letter (A-Z), at least one lowercase letter
(a-z) and at least one digit (0-9).
Enter password: Farscape1
Confirm password: Farscape1
SUCCESS: Password changed for user admin
Step 6 Enter the exit command to log out.
Configuring the Security Policy on the ASA CX Module Using PRSM
This section describes how to launch PRSM to configure the ASA CX module application. For details
on using PRSM to configure your ASA CX security policy, see the ASA CX user guide.
Detailed Steps
You can launch PRSM from your web browser, or you can launch it from ASDM.
Launch PRSM from a web browser by enter the following URL:
https://ASA_CX_management_IP
Where the ASA CX management IP address is the one you set in the Configuring Basic ASA CX
Settings at the ASA CX CLI section on page 59-7.
Launch PRSM from ASDM by choosing Home > ASA CX Status, and clicking the Connect to the
ASA CX application link.
59-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Configuring the ASA CX Module
What to Do Next
(Optional) Configure the authentication proxy port. See the (Optional) Configuring the
Authentication Proxy Port section on page 59-10.
Divert traffic to the ASA CX module. See the Redirecting Traffic to the ASA CX Module section
on page 59-11.
(Optional) Configuring the Authentication Proxy Port
The default authentication port is 885. To change the authentication proxy port, perform the following
steps. For more information about the authentication proxy, see the Information About Authentication
Proxy section on page 59-3.
Note You can also set the port as part of the ASDM startup wizard. See the Configuring Basic ASA CX
Settings at the ASA CX CLI section on page 59-7.
Detailed Steps
Command Purpose
cxsc auth-proxy port port
Example:
hostname(config)# cxsc auth-proxy port 5000
Sets the authentication proxy port greater than 1024. The default
is 885.
59-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Configuring the ASA CX Module
Redirecting Traffic to the ASA CX Module
This section identifies traffic to redirect from the ASA to the ASA CX module. Configure this policy on
the ASA.
Note When using PRSM in multiple device mode, you can configure the ASA policy for sending traffic to the
ASA CX module within PRSM, instead of using ASDM or the ASA CLI. However, PRSM has some
limitations when configuring the ASA service policy; see the ASA CX user guide for more information.
Prerequisites
If you enable the authentication proxy on the ASA using this procedure, be sure to also configure a
directory realm for authentication on the ASA CX module. See the ASA CX user guide for more
information.
Detailed Steps
Command Purpose
Step 1 class-map name
Example:
hostname(config)# class-map cx_class
Creates a class map to identify the traffic for which you want to
send to the ASA CX module.
If you want to send multiple traffic classes to the ASA CX
module, you can create multiple class maps for use in the security
policy.
Step 2 match parameter
Example:
hostname(config-cmap)# match access-list
cx_traffic
Specifies the traffic in the class map. See the Identifying Traffic
(Layer 3/4 Class Maps) section on page 32-12 for more
information.
Step 3 policy-map name
Example:
hostname(config)# policy-map cx_policy
Adds or edits a policy map that sets the actions to take with the
class map traffic.
Step 4 class name
Example:
hostname(config-pmap)# class cx_class
Identifies the class map you created in Step 1.
Step 5 cxsc {fail-close | fail-open} [auth-proxy]
Example:
hostname(config-pmap-c)# cxsc fail-close
auth-proxy
Specifies that the traffic should be sent to the ASA CX module.
The fail-close keyword sets the ASA to block all traffic if the ASA
CX module is unavailable.
The fail-open keyword sets the ASA to allow all traffic through,
uninspected, if the ASA CX module is unavailable.
The auth-proxy keyword enables the authentication proxy, which
is required for active authentication.
59-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Monitoring the ASA CX Module
Monitoring the ASA CX Module
Showing Module Status, page 59-12
Showing Module Statistics, page 59-13
Monitoring Module Connections, page 59-14
Capturing Module Traffic, page 59-17
Debugging the Module, page 59-19
Note For ASA CX-related syslog messages, see the syslog message guide. ASA CX syslog messages start
with message number 429001.
Showing Module Status
To check the status of a module, enter one of the following commands:
Step 6 (Optional)
class name2
Example:
hostname(config-pmap)# class cx_class2
If you created multiple class maps for ASA CX traffic, you can
specify another class for the policy.
See the Feature Matching Within a Service Policy section on
page 32-3 for detailed information about how the order of classes
matters within a policy map. Traffic cannot match more than one
class map for the same action type.
Step 7 (Optional)
cxsc {fail-close | fail-open} [auth-proxy]
Example:
hostname(config-pmap-c)# cxsc fail-close
auth-proxy
Specifies that the second class of traffic should be sent to the ASA
CX module.
Add as many classes as desired by repeating these steps.
Step 8 service-policy policymap_name {global |
interface interface_name}
Example:
hostname(config)# service-policy cx_policy
interface outside
Activates the policy map on one or more interfaces. global applies
the policy map to all interfaces, and interface applies the policy
to one interface. Only one global policy is allowed. You can
override the global policy on an interface by applying a service
policy to that interface. You can only apply one policy map to
each interface.
Command Purpose
Command Purpose
show module
Displays the status.
show module 1 details
Displays additional status information.
59-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Monitoring the ASA CX Module
Examples
The following is sample output from the show module command for an ASA with an ASA CX SSP
installed:
hostname# show module
Mod Card Type Model Serial No.
--- -------------------------------------------- ------------------ -----------
0 ASA 5585-X Security Services Processor-10 wi ASA5585-SSP-10 JAF1507AMKE
1 ASA 5585-X CX Security Services Processor-10 ASA5585-SSP-CX10 JAF1510BLSA
Mod MAC Address Range Hw Version Fw Version Sw Version
--- --------------------------------- ------------ ------------ ---------------
0 5475.d05b.1100 to 5475.d05b.110b 1.0 2.0(7)0 100.7(6)78
1 5475.d05b.2450 to 5475.d05b.245b 1.0 2.0(13)0 0.6.1
Mod SSM Application Name Status SSM Application Version
--- ------------------------------ ---------------- --------------------------
1 ASA CX Security Module Up 0.6.1
Mod Status Data Plane Status Compatibility
--- ------------------ --------------------- -------------
0 Up Sys Not Applicable
1 Up Up
Showing Module Statistics
To show module statistics, enter the following command:
Examples
The following is sample output from the show service-policy command showing the ASA CX policy
and the current statistics as well as the module status when the authentication proxy is disabled:
hostname# show service-policy cxsc
Global policy:
Service-policy: global_policy
Class-map: bypass
CXSC: card status Up, mode fail-open, auth-proxy disabled
packet input 2626422041, packet output 2626877967, drop 0, reset-drop 0, proxied 0
The following is sample output from the show service-policy command showing the ASA CX policy
and the current statistics as well as the module status when the authentication proxy is enabled; in this
case, the proxied counters also increment:
hostname# show service-policy cxsc
Global policy:
Service-policy: pmap
Class-map: class-default
Default Queueing Set connection policy: random-sequence-number disable
drop 0
CXSC: card status Up, mode fail-open, auth-proxy enabled
packet input 7724, packet output 7701, drop 0, reset-drop 0, proxied 10
Command Purpose
show service-policy cxsc
Displays the ASA CX statistics and status per service policy.
59-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Monitoring the ASA CX Module
Monitoring Module Connections
To show connections through the ASA CX module, enter the one of the following commands:
Examples
The following is sample output from the show asp table classify domain cxsc command:
hostname# show asp table classify domain cxsc
Input Table
Command Purpose
show asp table classify domain cxsc
Shows the NP rules created to send traffic to the ASA CX module.
show asp table classify domain
cxsc-auth-proxy
Shows the NP rules created for the authentication proxy for the ASA CX
module.
show asp drop
Shows dropped packets. The following drop types are used:
Frame Drops:
cxsc-bad-tlv-receivedThis occurs when ASA receives a packet
from CXSC without a Policy ID TLV. This TLV must be present in
non-control packets if it does not have the Standy Active bit set in the
actions field.
cxsc-requestThe frame was requested to be dropped by CXSC due
a policy on CXSC whereby CXSC would set the actions to Deny
Source, Deny Destination, or Deny Pkt.
cxsc-fail-closeThe packet is dropped because the card is not up and
the policy configured was 'fail-close' (rather than 'fail-open' which
allows packets through even if the card was down).
cxsc-failThe CXSC configuration was removed for an existing
flow and we are not able to process it through CXSC it will be
dropped. This should be very unlikely.
cxsc-malformed-packetThe packet from CXSC contains an invalid
header. For instance, the header length may not be correct.
Flow Drops:
cxsc-requestThe CXSC requested to terminate the flow. The
actions bit 0 is set.
reset-by-cxscThe CXSC requested to terminate and reset the flow.
The actions bit 1 is set.
cxsc-fail-closeThe flow was terminated because the card is down
and the configured policy was 'fail-close'.
show asp event dp-cp cxsc-msg
This output shows how many ASA CX module messages are on the dp-cp
queue. Currently, only VPN queries from the ASA CX module are sent to
dp-cp.
show conn
This command already shows if a connection is being forwarded to an
module by displaying the X - inspected by service module flag.
Connections being forwarded to the ASA CX module will also display the
X flag.
59-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Monitoring the ASA CX Module
in id=0x7ffedb4acf40, priority=50, domain=cxsc, deny=false
hits=15485658, user_data=0x7ffedb4ac840, cs_id=0x0, use_real_addr, flags=0x0,
protocol=0
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=0.0.0.0, mask=0.0.0.0, port=0, dscp=0x0
input_ifc=outside, output_ifc=any
in id=0x7ffedb4ad4a0, priority=50, domain=cxsc, deny=false
hits=992053, user_data=0x7ffedb4ac840, cs_id=0x0, use_real_addr, flags=0x0, protocol=0
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=0.0.0.0, mask=0.0.0.0, port=0, dscp=0x0
input_ifc=inside, output_ifc=any
in id=0x7ffedb4ada00, priority=50, domain=cxsc, deny=false
hits=0, user_data=0x7ffedb4ac840, cs_id=0x0, use_real_addr, flags=0x0, protocol=0
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=0.0.0.0, mask=0.0.0.0, port=0, dscp=0x0
input_ifc=m, output_ifc=any
Output Table:
L2 - Output Table:
L2 - Input Table:
Last clearing of hits counters: Never
The following is sample output from the show asp table classify domain cxsc-auth-proxy command.
For the first rule in the output below, the destination port=2000 is the auth-proxy port configured by
the cxsc auth-proxy port 2000 command, and the destination ip/id=192.168.0.100 is the ASA
interface IP address.
hostname# show asp table classify domain cxsc-auth-proxy
Input Table
in id=0x7ffed86cc470, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=192.168.0.100, mask=255.255.255.255, port=2000, dscp=0x0
input_ifc=inside, output_ifc=identity
in id=0x7ffed86cce20, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=2.2.2.2, mask=255.255.255.255, port=2000, dscp=0x0
input_ifc=new2, output_ifc=identity
in id=0x7ffed86cd7d0, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=172.23.58.52, mask=255.255.255.255, port=2000, dscp=0x0
input_ifc=mgmt, output_ifc=identity
in id=0x7ffed86caa80, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=192.168.5.172, mask=255.255.255.255, port=2000, dscp=0x0
input_ifc=outside, output_ifc=identity
in id=0x7ffed86cb3c0, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=::/0, port=0
dst ip/id=fe80::5675:d0ff:fe5b:1102/128, port=2000
input_ifc=outside, output_ifc=identity
in id=0x7ffed742be10, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
src ip/id=::/0, port=0
dst ip/id=1:1:1:1::10/128, port=2000
input_ifc=outside, output_ifc=identity
59-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Monitoring the ASA CX Module
Output Table:
L2 - Output Table:
L2 - Input Table:
Last clearing of hits counters: Never
The following is sample output from the show asp drop command. This output is just an example and
lists all the possible reasons for a dropped frame or flow from the ASA CX module:
hostname# show asp drop
Frame drop:
CXSC Module received packet with bad TLV's (cxsc-bad-tlv-received) 2
CXSC Module requested drop (cxsc-request) 1
CXSC card is down (cxsc-fail-close) 1
CXSC config removed for flow (cxsc-fail) 3
CXSC Module received malformed packet (cxsc-malformed-packet) 1
Last clearing: 18:12:58 UTC May 11 2012 by enable_15
Flow drop:
Flow terminated by CXSC (cxsc-request) 2
Flow reset by CXSC (reset-by-cxsc) 1
CXSC fail-close (cxsc-fail-close) 1
Last clearing: 18:12:58 UTC May 11 2012 by enable_15
The following is sample output from the show asp event dp-cp cxsc-msg command:
hostname# show asp event dp-cp cxsc-msg
DP-CP EVENT QUEUE QUEUE-LEN HIGH-WATER
Punt Event Queue 0 5
Identity-Traffic Event Queue 0 0
General Event Queue 0 4
Syslog Event Queue 4 90
Non-Blocking Event Queue 0 2
Midpath High Event Queue 0 53
Midpath Norm Event Queue 8074 8288
SRTP Event Queue 0 0
HA Event Queue 0 0
Threat-Detection Event Queue 0 3
ARP Event Queue 0 2048
IDFW Event Queue 0 0
CXSC Event Queue 0 1
EVENT-TYPE ALLOC ALLOC-FAIL ENQUEUED ENQ-FAIL RETIRED 15SEC-RATE
cxsc-msg 1 0 1 0 1 0
The following is sample output from the show conn detail command:
hostname# show conn detail
0 in use, 105 most used
Flags: A - awaiting inside ACK to SYN, a - awaiting outside ACK to SYN,
B - initial SYN from outside, b - TCP state-bypass or nailed, C - CTIQBE media,
D - DNS, d - dump, E - outside back connection, F - outside FIN, f - inside FIN,
G - group, g - MGCP, H - H.323, h - H.225.0, I - inbound data,
i - incomplete, J - GTP, j - GTP data, K - GTP t3-response
k - Skinny media, M - SMTP data, m - SIP media, n - GUP
O - outbound data, P - inside back connection, p - Phone-proxy TFTP connection,
q - SQL*Net data, R - outside acknowledged FIN,
R - UDP SUNRPC, r - inside acknowledged FIN, S - awaiting inside SYN,
s - awaiting outside SYN, T - SIP, t - SIP transient, U - up,
V - VPN orphan, W - WAAS,
X - inspected by service module
59-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Troubleshooting the ASA CX Module
TCP outside 208.80.152.2:80 inside 192.168.1.20:59928, idle 0:00:10, bytes 79174, flags
XUIO
Capturing Module Traffic
To configure and view packet captures for the ASA CX module, enter one of the following commands:
Note Captured packets contain an additional AFBP header that your PCAP viewer might not understand; be
sure to use the appropriate plugin to view these packets.
Troubleshooting the ASA CX Module
General Recovery Procedures, page 59-17
Debugging the Module, page 59-19
Problems with the Authentication Proxy, page 59-20
General Recovery Procedures
This section includes procedures that help you recover or troubleshoot the module and includes the
following topics:
Resetting the Password, page 59-17
Reloading or Resetting the Module, page 59-18
Shutting Down the Module, page 59-19
Note You can install or upgrade your image from within the ASA CX module. See the ASA CX module
documentaiton for more information.
Resetting the Password
You can reset the module password to the default. For the user admin, the default password is
Admin123. After resetting the password, you should change it to a unique value using the module
application.
Resetting the module password causes the module to reboot. Services are not available while the module
is rebooting.
Command Purpose
capture name interface asa_dataplane
Captures packets between ASA CX module and the ASA on the
backplane.
copy capture
Copies the capture file to a server.
show capture
Shows the capture at the ASA console.
59-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Troubleshooting the ASA CX Module
To reset the module password to the default of Admin123, perform the following steps.
Detailed Steps
Reloading or Resetting the Module
To reload or reset the module, enter one of the following commands at the ASA CLI.
Detailed Steps
Command Purpose
hw-module module 1 password-reset
Example:
hostname# hw-module module 1 password-reset
Resets the module password to Admin123 for user admin.
Command Purpose
hw-module module 1 reload
Example:
hostname# hw-module module 1 reload
Reloads the module software.
hw-module module 1 reset
Example:
hostname# hw-module module 1 reset
Performs a reset, and then reloads the module.
59-19
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Troubleshooting the ASA CX Module
Shutting Down the Module
If you restart the ASA, the module is not automatically restarted. To shut down the module, perform the
following steps at the ASA CLI.
Detailed Steps
Debugging the Module
To enable ASA CX debugging, enter the following command:
When you enable the authentication proxy, the ASA generates a debug messge when it sends an
authentication proxy TLV to the ASA CX module, giving details of IP and port:
DP CXSC Event: Sent Auth proxy tlv for adding Auth Proxy on interface: inside4.
DP CXSC Event: Sent Auth proxy tlv for adding Auth Proxy on interface: cx_inside.
DP CXSC Event: Sent Auth proxy tlv for adding Auth Proxy on interface: cx_outside.
When the interface IP address is changed, auth-proxy tlv updates are sent to CXSC:
DP CXSC Event: Sent Auth proxy tlv for removing Auth Proxy for interface inside.
DP CXSC Event: Sent Auth proxy tlv for adding Auth Proxy on interface: inside.
When a flow is freed on the ASA, the ASA CX module is notified so it can clean up the flow:
DP CXSC Msg: Notifying CXSC that flow (handle:275233990) is being freed for
192.168.18.5:2213 -> 10.166.255.18:80.
When the ASA CX module sends a redirect to a client to authenticate, and that redirect is sent to the
ASA, the ASA sends it to the ASA CX module. In this example, 192.168.18.3 is the interface address
and port 8888 is the authentication proxy port reserved on that interface for the authentication proxy
feature:
DP CXSC Msg: rcvd authentication proxy data from 192.168.18.5:2214 -> 192.168.18.3:8888,
forwarding to cx
When a VPN connection is established on the ASA, and the ASA sends connection information to the
ASA CX module:
CXSC Event: Dumping attributes from the vpn session record
CXSC Event: tunnel->Protocol: 17
CXSC Event: tunnel->ClientVendor: SSL VPN Client
Command Purpose
hw-module module 1 shutdown
Example:
hostname# hw-module module 1 shutdown
Shuts down the module.
Command Purpose
debug cxsc [error | event | message]
Enables debugs at error, event, or message level.
59-20
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Troubleshooting the ASA CX Module
CXSC Event: tunnel->ClientVersion: Cisco AnyConnect VPN Agent for Windows 2.4.1012
CXSC Event: Sending VPN RA session data to CXSC
CXSC Event: sess index: 0x3000
CXSC Event: sess type id: 3
CXSC Event: username: devuser
CXSC Event: domain: CN=Users,DC=test,DC=priv
CXSC Event: directory type: 1
CXSC Event: login time: 1337124762
CXSC Event: nac result: 0
CXSC Event: posture token:
CXSC Event: public IP: 172.23.34.108
CXSC Event: assigned IP: 192.168.17.200
CXSC Event: client OS id: 1
CXSC Event: client OS:
CXSC Event: client type: Cisco AnyConnect VPN Agent for Windows 2.4.1012
CXSC Event: anyconnect data: , len: 0
Problems with the Authentication Proxy
If you are having a problem using the authentication proxy feature, follow these steps to troubleshoot
your configuration and connections:
1. Check your configurations.
On the ASA, check the output of the show asp table classify domain cxsc-auth-proxy command
and make sure there are rules installed and that they are correct.
In PRSM, ensure the directory realm is created with the correct credentials and test the connection
to make sure you can reach the authentication server; also ensure that a policy object or objects are
configured for authentication.
2. Check the output of the show service-policy cxsc command to see if any packets were proxied.
3. Perform a packet capture on the backplane, and check to see if traffic is being redirected on the
correct configured port. See the Capturing Module Traffic section on page 59-17. You can check
the configured port using the show running-config cxsc command or the show asp table classify
domain cxsc-auth-proxy command.
Note If you have a connection between hosts on two ASA interfaces, and the ASA CX service policy is only
configured for one of the interfaces, then all traffic between these hosts is sent to the ASA CX module,
including traffic orginiating on the non-ASA CX interface (the feature is bidirectional). However, the
ASA only performs the authentication proxy on the interface to which the service policy is applied,
because this feature is ingress-only.
Example 59-1 Make sure port 2000 is used consistently:
1. Check the authentication proxy port:
hostname# show running-config cxsc
cxsc auth-proxy port 2000
2. Check the authentication proxy rules:
hostname# show asp table classify domain cxsc-auth-proxy
Input Table
in id=0x7ffed86cc470, priority=121, domain=cxsc-auth-proxy, deny=false
hits=0, user_data=0x7ffed86ca220, cs_id=0x0, flags=0x0, protocol=6
59-21
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Configuration Examples for the ASA CX Module
src ip/id=0.0.0.0, mask=0.0.0.0, port=0
dst ip/id=192.168.0.100, mask=255.255.255.255, port=2000, dscp=0x0
input_ifc=inside, output_ifc=identity
3. In the packet captures, the redirect request should be going to destination port 2000.
Configuration Examples for the ASA CX Module
The following example diverts all HTTP traffic to the ASA CX module, and blocks all HTTP traffic if
the ASA CX module card fails for any reason:
hostname(config)# access-list ASACX permit tcp any any eq port 80
hostname(config)# class-map my-cx-class
hostname(config-cmap)# match access-list ASACX
hostname(config-cmap)# policy-map my-cx-policy
hostname(config-pmap)# class my-cx-class
hostname(config-pmap-c)# cxsc fail-close auth-proxy
hostname(config-pmap-c)# service-policy my-cx-policy global
The following example diverts all IP traffic destined for the 10.1.1.0 network and the 10.2.1.0 network
to the ASA CX module, and allows all traffic through if the ASA CX module fails for any reason.
hostname(config)# access-list my-cx-acl permit ip any 10.1.1.0 255.255.255.0
hostname(config)# access-list my-cx-acl2 permit ip any 10.2.1.0 255.255.255.0
hostname(config)# class-map my-cx-class
hostname(config-cmap)# match access-list my-cx-acl
hostname(config)# class-map my-cx-class2
hostname(config-cmap)# match access-list my-cx-acl2
hostname(config-cmap)# policy-map my-cx-policy
hostname(config-pmap)# class my-cx-class
hostname(config-pmap-c)# cxsc fail-open auth-proxy
hostname(config-pmap)# class my-cx-class2
hostname(config-pmap-c)# cxsc fail-open auth-proxy
hostname(config-pmap-c)# service-policy my-cx-policy interface outside
59-22
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 59 Configuring the ASA CX Module
Feature History for the ASA CX Module
Feature History for the ASA CX Module
Table 59-2 lists each feature change and the platform release in which it was implemented.
Table 59-2 Feature History for the ASA CX Module
Feature Name
Platform
Releases Feature Information
ASA 5585-X support for the ASA CX SSP 8.4(4.1) ASA CX module lets you enforce security based on the
complete context of a situation. This context includes the
identity of the user (who), the application or website that the
user is trying to access (what), the origin of the access
attempt (where), the time of the attempted access (when),
and the properties of the device used for the access (how).
With the ASA CX module, you can extract the full context
of a flow and enforce granular policies such as permitting
access to Facebook but denying access to games on
Facebook or permitting finance employees access to a
sensitive enterprise database but denying the same to other
employees.
We introduced or modified the following commands:
capture, cxsc, cxsc auth-proxy, debug cxsc, hw-module
module password-reset, hw-module module reload,
hw-module module reset, hw-module module shutdown,
session do setup host ip, session do get-config, session do
password-reset, show asp table classify domain cxsc,
show asp table classify domain cxsc-auth-proxy, show
capture, show conn, show module, show service-policy.
This feature is not available in Version 8.6(1).
C H A P T E R
60-1
Cisco ASA 5500 Series Configuration Guide using the CLI
60
Configuring the ASA CSC Module
This chapter describes how to configure the Content Security and Control (CSC) application that is
installed in a CSC SSM in the ASA.
This chapter includes the following sections:
Information About the CSC SSM, page 60-1
Licensing Requirements for the CSC SSM, page 60-5
Prerequisites for the CSC SSM, page 60-5
Guidelines and Limitations, page 60-6
Default Settings, page 60-6
Configuring the CSC SSM, page 60-7
Monitoring the CSC SSM, page 60-13
Troubleshooting the CSC Module, page 60-14
Configuration Examples for the CSC SSM, page 60-16
Where to Go Next, page 60-18
Additional References, page 60-18
Feature History for the CSC SSM, page 60-18
Information About the CSC SSM
Some ASA models support the CSC SSM, which runs Content Security and Control software. The CSC
SSM provides protection against viruses, spyware, spam, and other unwanted traffic by scanning the
FTP, HTTP/HTTPS, POP3, and SMTP packets that you configure the ASA to send to it.
For more information about the CSC SSM, see the following URL:
http://www.cisco.com/en/US/products/ps6823/index.html
Figure 60-1 shows the flow of traffic through an ASA that has the following:
A CSC SSM installed and configured.
A service policy that determines what traffic is diverted to the CSC SSM for scanning.
In this example, the client could be a network user who is accessing a website, downloading files from
an FTP server, or retrieving mail from a POP3 server. SMTP scans differ in that you should configure
the ASA to scan traffic sent from the outside to SMTP servers protected by the ASA.
60-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Information About the CSC SSM
Figure 60-1 Flow of Scanned Traffic with the CSC SSM
You use ASDM for system setup and monitoring of the CSC SSM. For advanced configuration of content
security policies in the CSC SSM software, you access the web-based GUI for the CSC SSM by clicking
links within ASDM. The CSC SSM GUI appears in a separate web browser window. To access the CSC
SSM, you must enter the CSC SSM password. To use the CSC SSM GUI, see the Cisco Content Security
and Control (CSC) SSM Administrator Guide.
Note ASDM and the CSC SSM maintain separate passwords. You can configure their passwords to be
identical; however, changing one of these two passwords does not affect the other password.
The connection between the host running ASDM and the ASA is made through a management port on
the ASA. The connection to the CSC SSM GUI is made through the SSM management port. Because
these two connections are required to manage the CSC SSM, any host running ASDM must be able to
reach the IP address of both the ASA management port and the SSM management port.
Figure 60-2 shows an ASA with a CSC SSM that is connected to a dedicated management network.
While use of a dedicated management network is not required, we recommend it. In this configuration,
the following items are of particular interest:
An HTTP proxy server is connected to the inside network and to the management network. This
HTTP proxy server enables the CSC SSM to contact the Trend Micro Systems update server.
The management port of the ASA is connected to the management network. To allow management
of the ASA and the CSC SSM, hosts running ASDM must be connected to the management network.
The management network includes an SMTP server for e-mail notifications for the CSC SSM and a
syslog server to which the CSC SSM can send syslog messages.
1
4
8
3
8
6
ASA
Main System
Request sent
Client
Reply forwarded
inside
modular
service
policy
Request forwarded
Reply sent
CSC SSM
Server
Diverted Traffic
content security scan
outside
60-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Information About the CSC SSM
Figure 60-2 CSC SSM Deployment with a Management Network
Determining What Traffic to Scan
The CSC SSM can scan FTP, HTTP/HTTPS, POP3, and SMTP traffic only when the destination port of
the packet requesting the connection is the well-known port for the specified protocol. The CSC SSM
can scan only the following connections:
FTP connections opened to TCP port 21.
HTTP connections opened to TCP port 80.
HTTPS connections opened to TCP port 443.
POP3 connections opened to TCP port 110.
SMTP connections opened to TCP port 25.
You can choose to scan traffic for all of these protocols or any combination of them. For example, if you
do not allow network users to receive POP3 e-mail, do not configure the ASA to divert POP3 traffic to
the CSC SSM. Instead, block this traffic.
To maximize performance of the ASA and the CSC SSM, divert only the traffic to the CSC SSM that
you want the CSC SSM to scan. Diverting traffic that you do not want scanned, such as traffic between
a trusted source and destination, can adversely affect network performance.
Note When traffic is first classified for CSC inspection, it is flow-based. If traffic is part of a pre-existing
connection, the traffic goes directly to the service policy set for that connection.
You can apply service policies that include CSC scanning globally or to specific interfaces; therefore,
you can choose to enable CSC scans globally or for specific interfaces.
1
4
8
3
8
7
192.168.100.1
192.168.50.1
Notifications
SMTP Server
192.168.50.38
SSM
management
port
10.6.13.67
Trend Micro
Update Server
ASA
Main System
inside
CSC SSM
outside
HTTP
Proxy
management port
ASDM
Syslog
Internet
60-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Information About the CSC SSM
Based on the configuration shown in Figure 60-3, configure the ASA to divert to the CSC SSM only
requests from clients on the inside network for HTTP, FTP, and POP3 connections to the outside
network, and incoming SMTP connections from outside hosts to the mail server on the DMZ network.
Exclude from scanning HTTP requests from the inside network to the web server on the DMZ network.
Figure 60-3 Common Network Configuration for CSC SSM Scanning
There are many ways you could configure the ASA to identify the traffic that you want to scan. One
approach is to define two service policies: one on the inside interface and the other on the outside
interface, each with access lists that match traffic to be scanned.
Figure 60-4 shows service policy rules that select only the traffic that the ASA should scan.
Figure 60-4 Optimized Traffic Selection for CSC Scans
In the inside-policy, the first class, inside-class1, ensures that the ASA does not scan HTTP traffic
between the inside network and the DMZ network. The Match column indicates this setting by
displaying the Do not match icon. This setting does not mean the ASA blocks traffic sent from the
192.168.10.0 network to TCP port 80 on the 192.168.20.0 network. Instead, this setting exempts the
traffic from being matched by the service policy applied to the inside interface, which prevents the ASA
from sending the traffic to the CSC SSM.
The second class of the inside-policy, inside-class matches FTP, HTTP, and POP3 traffic between the
inside network and any destination. HTTP connections to the DMZ network are exempted because of the
inside-class1 setting. As previously mentioned, policies that apply CSC scanning to a specific interface
affect both incoming and outgoing traffic, but by specifying 192.168.10.0 as the source network,
inside-class1 matches only connections initiated by the hosts on the inside network.
192.168.30.0
192.168.20.0
(dmz)
Web server Mail server
192.168.10.0
Internet outside inside
ASA
1
4
3
8
0
0
60-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Licensing Requirements for the CSC SSM
In the outside-policy, outside-class matches SMTP traffic from any outside source to the DMZ network.
This setting protects the SMTP server and inside users who download e-mail from the SMTP server on
the DMZ network, without having to scan connections from SMTP clients to the server.
If the web server on the DMZ network receives files uploaded by HTTP from external hosts, you can add
a rule to the outside policy that matches HTTP traffic from any source to the DMZ network. Because the
policy is applied to the outside interface, the rule would only match connections from HTTP clients
outside the ASA.
Licensing Requirements for the CSC SSM
Prerequisites for the CSC SSM
The CSC SSM has the following prerequisites:
A CSC SSM card must be installed in the ASA.
A Product Authorization Key (PAK) for use in registering the CSC SSM.
Activation keys that you receive by e-mail after you register the CSC SSM.
The management port of the CSC SSM must be connected to your network to allow management
and automatic updates of the CSC SSM software.
The CSC SSM management port IP address must be accessible by the hosts used to run ASDM.
You must obtain the following information to use in configuring the CSC SSM:
The CSC SSM management port IP address, netmask, and gateway IP address.
DNS server IP address.
HTTP proxy server IP address (needed only if your security policies require the use of a proxy
server for HTTP access to the Internet).
Model License Requirement
ASA 5510 Base LicenseSupports SMTP virus scanning, POP3 virus scanning and content filtering, web
mail virus scanning, HTTP file blocking, FTP virus scanning and file blocking, logging, and
automatic updates. Supports two contexts.
Optional licenses: 5 contexts.
Security Plus LicenseSupports the Base license features, plus SMTP anti-spam, SMTP content
filtering, POP3 anti-spam, URL blocking, and URL filtering. Supports two contexts.
Optional license: 5 contexts.
ASA 5520 Base LicenseSupports all features. Supports two contexts.
Optional licenses: 5, 10, or 20 contexts.
ASA 5540 Base LicenseSupports all features. Supports two contexts.
Optional licenses: 5, 10, 20, or 50 contexts.
All other models No support.
60-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Guidelines and Limitations
Domain name and hostname for the CSC SSM.
An e-mail address and an SMTP server IP address and port number for e-mail notifications.
E-mail address(es) for product license renewal notifications.
IP addresses of hosts or networks that are allowed to manage the CSC SSM. The IP addresses
for the CSC SSM management port and the ASA management interface can be in different
subnets.
Password for the CSC SSM.
Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
Supported in single and multiple context modes.
Firewall Mode Guidelines
Supported in routed and transparent firewall modes.
Failover Guidelines
Does not support sessions in Stateful Failover. The CSC SSM does not maintain connection information,
and therefore cannot provide the failover unit with the required information. The connections that a CSC
SSM is scanning are dropped when the ASA in which the CSC SSM is installed fails. When the standby
ASA becomes active, it forwards the scanned traffic to the CSC SSM and the connections are reset.
IPv6 Guidelines
Does not support IPv6.
Model Guidelines
Supported on the ASA 5510, ASA 5520, and ASA 5540 only.
Additional Guidelines
You cannot change the software type installed on the module; if you purchase a CSC module, you cannot
later install IPS software on it.
Default Settings
Table 60-1 lists the default settings for the CSC SSM.
Table 60-1 Default CSC SSM Parameters
Parameter Default
FTP inspection on the ASA Enabled
All features included in the license(s) that you
have purchased
Enabled
60-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Configuring the CSC SSM
Configuring the CSC SSM
This section describes how to configure the CSC SSM and includes the following topics:
Before Configuring the CSC SSM, page 60-7
Connecting to the CSC SSM, page 60-8
Diverting Traffic to the CSC SSM, page 60-10
Before Configuring the CSC SSM
Before configuring the ASA and the CSC SSM, perform the following steps:
Step 1 If the CSC SSM did not come preinstalled in a Cisco ASA, install it and connect a network cable to the
management port of the SSM. For assistance with installation and connecting the SSM, see the Cisco
ASA 5500 Series Adaptive Security Appliance Getting Started Guide.
The management port of the CSC SSM must be connected to your network to allow management of and
automatic updates to the CSC SSM software. Additionally, the CSC SSM uses the management port for
e-mail notifications and syslog messages.
Step 2 You should have received a Product Authorization Key (PAK) with the CSC SSM. Use the PAK to
register the CSC SSM at the following URL.
http://www.cisco.com/go/license
After you register, you receive activation keys by e-mail. The activation keys are required before you can
complete Step 6.
Step 3 Obtain the following information for use in Step 6:
Activation keys
CSC SSM management port IP address, netmask, and gateway IP address
DNS server IP address
HTTP proxy server IP address (needed only if your security policies require the use of a proxy server
for HTTP access to the Internet)
Domain name and hostname for the CSC SSM
An e-mail address, and SMTP server IP address and port number for e-mail notifications
E-mail address(es) for product license renewal notifications
IP addresses of hosts or networks that are allowed to manage the CSC SSM
Password for the CSC SSM
Step 4 In a web browser, access ASDM for the ASA in which the CSC SSM is installed.
Note If you are accessing ASDM for the first time, see the Additional References section on
page 60-18.
For more information about enabling ASDM access, see the Configuring ASA Access for ASDM,
Telnet, or SSH section on page 37-1.
Step 5 Verify time settings on the ASA. Time setting accuracy is important for logging of security events and
for automatic updates of CSC SSM software. Do one of the following:
60-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Configuring the CSC SSM
If you manually control time settings, verify the clock settings, including time zone. Choose
Configuration > Properties > Device Administration > Clock.
If you are using NTP, verify the NTP configuration. Choose Configuration > Properties > Device
Administration > NTP.
Step 6 Open ASDM.
Step 7 Connect to and log in to the CSC SSM. For instructions, see the Connecting to the CSC SSM section
on page 60-8.
Step 8 Configure service policies to divert traffic that you want scanned to the CSC SSM. For instructions, see
the Diverting Traffic to the CSC SSM section on page 60-10.
Step 9 Run the CSC Setup Wizard.
To access the CSC Setup Wizard, choose Configuration > Trend Micro Content Security > CSC
Setup > Wizard Setup > Launch Setup Wizard.
If you are rerunning the CSC Setup Wizard, perform the same step listed in the previous bullet.
The CSC Setup Wizard appears.
Step 10 Complete the CSC Setup Wizard.
Note If you create a global service policy to divert traffic for CSC scans, all traffic (inbound and
outbound) for the supported protocols is scanned. To maximize performance of the ASA and the
CSC SSM, scan traffic only from untrusted sources.
Step 11 To reduce the load on the CSC SSM, configure the service policy rules that send packets to the CSC SSM
to support only HTTP/HTTPS, SMTP, POP3, or FTP traffic.
Step 12 (Optional) Review the default content security policies in the CSC SSM GUI, which are suitable for most
implementations. You review the content security policies by viewing the enabled features in the CSC
SSM GUI. For the availability of features, see the Licensing Requirements for the CSC SSM section
on page 60-5. For the default settings, see the Default Settings section on page 60-6.
What to Do Next
See the Connecting to the CSC SSM section on page 60-8.
Connecting to the CSC SSM
With each session you start in ASDM, the first time you access features related to the CSC SSM, you
must specify the management IP address and provide the password for the CSC SSM. After you
successfully connect to the CSC SSM, you are not prompted again for the management IP address and
password. If you start a new ASDM session, the connection to the CSC SSM is reset and you must
specify the IP address and the CSC SSM password again. The connection to the CSC SSM is also reset
if you change the time zone on the ASA.
Note The CSC SSM has a password that is maintained separately from the ASDM password. You can
configure the two passwords to be identical, but changing the CSC SSM password does not affect the
ASDM password.
60-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Configuring the CSC SSM
To connect to the CSC SSM, perform the following steps:
Step 1 In the ASDM main application window, click the Content Security tab.
Step 2 In the Connecting to CSC dialog box, click one of the following radio buttons:
To connect to the IP address of the management port on the SSM, click Management IP Address.
ASDM automatically detects the IP address for the SSM in the ASA. If this detection fails, you can
specify the management IP address manually.
To connect to an alternate IP address or hostname on the SSM, click Other IP Address or
Hostname.
Step 3 Enter the port number in the Port field, and then click Continue.
Step 4 In the CSC Password field, type your CSC password, and then click OK.
Note If you have not completed the CSC Setup Wizard (choose Configuration > Trend Micro
Content Security > CSC Setup > Wizard Setup), complete the configuration in the CSC
Setup Wizard, which includes changing the default password, cisco.
For ten minutes after you have entered the password, you do not need to reenter the CSC SSM
password to access other parts of the CSC SSM GUI.
Step 5 To access the CSC SSM GUI, choose Configuration > Trend Micro Content Security, and then click
one of the following tabs: Web, Mail, File Transfer, or Updates.
60-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Configuring the CSC SSM
What to Do Next
See the Diverting Traffic to the CSC SSM section on page 60-10.
Diverting Traffic to the CSC SSM
You use Modular Policy Framework commands to configure the ASA to divert traffic to the CSC SSM.
Prerequisites
Before configuring the ASA to divert traffic to the CSC SSM, see Chapter 32, Configuring a Service
Policy Using the Modular Policy Framework, which introduces Modular Policy Framework concepts
and common commands.
To configure the ASA to divert traffic to the CSC SSM, perform the following steps:
Detailed Steps
Command Purpose
Step 1 access-list extended
Example:
hostname(config)# access-list extended
Creates an access list that matches the traffic you
want scanned by the CSC SSM. Create as many
ACEs as are needed to match all the traffic. For
example, to specify FTP, HTTP/HTTPS, POP3, and
SMTP traffic, you need four ACEs. For guidance on
identifying the traffic that you want to scan, see the
Determining What Traffic to Scan section on
page 60-3.
Step 2 class-map class_map_name
Example:
hostname(config)# class-map class_map_name
Creates a class map to identify the traffic that should
be diverted to the CSC SSM. The class_map_name
argument is the name of the traffic class. When you
enter the class-map command, the CLI enters class
map configuration mode.
Step 3 match access-list acl-name
Example:
hostname(config-cmap)# match access-list acl-name
Identifies the traffic to be scanned with the access list
that you created in Step 1. The acl-name argument is
the name of the access list.
Step 4 policy-map policy_map_name
Example:
hostname(config-cmap)# policy-map policy_map_name
Creates a policy map or modify an existing policy
map that you want to use to send traffic to the CSC
SSM. The policy_map_name argument is the name
of the policy map. When you enter the policy-map
command, the CLI enters policy map configuration
mode.
Step 5 class class_map_name
Example:
hostname(config-pmap)# class class_map_name
Specifies the class map, created in Step 2, that
identifies the traffic to be scanned. The
class_map_name argument is the name of the class
map that you created in Step 2. The CLI enters the
policy map class configuration mode.
60-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Configuring the CSC SSM
Step 6 set connection per-client-max n
Example:
hostname(config-pmap-c)# set connection
per-client-max 5
Lets you configure limits to thwart DoS attacks. The
per-client-max parameter limits the maximum
number of connections that individual clients can
open. If a client uses more network resources
simultaneously than is desired, you can enforce a
per-client limit for simultaneous connections that the
ASA diverts to the CSC SSM. The n argument is the
maximum number of simultaneous connections that
the ASA allows per client. This command prevents a
single client from abusing the services of the CSC
SSM or any server protected by the SSM, including
prevention of attempts at DoS attacks on
HTTP/HTTPS, FTP, POP3, or SMTP servers that the
CSC SSM protects.
Command Purpose
60-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Configuring the CSC SSM
Step 7 csc {fail-close | fail-open}
Example:
hostname(config-pmap-c)# csc {fail-close |
fail-open}
Enables traffic scanning with the CSC SSM and
assigns the traffic identified by the class map as
traffic to be sent to the CSC SSM. Must be part of a
service policy, which can be applied globally or to
specific interfaces. Ensures that all unencrypted
connections through the ASA are scanned by the
CSC SSM; however, this setting may mean that
traffic from trusted sources is needlessly scanned. If
enabled in interface-specific service policies, this
command is bi-directional. Bi-directionality means
that when the ASA opens a new connection, if this
command is active on either the inbound or the
outbound interface of the connection and the class
map for the policy identifies traffic for scanning, the
ASA diverts this traffic to the CSC SSM. However,
bi-directionality also means that if you divert any of
the supported traffic types that cross a given interface
to the CSC SSM, it is probably performing
unnecessary scans on traffic from your trusted inside
networks. Therefore, to further limit the traffic
selected by the class maps of CSC SSM service
policies, we recommend using access lists that match
the following:
HTTP/HTTPS connections to outside networks.
FTP connections from clients inside the ASA to
servers outside the ASA.
POP3 connections from clients inside the ASA
to servers outside the ASA.
Incoming SMTP connections destined to inside
mail servers.
The fail-close and fail-open keywords control how
the ASA handles traffic when the CSC SSM is
unavailable. For more information about the
operating modes and failure behavior, see the
Guidelines and Limitations section on page 60-6.
Step 8 service-policy policy_map_name [global | interface
interface_ID]
Example:
hostname(config-pmap-c)# service-policy
policy_map_name [global | interface interface_ID]
Applies the policy map globally or to a specific
interface. The policy_map_name argument is the
policy map that you configured in Step 4. To apply
the policy map to traffic on all the interfaces, use the
global keyword. To apply the policy map to traffic on
a specific interface, use the interface interface_ID
keyword and argument pair, where interface_ID is
the name assigned to the interface with the nameif
command. Only one global policy is allowed. You
can override the global policy on an interface by
applying a service policy to that interface. You can
only apply one policy map to each interface.
Command Purpose
60-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Monitoring the CSC SSM
What to Do Next
See the Monitoring the CSC SSM section on page 60-13.
Monitoring the CSC SSM
To check the status of a module, enter one of the following commands:
Examples
The following is sample output from the show module command for an ASA with a CSC SSM installed:
hostname# show module
Mod Card Type Model Serial No.
--- -------------------------------------------- ------------------ -----------
0 ASA 5520 Adaptive Security Appliance ASA5520 JMX1241L05S
1 ASA 5500 Series Content Security Services Mo ASA-SSM-CSC-10 AF1234BQQL
Mod SSM Application Name Status SSM Application Version
--- ------------------------------ ---------------- --------------------------
1 CSC SSM Down 6.2.1599.0
The following is sample output from the show module details command, which provides additional
information about an ASA with a CSC SSM installed:
hostname# show module 1 details
Getting details from the Service Module, please wait...
ASA 5500 Series Security Services Module-20
Model: ASA-SSM-20
Hardware version: 1.0
Serial Number: JAF10333331
Firmware version: 1.0(10)0
Software version: Trend Micro InterScan Security Module Version 6.2
App. name: Trend Micro InterScan Security Module
App. version: Version 6.2
Data plane Status: Up
Status: Up
HTTP Service: Up
Mail Service: Up
FTP Service: Up
Activated: Yes
Mgmt IP addr: 209.165.200.225
Mgmt web port: 8443
The following is sample output from the show module recover command, which includes recovery
details for an ASA with a CSC SSM installed:
hostname# show module 1 recover
Module 1 recover parameters. . .
Boot Recovery Image: Yes
Image URL: tftp://10.21.18.1/ids-oldimg
Port IP Address: 209.165.200.230
Command Purpose
show module
Displays the status.
show module 1 details
Displays additional status information.
show module 1 recover
Displays the network parameters for transferring an image to the module.
60-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Troubleshooting the CSC Module
Port Mask: 255.255.224.0
Gateway IP Address: 209.165.200.254
Troubleshooting the CSC Module
This section includes procedures that help you recover or troubleshoot the module and includes the
following topics:
Installing an Image on the Module, page 60-14
Resetting the Password, page 60-15
Reloading or Resetting the Module, page 60-16
Shutting Down the Module, page 60-16
Note This section covers all ASA module types; follow the steps appropriate for your module.
Installing an Image on the Module
If the module suffers a failure, and the module application image cannot run, you can reinstall a new
image on the module from a TFTP server.
Note Do not use the upgrade command within the module software to install the image.
Prerequisites
Be sure the TFTP server that you specify can transfer files up to 60 MB in size.
Note This process can take approximately 15 minutes to complete, depending on your network and the size
of the image.
60-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Troubleshooting the CSC Module
Detailed Steps
Resetting the Password
You can reset the module password to the default. The default password is cisco. After resetting the
password, you should change it to a unique value using the module application.
Resetting the module password causes the module to reboot. Services are not available while the module
is rebooting.
To reset the module password to the default of cisco, perform the following steps.
Detailed Steps
Command Purpose
Step 1 hw-module module 1 recover configure
Example:
hostname# hw-module module 1 recover
configure
Image URL [tftp://127.0.0.1/myimage]:
tftp://10.1.1.1/ids-newimg
Port IP Address [127.0.0.2]: 10.1.2.10
Port Mask [255.255.255.254]: 255.255.255.0
Gateway IP Address [1.1.2.10]: 10.1.2.254
VLAN ID [0]: 100
Specifies the location of the new image. This command prompts
you for the URL for the TFTP server, the management interface
IP address and netmask, gateway address, and VLAN ID (ASA
5505 only). These network parameters are configured in
ROMMON; the network parameters you configured in the module
application configuration are not available to ROMMON, so you
must set them separately here.
You can view the recovery configuration using the show module
1 recover command.
In multiple context mode, enter this command in the system
execution space.
Step 2 hw-module module 1 recover boot
Example:
hostname# hw-module module 1 recover boot
Transfers the image from the TFTP server to the module and
restarts the module.
Step 3 show module 1 details
Example:
hostname# show module 1 details
Checks the progress of the image transfer and module restart
process.
The Status field in the output indicates the operational status of
the module. A module operating normally shows a status of Up.
While the ASA transfers an application image to the module, the
Status field in the output reads Recover. When the ASA
completes the image transfer and restarts the module, the newly
transferred image is running.
Command Purpose
hw-module module 1 password-reset
Example:
hostname# hw-module module 1 password-reset
Resets the module password to cisco.
60-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Configuration Examples for the CSC SSM
Reloading or Resetting the Module
To reload or reset the module, enter one of the following commands at the ASA CLI.
Detailed Steps
Shutting Down the Module
If you restart the ASA, the module is not automatically restarted. To shut down the module, perform the
following steps at the ASA CLI.
Detailed Steps
Configuration Examples for the CSC SSM
To identify the traffic that you want to scan, you can configure the ASA in different ways. One approach
is to define two service policies, one on the inside interface and one on the outside interface, each with
an access list that matches traffic to be scanned. The following example is based on the network shown
in Figure 60-3 and shows the creation of two service policies for a common CSC SSM scanning scenario:
The first policy, csc_out_policy, is applied to the inside interface and uses the csc_out access list to
ensure that all outbound requests for FTP and POP3 are scanned. The csc_out access list also
ensures that HTTP connections from inside to networks on the outside interface are scanned, but it
includes a deny ACE to exclude HTTP connections from inside to servers on the DMZ network.
Command Purpose
hw-module module 1 reload
Example:
hostname# hw-module module 1 reload
Reloads the module software.
hw-module module 1 reset
Example:
hostname# hw-module module 1 reset
Performs a reset, and then reloads the module.
Command Purpose
hw-module module 1 shutdown
Example:
hostname# hw-module module 1 shutdown
Shuts down the module.
60-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Configuration Examples for the CSC SSM
The second policy, csc_in_policy, is applied to the outside interface and uses the csc_in access list
to ensure that requests for SMTP and HTTP originating on the outside interface and destined for the
DMZ network are scanned by the CSC SSM. Scanning HTTP requests protects the web server from
HTTP file uploads.
hostname(config)# access-list csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 21
hostname(config)# access-list csc_out deny tcp 192.168.10.0 255.255.255.0 192.168.20.0
255.255.255.0 eq 80
hostname(config)# access-list csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 80
hostname(config)# access-list csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 110
hostname(config)# class-map csc_outbound_class
hostname(config-cmap)# match access-list csc_out
hostname(config-cmap)# policy-map csc_out_policy
hostname(config-pmap)# class csc_outbound_class
hostname(config-pmap-c)# csc fail-close
hostname(config-pmap-c)# service-policy csc_out_policy interface inside
hostname(config)# access-list csc_in permit tcp any 192.168.20.0 255.255.255.0 eq 25
hostname(config)# access-list csc_in permit tcp any 192.168.20.0 255.255.255.0 eq 80
hostname(config)# class-map csc_inbound_class
hostname(config-cmap)# match access-list csc_in
hostname(config-cmap)# policy-map csc_in_policy
hostname(config-pmap)# class csc_inbound_class
hostname(config-pmap-c)# csc fail-close
hostname(config-pmap-c)# service-policy csc_in_policy interface outside
The following example shows how to use an access list to exempt the traffic from being matched by the
policy map and prevent the ASA from sending traffic to the CSC SSM:
hostname(config)# access-list csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 21
hostname(config)# access-list csc_out deny tcp 192.168.10.0 255.255.255.0 192.168.20.0
255.255.255.0 eq 80
hostname(config)# access-list csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 80
hostname(config)# access-list csc_out permit tcp 192.168.10.0 255.255.255.0 any eq 110
The following example shows how to add an ACE to the csc_out access list to exclude HTTP connections
between the trusted external web server and inside hosts from being scanned by the CSC SSM:
hostname(config)# access-list csc_out deny tcp 192.168.10.0 255.255.255.0 209.165.201.7
255.255.255.255 eq 80
The following example shows how to use the access list on the service policy applied to the outside
interface:
hostname(config)# access-list csc_in permit tcp any 192.168.20.0 255.255.255.0 eq 25
The following example shows how to add an ACE to the csc_in access list to use the CSC SSM to protect
the web server on a DMZ network from infected files uploaded by HTTP from external hosts:
hostname(config)# access-list csc_in permit tcp any 192.168.20.0 255.255.255.0 eq 80
60-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 60 Configuring the ASA CSC Module
Where to Go Next
Where to Go Next
For instructions about how to use the CSC SSM GUI, see the Cisco Content Security and Control (CSC)
SSM Administrator Guide.
Additional References
For additional information related to implementing the CSC SSM, see the following documents:
Feature History for the CSC SSM
Table 60-2 lists each feature change and the platform release in which it was implemented.
Related Topic Document Title
Assistance with SSM hardware installation and
connection to the ASA.
hardware guide
Accessing ASDM for the first time and
assistance with the Startup Wizard.
Cisco ASA 5500 Series Adaptive Security Appliance Getting Started Guide
Instructions on use of the CSC SSM GUI.
Additional licensing requirements of specific
windows available in the CSC SSM GUI.
Reviewing the default content security policies
in the CSC SSM GUI before modifying them or
entering advanced configuration settings.
Cisco Content Security and Control (CSC) SSM Administrator Guide
Technical Documentation, Marketing, and
Support-related information.
See the following URL:
http://www.cisco.com/en/US/products/ps6823/index.html.
Table 60-2 Feature History for the CSC SSM
Feature Name Platform Releases Feature Information
CSC SSM 7.0(1) The CSC SSM runs Content Security and Control software, which provides
protection against viruses, spyware, spam, and other unwanted traffic.
We introduced the following commands: csc {fail-close | fail-open}, hw-module
module 1 [recover | reload | reset | shutdown], session, show module [all | slot
[details | recover]].
Password reset 7.2(2) We introduced the following command: hw-module module password-reset.
CSC SSM 8.1(1) and 8.1(2) This feature is not supported on the ASA 5580.
CSC syslog format 8.3(1) CSC syslog format is consistent with the ASA syslog format. Syslog message
explanations have been added to the Cisco Content Security and Control (CSC)
SSM Administrator Guide. All syslog messages include predefined syslog
priorities and cannot be configured through the CSC SSM GUI.
P A R T 1 5
Configuring High Availability
C H A P T E R
61-1
Cisco ASA 5500 Series Configuration Guide using the CLI
61
Information About High Availability
This chapter provides an overview of the failover features that enable you to achieve high availability on
the Cisco 5500 series ASAs. For information about configuring high availability, see Chapter 63,
Configuring Active/Active Failover or Chapter 62, Configuring Active/Standby Failover.
This chapter includes the following sections:
Introduction to Failover and High Availability, page 61-1
Failover System Requirements, page 61-2
Failover and Stateful Failover Links, page 61-3
Active/Active and Active/Standby Failover, page 61-8
Stateless (Regular) and Stateful Failover, page 61-9
Transparent Firewall Mode Requirements, page 61-11
Auto Update Server Support in Failover Configurations, page 61-12
Failover Health Monitoring, page 61-14
Failover Times, page 61-16
Failover Messages, page 61-16
Introduction to Failover and High Availability
Configuring high availability requires two identical ASAs connected to each other through a dedicated
failover link and, optionally, a Stateful Failover link. The health of the active interfaces and units is
monitored to determine if specific failover conditions are met. If those conditions are met, failover
occurs.
The ASA supports two failover configurations, Active/Active failover and Active/Standby failover. Each
failover configuration has its own method for determining and performing failover.
With Active/Active failover, both units can pass network traffic. This also lets you configure traffic
sharing on your network. Active/Active failover is available only on units running in multiple context
mode.
With Active/Standby failover, only one unit passes traffic while the other unit waits in a standby state.
Active/Standby failover is available on units running in either single or multiple context mode.
Both failover configurations support stateful or stateless (regular) failover.
61-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 61 Information About High Availability
Failover System Requirements
Note When the security appliance is configured for Active/Active Stateful Failover, you cannot enable IPsec
or SSL VPN. Therefore, these features are unavailable. VPN failover is available for Active/Standby
failover configurations only.
Failover System Requirements
This section describes the hardware, software, and license requirements for ASAs in a failover
configuration.
This section includes the following topics:
Hardware Requirements, page 61-2
Software Requirements, page 61-2
License Requirements, page 61-2
Hardware Requirements
The two units in a failover configuration must be the same model, have the same number and types of
interfaces, the same SSMs installed (if any), and the same RAM installed.
If you are using units with different flash memory sizes in your failover configuration, make sure the
unit with the smaller flash memory has enough space to accommodate the software image files and the
configuration files. If it does not, configuration synchronization from the unit with the larger flash
memory to the unit with the smaller flash memory will fail.
Software Requirements
The two units in a failover configuration must be in the same operating modes (routed or transparent,
single or multiple context). They must have the same major (first number) and minor (second number)
software version. However, you can use different versions of the software during an upgrade process; for
example, you can upgrade one unit from Version 8.3(1) to Version 8.3(2) and have failover remain active.
We recommend upgrading both units to the same version to ensure long-term compatibility.
See the Performing Zero Downtime Upgrades for Failover Pairs section on page 81-6 for more
information about upgrading the software on a failover pair.
License Requirements
The two units in a failover configuration do not need to have identical licenses; the licenses combine to
make a failover cluster license. See the Failover Licenses (8.3(1) and Later) section on page 3-28 for
more information.
61-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 61 Information About High Availability
Failover and Stateful Failover Links
Failover and Stateful Failover Links
This section describes the failover and the Stateful Failover links, which are dedicated connections
between the two units in a failover configuration. This section includes the following topics:
Failover Link, page 61-3
Stateful Failover Link, page 61-4
Avoiding Interrupted Failover Links, page 61-5
Failover Link
The two units in a failover pair constantly communicate over a failover link to determine the operating
status of each unit. The following information is communicated over the failover link:
The unit state (active or standby)
Hello messages (keep-alives)
Network link status
MAC address exchange
Configuration replication and synchronization
Caution All information sent over the failover and Stateful Failover links is sent in clear text unless you secure
the communication with a failover key. If the ASA is used to terminate VPN tunnels, this information
includes any usernames, passwords and preshared keys used for establishing the tunnels. Transmitting
this sensitive data in clear text could pose a significant security risk. We recommend securing the failover
communication with a failover key if you are using the ASA to terminate VPN tunnels.
You can use any unused interface on the device as the failover link; however, you cannot specify an
interface that is currently configured with a name. The failover link interface is not configured as a
normal networking interface; it exists for failover communication only. This interface should only be
used for the failover link (and optionally for the Stateful Failover link).
Connect the failover link in one of the following two ways:
Using a switch, with no other device on the same network segment (broadcast domain or VLAN) as
the failover interfaces of the ASA.
Using a crossover Ethernet cable to connect the appliances directly, without the need for an external
switch.
Note When you use a crossover cable for the failover link, if the interface fails, the link is brought down on
both peers. This condition may hamper troubleshooting efforts because you cannot easily determine
which interface failed and caused the link to come down.
Note The ASA supports Auto-MDI/MDIX on its copper Ethernet ports, so you can either use a crossover cable
or a straight-through cable. If you use a straight-through cable, the interface automatically detects the
cable and swaps one of the transmit/receive pairs to MDIX.
61-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 61 Information About High Availability
Failover and Stateful Failover Links
Although you can configure failover and failover state links on a port channel link, this port channel
cannot be shared with other firewall traffic.
Stateful Failover Link
To use Stateful Failover, you must configure a Stateful Failover link to pass all state information. You
have three options for configuring a Stateful Failover link:
You can use a dedicated Ethernet interface for the Stateful Failover link.
You can share the failover link.
You can share a regular data interface, such as the inside interface. However, this option is not
recommended.
Connect a dedicated state link in one of the following two ways:
Using a switch, with no other device on the same network segment (broadcast domain or VLAN) as
the failover interfaces of the ASA.
Using a crossover Ethernet cable to connect the appliances directly, without the need for an external
switch.
Note When you use a crossover cable for the state link, if the interface fails, the link is brought down on both
peers. This condition may hamper troubleshooting efforts because you cannot easily determine which
interface failed and caused the link to come down.
The ASA supports Auto-MDI/MDIX on its copper Ethernet ports, so you can either use a crossover cable
or a straight-through cable. If you use a straight-through cable, the interface automatically detects the
cable and swaps one of the transmit/receive pairs to MDIX.
Enable the PortFast option on Cisco switch ports that connect directly to the ASA.
If you use a data interface as the Stateful Failover link, you receive the following warning when you
specify that interface as the Stateful Failover link:
******* WARNING ***** WARNING ******* WARNING ****** WARNING *********
Sharing Stateful failover interface with regular data interface is not
a recommended configuration due to performance and security concerns.
******* WARNING ***** WARNING ******* WARNING ****** WARNING *********
Sharing a data interface with the Stateful Failover interface can leave you vulnerable to replay attacks.
Additionally, large amounts of Stateful Failover traffic may be sent on the interface, causing
performance problems on that network segment.
Note Using a data interface as the Stateful Failover interface is supported in single context, routed mode only.
In multiple context mode, the Stateful Failover link resides in the system context. This interface and the
failover interface are the only interfaces in the system context. All other interfaces are allocated to and
configured from within security contexts.
Note The IP address and MAC address for the Stateful Failover link does not change at failover unless the
Stateful Failover link is configured on a regular data interface.
61-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 61 Information About High Availability
Failover and Stateful Failover Links
Caution All information sent over the failover and Stateful Failover links is sent in clear text unless you secure
the communication with a failover key. If the ASA is used to terminate VPN tunnels, this information
includes any usernames, passwords, and preshared keys used for establishing the tunnels. Transmitting
this sensitive data in clear text could pose a significant security risk. We recommend securing the failover
communication with a failover key if you are using the ASA to terminate VPN tunnels.
Failover Interface Speed for Stateful Links
If you use the failover link as the Stateful Failover link, you should use the fastest Ethernet interface
available. If you experience performance problems on that interface, consider dedicating a separate
interface for the Stateful Failover interface.
Use the following failover interface speed guidelines for the ASAs:
Cisco ASA 5510
Stateful link speed can be 100 Mbps, even though the data interface can operate at 1 Gigabit due
to the CPU speed limitation.
Cisco ASA 5520/5540/5550
Stateful link speed should match the fastest data link.
Cisco ASA 5580/5585
Use only non-management 1 Gigabit ports for the stateful link because management ports have
lower performance and cannot meet the performance requirement for Stateful Failover.
For optimum performance when using long distance failover, the latency for the failover link should be
less than 10 milliseconds and no more than 250 milliseconds. If latency is more than10 milliseconds,
some performance degradation occurs due to retransmission of failover messages.
The ASA supports sharing of failover heartbeat and stateful link, but we recommend using a separate
heartbeat link on systems with high Stateful Failover traffic.
Avoiding Interrupted Failover Links
Because the uses failover interfaces to transport messages between primary and secondary units, if a
failover interface is down (that is, the physical link is down or the switch used to connect the interface
is down), then the ASA failover operation is affected until the health of the failover interface is restored.
In the event that all communication is cut off between the units in a failover pair, both units go into the
active state, which is expected behavior. When communication is restored and the two active units
resume communication through the failover link or through any monitored interface, the primary unit
remains active, and the secondary unit immediately returns to the standby state. This relationship is
established regardless of the health of the primary unit.
Because of this behavior, stateful flows that were passed properly by the secondary active unit during
the network split are now interrupted. To avoid this interruption, failover links and data interfaces should
travel through different paths to decrease the chance that all links fail at the same time. In the event that
only one failover link is down, the ASA takes a sample of the interface health, exchanges this
information with its peer through the data interface, and performs a switchover if the active unit has a
greater number of down interfaces. Subsequently, the failover operation is suspended until the health of
the failover link is restored.
61-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 61 Information About High Availability
Failover and Stateful Failover Links
Depending upon their network topologies, several primary/secondary failure scenarios exist in ASA
failover pairs, as shown in the following scenarios.
Scenario 1Not Recommended
If a single switch or a set of switches are used to connect both failover and data interfaces between two
ASAs, then when a switch or inter-switch-link is down, both ASAs become active. Therefore, the
following two connection methods shown in Figure 61-1 and Figure 61-2 are NOT recommended.
Figure 61-1 Connecting with a Single SwitchNot Recommended
Figure 61-2 Connecting with a Double SwitchNot Recommended
Scenario 2Recommended
To make the ASA failover pair resistant to failover interface failure, we recommend that failover
interfaces NOT use the same switch as the data interfaces, as shown in the preceding connections.
Instead, use a different switch or use a direct cable to connect two ASA failover interfaces, as shown in
Figure 61-3 and Figure 61-4.
Figure 61-3 Connecting with a Different Switch
Figure 61-4 Connecting with a Cable
2
3
6
3
6
9 Primary ASA
Failover link Failover link
Secondary ASA
outside outside
inside inside
2
3
6
3
7
0 Primary ASA
Failover link Failover link
Secondary ASA
outside outside
inside inside
ISL
Switch 1 Switch 2
Primary ASA
2
3
6
3
7
1
Failover link Failover link
Secondary ASA
outside outside
Switch 1
Switch 2
inside inside
2
3
6
3
7
2
Ethernet cable
Primary ASA
Failover link Failover link
Secondary ASA
outside outside
Switch 1
inside inside
61-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 61 Information About High Availability
Failover and Stateful Failover Links
Scenario 3Recommended
If the ASA data interfaces are connected to more than one set of switches, then a failover interface can
be connected to one of the switches, preferably the switch on the secure side of network, as shown in
Figure 61-5.
Figure 61-5 Connecting with a Secure Switch
Scenario 4Recommended
The most reliable failover configurations use a redundant interface on the failover interface, as shown in
Figure 61-6 and Figure 61-7.
Figure 61-6 Connecting with Redundant Interfaces
2
3
6
3
7
3
Failover link Failover link
Primary ASA Secondary ASA
outside outside
inside inside
ISL
ISL
Switch 3 Switch 4
Switch 1 Switch 2
2
3
6
3
7
5
Primary ASA
Active redundant
failover link
Active redundant
failover link
Standby redundant
failover link
Standby redundant
failover link
Secondary ASA
outside outside
ISL
Switch 1 Switch 2
inside inside
ISL
Switch 5
Switch 3
Switch 6
Switch 4
61-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 61 Information About High Availability
Active/Active and Active/Standby Failover
Figure 61-7 Connecting with Inter-switch Links
Active/Active and Active/Standby Failover
Two types of failover configurations are supported by the ASA: Active/Standby and Active/Active.
In Active/Standby failover, one unit is the active unit. It passes traffic. The standby unit does not actively
pass traffic. When a failover occurs, the active unit fails over to the standby unit, which then becomes
active. You can use Active/Standby failover for ASAs in single or multiple context mode, although it is
most commonly used for ASAs in single context mode.
Active/Active failover is only available to ASAs in multiple context mode. In an Active/Active failover
configuration, both ASAs can pass network traffic. In Active/Active failover, you divide the security
contexts on the ASA into failover groups. A failover group is simply a logical group of one or more
security contexts. Each group is assigned to be active on a specific ASA in the failover pair. When a
failover occurs, it occurs at the failover group level.
For more detailed information about each type of failover, refer the following information:
Chapter 62, Configuring Active/Standby Failover
Chapter 63, Configuring Active/Active Failover
Determining Which Type of Failover to Use
The type of failover you choose depends upon your ASA configuration and how you plan to use the
ASAs.
If you are running the ASA in single mode, then you can use only Active/Standby failover. Active/Active
failover is only available to ASAs running in multiple context mode.
2
3
6
3
7
6
Primary
ASA
Active redundant
failover link
Active redundant
failover link
Standby redundant
failover link
Standby redundant
failover link
Secondary
ASA
outside outside
ISL
Switch 1 Switch 2
inside inside
ISL
ISL
ISL
Switch 7 Switch 8
Switch 5 Switch 6
Switch 3 Switch 4
61-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 61 Information About High Availability
Stateless (Regular) and Stateful Failover
Note The ASA 5505 does not support multiple context mode or Active/Active failover.
VPN is not supported in multiple context mode or Active/Active failover.
If you are running the ASA in multiple context mode, then you can configure either Active/Active
failover or Active/Standby failover.
To allow both members of the failover pair to share the traffic, use Active/Active failover. Do not
exceed 50% load on each device.
If you do not want to share the traffic in this way, use Active/Standby or Active/Active failover.
Table 61-1 provides a comparison of some of the features supported by each type of failover
configuration.
Stateless (Regular) and Stateful Failover
The ASA supports two types of failover, regular and stateful. This section includes the following topics:
Stateless (Regular) Failover, page 61-9
Stateful Failover, page 61-10
Stateless (Regular) Failover
When a failover occurs, all active connections are dropped. Clients need to reestablish connections when
the new active unit takes over.
Note In Version 8.0 and later, some configuration elements for clientless SSL VPN (such as bookmarks and
customization) use the VPN failover subsystem, which is part of Stateful Failover. You must use Stateful
Failover to synchronize these elements between the members of the failover pair. Stateless (regular)
failover is not recommended for clientless SSL VPN.
Table 61-1 Failover Configuration Feature Support
Feature Active/Active Active/Standby
Single Context Mode No Yes
Multiple Context Mode Yes Yes
Traffic Sharing Network Configurations Yes No
Unit Failover Yes Yes
Failover of Groups of Contexts Yes No
Failover of Individual Contexts No No
61-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 61 Information About High Availability
Stateless (Regular) and Stateful Failover
Stateful Failover
When Stateful Failover is enabled, the active unit continually passes per-connection state information to
the standby unit. After a failover occurs, the same connection information is available at the new active
unit. Supported end-user applications are not required to reconnect to keep the same communication
session.
In Version 8.4 and later, Stateful Failover participates in dynamic routing protocols, like OSPF and
EIGRP, so routes that are learned through dynamic routing protocols on the active unit are maintained
in a Routing Information Base (RIB) table on the standby unit. Upon a failover event, packets travel
normally with minimal disruption to traffic because the Active secondary ASA initially has rules that
mirror the primary ASA. Immediately after failover, the re-convergence timer starts on the newly Active
unit. Then the epoch number for the RIB table increments. During re-convergence, OSPF and EIGRP
routes become updated with a new epoch number. Once the timer is expired, stale route entries
(determined by the epoch number) are removed from the table. The RIB then contains the newest routing
protocol forwarding information on the newly Active unit.
Table 61-2 list the state information that is and is not passed to the standby unit when Stateful Failover
is enabled.
Table 61-2 State Information
State Information Passed to Standby Unit State Information Not Passed to Standby Unit
NAT translation table The HTTP connection table (unless HTTP
replication is enabled).
TCP connection states The user authentication (uauth) table.
Inspected protocols are subject to advanced
TCP-state tracking, and the TCP state of these
connections is not automatically replicated.
While these connections are replicated to the
standby unit, there is a best-effort attempt to
re-establish a TCP state.
UDP connection states DHCP server address leases.
The ARP table State information for modules.
The Layer 2 bridge table (when running in
transparent firewall mode)
Stateful Failover for phone proxy. When the
active unit goes down, the call fails, media stops
flowing, and the phone should unregister from the
failed unit and reregister with the active unit. The
call must be re-established.
The HTTP connection states (if HTTP replication
is enabled)
Step 8 (Optional) Highlight a bookmark and click Assign to assign the selected bookmark to one or more group
policies, dynamic access policies, or LOCAL users.
Capturing Data
The CLI capture command lets you log information about websites that do not display properly over a
clientless SSL VPN session. This data can help your Cisco customer support engineer troubleshoot
problems. The following sections describe how to capture and view clientless SSL VPN session data:
Creating a Capture File, page 74-121
Using a Browser to Display Capture Data, page 74-122
Prerequisites
Enabling clientless SSL VPN capture affects the performance of the security appliance. Be sure to
disable the capture after you generate the capture files needed for troubleshooting.
Creating a Capture File
Perform the following steps to capture data about a clientless SSL VPN session to a file.
Step 2 group-policy webvpn
Switches to group-policy webvpn configuration
mode.
Step 3 customization
Example:
hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# customization value
sales
Enables the customization object.
Shows the customization object sales enabled in the
group policy sales.
Command Purpose
74-122
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 74 Configuring Clientless SSL VPN
Capturing Data
Detailed Steps
Using a Browser to Display Capture Data
Perform the following steps to capture data about a clientless SSL VPN session and view it in a browser.
Command Purpose
Step 1 capture capture_name type webvpn user
webvpn_username
Example:
hostname# capture hr type webvpn user user2
WebVPN capture started.
capture name hr
user name user2
hostname# no capture hr
Starts the capture utility for clientless SSL VPN.
capture_name is a name you assign to the
capture, which is also prepended to the name of
the capture files.
webvpn_user is the username to match for
capture.
Creates a capture named hr, which captures traffic
for user2 to a file.
Step 2 (Optional)
no capture capture_name
Stops the capture utility from capturing packets after
a user has logged in and began a clientless SSL VPN
session. The capture utility creates a
capture_name.zip file, which is encrypted with the
password koleso.
Step 3 Send the .zip file to Cisco Systems or attach it to a Cisco TAC
service request.
Step 4 Unzip the contents of the file using the koleso password.
74-123
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 74 Configuring Clientless SSL VPN
Capturing Data
Detailed Steps
Command Purpose
Step 1 capture capture_name type webvpn user
webvpn_username
Starts the capture utility for clientless SSL VPN.
capture_name is a name you assign to the
capture, which is also prepended to the name of
the capture files.
webvpn_user is the username to match for
capture.
Step 2 (Optional)
no capture capture_name
Stops the capture utility from capturing packets after
a user has logged in and began a clientless SSL VPN
session.
Step 3 Open a browser and enter the following:
https://asdm_enabled_interface_of_the_security_appli
ance:port/admin/capture/capture_name/pcap
Example:
https://192.0.2.1:60000/admin/capture/hr/pcap Displays the capture named hr in a sniffer format.
Step 4 Repeat Step 2.
74-124
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 74 Configuring Clientless SSL VPN
Capturing Data
C H A P T E R
75-1
Cisco ASA 5500 Series Configuration Guide using the CLI
75
Configuring AnyConnect VPN Client Connections
This section describes how to configure AnyConnect VPN Client Connections and covers the following
topics:
Information About AnyConnect VPN Client Connections, page 75-1
Licensing Requirements for AnyConnect Connections, page 75-2
Guidelines and Limitations, page 75-5
Configuring AnyConnect Connections, page 75-5
Configuring Advanced AnyConnect Features, page 75-14
Configuration Examples for Enabling AnyConnect Connections, page 75-21
Feature History for AnyConnect Connections, page 75-21
Information About AnyConnect VPN Client Connections
The Cisco AnyConnect Secure Mobility Client provides secure SSL and IPsec/IKEv2 connections to the
ASA for remote users. Without a previously-installed client, remote users enter the IP address in their
browser of an interface configured to accept SSL or IPsec/IKEv2 VPN connections. Unless the ASA is
configured to redirect http:// requests to https://, users must enter the URL in the form https://<address>.
After entering the URL, the browser connects to that interface and displays the login screen. If the user
satisfies the login and authentication, and the ASA identifies the user as requiring the client, it
downloads the client that matches the operating system of the remote computer. After downloading, the
client installs and configures itself, establishes a secure SSL or IPsec/IKEv2 connection and either
remains or uninstalls itself (depending on the configuration) when the connection terminates.
In the case of a previously installed client, when the user authenticates, the ASA examines the revision
of the client, and upgrades the client as necessary.
When the client negotiates an SSL VPN connection with the ASA, it connects using Transport Layer
Security (TLS), and optionally, Datagram Transport Layer Security (DTLS). DTLS avoids latency and
bandwidth problems associated with some SSL connections and improves the performance of real-time
applications that are sensitive to packet delays.
The AnyConnect client can be downloaded from the ASA, or it can be installed manually on the remote
PC by the system administrator. For more information about installing the client manually, see the
Cisco AnyConnect VPN Client Administrator Guide.
75-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Licensing Requirements for AnyConnect Connections
The ASA downloads the client based on the group policy or username attributes of the user establishing
the connection. You can configure the ASA to automatically download the client, or you can configure
it to prompt the remote user about whether to download the client. In the latter case, if the user does not
respond, you can configure the ASA to either download the client after a timeout period or present the
login page.
Licensing Requirements for AnyConnect Connections
The following table shows the licensing requirements for this feature:
Note This feature is not available on No Payload Encryption models.
Model License Requirement
1,2
ASA 5505 Use one of the following:
AnyConnect Premium license:
Base license or Security Plus license: 2 sessions.
Optional permanent or time-based licenses: 10 or 25 sessions.
Shared licenses are not supported.
3
AnyConnect Essentials license
4
: 25 sessions.
ASA 5510 Use one of the following:
AnyConnect Premium license:
Base and Security Plus license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, or 250 sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 250 sessions.
ASA 5520 Use one of the following:
AnyConnect Premium license:
Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, or 750 sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 750 sessions.
75-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Licensing Requirements for AnyConnect Connections
ASA 5540 Use one of the following:
AnyConnect Premium license:
Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, or 2500
sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 2500 sessions.
ASA 5550 Use one of the following:
AnyConnect Premium license:
Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, or
5000 sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 5000 sessions.
ASA 5580 Use one of the following:
AnyConnect Premium license:
Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, 5000,
or 10000 sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 10000 sessions.
ASA 5512-X Use one of the following:
AnyConnect Premium license:
Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, or 250 sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 250 sessions.
ASA 5515-X Use one of the following:
AnyConnect Premium license:
Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, or 250 sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 250 sessions.
Model License Requirement
1,2
75-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Licensing Requirements for AnyConnect Connections
ASA 5525-X Use one of the following:
AnyConnect Premium license:
Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, or 750 sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 750 sessions.
ASA 5545-X Use one of the following:
AnyConnect Premium license:
Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, or 2500
sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 2500 sessions.
ASA 5555-X Use one of the following:
AnyConnect Premium license:
Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, or
5000 sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 5000 sessions.
ASA 5585-X with
SSP-10
Use one of the following:
AnyConnect Premium license:
Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, or
5000 sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 5000 sessions.
ASA 5585-X with
SSP-20, -40, and -60
Use one of the following:
AnyConnect Premium license:
Base license: 2 sessions.
Optional permanent or time-based licenses: 10, 25, 50, 100, 250, 500, 750, 1000, 2500, 5000,
or 10000 sessions.
Optional Shared licenses
3
: Participant or Server. For the Server license, 500-50,000 in
increments of 500 and 50,000-545,000 in increments of 1000.
AnyConnect Essentials license
4
: 10000 sessions.
Model License Requirement
1,2
75-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Guidelines and Limitations
Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Remote PC System Requirements
For the requirements of endpoint computers running the AnyConnect Secure Mobility Client, see the
release notes for the AnyConnect client version you are deploying with the ASA.
Remote HTTPS Certificates Limitation
The ASA does not verify remote HTTPS certificates.
Configuring AnyConnect Connections
This section describes prerequisites, restrictions, and detailed tasks to configure the ASA to accept
AnyConnect VPN client connections, and includes the following topics:
Configuring the ASA to Web-Deploy the Client, page 75-6
Enabling Permanent Client Installation, page 75-7
Configuring DTLS, page 75-8
Prompting Remote Users, page 75-8
1. If you start a clientless SSL VPN session and then start an AnyConnect client session from the portal, 1 session is used in total. However, if you start the
AnyConnect client first (from a standalone client, for example) and then log into the clientless SSL VPN portal, then 2 sessions are used.
2. The maximum combined VPN sessions of all types cannot exceed the maximum sessions shown in this table. For the ASA 5505, the maximum combined
sessions is 10 for the Base license, and 25 for the Security Plus license.
3. A shared license lets the ASA act as a shared license server for multiple client ASAs. The shared license pool is large, but the maximum number of sessions
used by each individual ASA cannot exceed the maximum number listed for permanent licenses.
4. The AnyConnect Essentials license enables AnyConnect VPN client access to the ASA. This license does not support browser-based SSL VPN access or
Cisco Secure Desktop. For these features, activate an AnyConnect Premium license instead of the AnyConnect Essentials license.
Note: With the AnyConnect Essentials license, VPN users can use a Web browser to log in, and download and start (WebLaunch) the AnyConnect client.
The AnyConnect client software offers the same set of client features, whether it is enabled by this license or an AnyConnect Premium SSL VPN Edition
license.
The AnyConnect Essentials license cannot be active at the same time as the following licenses on a given ASA: AnyConnect Premium license (all types)
or the Advanced Endpoint Assessment license. You can, however, run AnyConnect Essentials and AnyConnect Premium licenses on different ASAs in
the same network.
By default, the ASA uses the AnyConnect Essentials license, but you can disable it to use other licenses by using the no anyconnect-essentials command.
For a detailed list of the features supported by the AnyConnect Essentials license and AnyConnect Premium license, see AnyConnect Secure Mobility
Client Features, Licenses, and OSs:
http://www.cisco.com/en/US/products/ps10884/products_feature_guides_list.html
75-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
Enabling AnyConnect Client Profile Downloads, page 75-10
Enabling Additional AnyConnect Client Features, page 75-11
Enabling Start Before Logon, page 75-11
Translating Languages for AnyConnect User Messages, page 75-12
Configuring Advanced AnyConnect Features, page 75-14
Updating AnyConnect Client Images, page 75-18
Enabling IPv6 VPN Access, page 75-18
Configuring the ASA to Web-Deploy the Client
The section describes the steps to configure the ASA to web-deploy the AnyConnect client.
Prerequisites
Copy the client image package to the ASA using TFTP or another method.
Detailed Steps
Command Purpose
Step 1 anyconnect image filename order
Example:
hostname(config-webvpn)#anyconnect image
anyconnect-win-2.3.0254-k9.pkg 1
hostname(config-webvpn)#anyconnect image
anyconnect-macosx-i386-2.3.0254-k9.pkg 2
hostname(config-webvpn)#anyconnect image
anyconnect-linux-2.3.0254-k9.pkg 3
Identifies a file on flash as an AnyConnect client package file.
The ASA expands the file in cache memory for downloading to
remote PCs. If you have multiple clients, assign an order to the
client images with the order argument.
The ASA downloads portions of each client in the order you
specify until it matches the operating system of the remote PC.
Therefore, assign the lowest number to the image used by the
most commonly-encountered operating system.
Note You must issue the anyconnect enable command after
configuring the AnyConnect images with the anyconnect
image xyz command. If you do not enable the anyconnect
enable command, AnyConnect will not operate as
expected, and show webvpn anyconnect considers the
SSL VPN client as not enabled rather than listing the
installed AnyConnect packages.
Step 2 enable interface
Example:
hostname(config)# webvpn
hostname(config-webvpn)# enable outside
Enables SSL on an interface for clientless or AnyConnect SSL
connections.
Step 3 anyconnect enable
Without issuing this command, AnyConnect does not function as
expected, and a show webvpn anyconnect command returns that
the SSL VPN is not enabled, instead of listing the installed
AnyConnect packages.
75-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
Enabling Permanent Client Installation
Enabling permanent client installation disables the automatic uninstalling feature of the client. The client
remains installed on the remote computer for subsequent connections, reducing the connection time for
the remote user.
Note AnyConnect versions 3.0 and later do no support permanent client installation. The CLI is still available
to support older versions of AnyConnect.
To enable permanent client installation for a specific group or user, use the anyconnect keep-installer
command from group-policy or username webvpn modes:
Step 4 ip local pool poolname startaddr-endaddr
mask mask
Example:
hostname(config)# ip local pool vpn_users
209.165.200.225-209.165.200.254
mask 255.255.255.224
(Optional) Creates an address pool. You can use another method
of address assignment, such as DHCP and/or user-assigned
addressing.
Step 5 address-pool poolname
Example:
hostname(config)# tunnel-group
telecommuters general-attributes
hostname(config-tunnel-general)#
address-pool vpn_users
Assigns an address pool to a tunnel group.
Step 6 default-group-policy name
Example:
hostname(config-tunnel-general)#
default-group-policy sales
Assigns a default group policy to the tunnel group.
Step 7 group-alias name enable
Example:
hostname(config)# tunnel-group
telecommuters webvpn-attributes
hostname(config-tunnel-webvpn)#
group-alias sales_department enable
Enables the display of the tunnel-group list on the clientless portal
and AnyConnect GUI login page. The list of aliases is defined by
the group-alias name enable command.
Step 8 tunnel-group-list enable
Example:
hostname(config)# webvpn
hostname(config-webvpn)# tunnel-group-list
enable
Specifies the AnyConnect client as a permitted VPN tunneling
protocol for the group or user.
Step 9 vpn-tunnel-protocol
Example:
hostname(config)# group-policy sales
attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)#
vpn-tunnel-protocol
Specifies SSL as a permitted VPN tunneling protocol for the
group or user. You can also specify additional protocols. For more
information, see the vpn-tunnel-protocol command in the Cisco
ASA 5500 Series Command Reference.
For more information about assigning users to group policies, see
Chapter 6, Configuring Connection Profiles, Group Policies, and
Users.
Command Purpose
75-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
anyconnect keep-installer installer
The default is that permanent installation of the client is enabled. The client remains on the remote
computer at the end of the session. The following example configures the existing group-policy sales to
remove the client on the remote computer at the end of the session:
hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-policy)# anyconnect keep-installer installed none
Configuring DTLS
Datagram Transport Layer Security (DTLS) allows the AnyConnect client establishing an SSL VPN
connection to use two simultaneous tunnelsan SSL tunnel and a DTLS tunnel. Using DTLS avoids
latency and bandwidth problems associated with SSL connections and improves the performance of
real-time applications that are sensitive to packet delays.
By default, DTLS is enabled when SSL VPN access is enabled on an interface. If you disable DTLS,
SSL VPN connections connect with an SSL VPN tunnel only.
Note In order for DTLS to fall back to a TLS connection, Dead Peer Detection (DPD) must be enabled. If you
do not enable DPD, and the DTLS connection experiences a problem, the connection terminates instead
of falling back to TLS. For more information on enabling DPD, see Enabling and Adjusting Dead Peer
Detection, page 75-15
You can disable DTLS for all AnyConnect client users with the enable command tls-only option in
webvpn configuration mode:
enable <interface> tls-only
For example:
hostname(config-webvpn)# enable outside tls-only
By default, DTLS is enabled for specific groups or users with the anyconnect ssl dtls command in group
policy webvpn or username webvpn configuration mode:
[no] anyconnect ssl dtls enable
If you need to disable DTLS, use the no form of the command. For example:
hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# no anyconnect ssl dtls enable
Prompting Remote Users
You can enable the ASA to prompt remote SSL VPN client users to download the client with the
anyconnect ask command from group policy webvpn or username webvpn configuration modes:
[no] anyconnect ask {none | enable [default {webvpn | } timeout value]}
anyconnect enable prompts the remote user to download the client or go to the clientless portal page
and waits indefinitely for user response.
anyconnect ask enable default immediately downloads the client.
anyconnect ask enable default webvpn immediately goes to the portal page.
75-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
anyconnect ask enable default timeout value prompts the remote user to download the client or go to
the clientless portal page and waits the duration of value before taking the default actiondownloading
the client.
anyconnect ask enable default clientless timeout value prompts the remote user to download the client
or go to the clientless portal page, and waits the duration of value before taking the default
actiondisplaying the clientless portal page.
Figure 75-1 shows the prompt displayed to remote users when either default anyconnect timeout value
or default webvpn timeout value is configured:
Figure 75-1 Prompt Displayed to Remote Users for SSL VPN Client Download
The following example configures the ASA to prompt the user to download the client or go to the
clientless portal page and wait 10 seconds for a response before downloading the client:
hostname(config-group-webvpn)# anyconnect ask enable default anyconnect timeout 10
75-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
Enabling AnyConnect Client Profile Downloads
You enable Cisco AnyConnect Secure Mobility client features in the AnyConnect profilesXML files
that contain configuration settings for the core client with its VPN functionality and for the optional
client modules Network Access Manager (NAM), posture, telemetry, and Web Security. The ASA
deploys the profiles during AnyConnect installation and updates. Users cannot manage or modify
profiles.
Profile Editor in ASDM
You can configure a profile using the AnyConnect profile editor, a convenient GUI-based configuration
tool launched from ASDM. The AnyConnect software package for Windows, version 2.5 and later,
includes the editor, which activates when you load the AnyConnect package on the ASA and specify it
as an AnyConnect client image.
Standalone Profile Editor
We also provide a standalone version of the profile editor for Windows that you can use as an alternative
to the profile editor integrated with ASDM. If you are predeploying the client, you can use the standalone
profile editor to create profiles for the VPN service and other modules that you deploy to computers
using your software management system. For more information about using the profile editor, see the
Cisco AnyConnect Secure Mobility Client Administrator Guide.
Note The AnyConnect client protocol defaults to SSL. To enable IPsec IKEv2, you must configure the IKEv2
settings on the ASA and also configure IKEv2 as the primary protocol in the client profile. The
IKEv2enabled profile must be deployed to the endpoint computer, otherwise the client attempts to
connect using SSL. For more information, see the Cisco AnyConnect Secure Mobility Client
Administrator Guide.
Follow these steps to edit a profile and enable the ASA to download it to remote clients:
Step 1 Use the profile editor from ASDM or the standalone profile editor to create a profile. For more
information, see the Cisco AnyConnect Secure Mobility Client Administrator Guide.
Step 2 Load the profile file into flash memory on the ASA using tftp or another method.
Step 3 Use the anyconnect profiles command from webvpn configuration mode to identify the file as a client
profile to load into cache memory.
The following example specifies the files sales_hosts.xml and engineering_hosts.xml as profiles:
asa1(config-webvpn)# anyconnect profiles sales disk0:/sales_hosts.xml
asa1(config-webvpn)# anyconnect profiles engineering disk0:/engineering_hosts.xml
The profiles are now available to group policies.
You can view the profiles loaded in cache memory using the dir cache:stc/profiles command:
hostname(config-webvpn)# dir cache:/stc/profiles
Directory of cache:stc/profiles/
0 ---- 774 11:54:41 Nov 22 2006 engineering.xml
0 ---- 774 11:54:29 Nov 22 2006 sales.xml
2428928 bytes total (18219008 bytes free)
hostname(config-webvpn)#
75-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
Step 4 Enter group policy webvpn configuration mode and specify a client profile for a group policy with the
anyconnect profiles command:
You can enter the anyconnect profiles value command followed by a question mark (?) to view the
available profiles. For example:
asa1(config-group-webvpn)# anyconnect profiles value ?
config-group-webvpn mode commands/options:
Available configured profile packages:
engineering
sales
The next example configures the group policy to use the profile sales with the client profile type vpn:
asa1(config-group-webvpn)# anyconnect profiles value sales type vpn
asa1(config-group-webvpn)#
Enabling Additional AnyConnect Client Features
To minimize download time, the client only requests downloads (from the ASA) of the core modules that
it needs. As additional features become available for the AnyConnect client, you need to update the
remote clients in order for them to use the features.
To enable new features, you must specify the new module names using the anyconnect modules
command from group policy webvpn or username webvpn configuration mode:
[no] anyconnect modules {none | value string}
Separate multiple strings with commas.
For a list of values to enter for each client feature, see the release notes for the
Cisco AnyConnect VPN Client.
Enabling Start Before Logon
Start Before Logon (SBL) allows login scripts, password caching, drive mapping, and more, for the
AnyConnect client installed on a Windows PC. For SBL, you must enable the ASA to download the
module which enables graphical identification and authentication (GINA) for the AnyConnect client.
The following procedure shows how to enable SBL:
Step 1 Enable the ASA to download the GINA module for VPN connection to specific groups or users using
the anyconnect modules vpngina command from group policy webvpn or username webvpn
configuration modes.
In the following example, the user enters group-policy attributes mode for the group policy
telecommuters, enters webvpn configuration mode for the group policy, and specifies the string vpngina:
hostname(config)# group-policy telecommuters attributes
hostname(config-group-policy)# webvpn
hostame(config-group-webvpn)#anyconnect modules value vpngina
Step 2 Retrieve a copy of the client profiles file (AnyConnectProfile.tmpl).
Step 3 Edit the profiles file to specify that SBL is enabled. The example below shows the relevant portion of
the profiles file (AnyConnectProfile.tmpl) for Windows:
<Configuration>
<ClientInitialization>
75-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
<UseStartBeforeLogon>false</UseStartBeforeLogon>
</ClientInitialization>
The <UseStartBeforeLogon> tag determines whether the client uses SBL. To turn SBL on, replace false
with true. The example below shows the tag with SBL turned on:
<ClientInitialization>
<UseStartBeforeLogon>true</UseStartBeforeLogon>
</ClientInitialization>
Step 4 Save the changes to AnyConnectProfile.tmpl and update the profile file for the group or user on the ASA
using the profile command from webvpn configuration mode. For example:
asa1(config-webvpn)#anyconnect profiles sales disk0:/sales_hosts.xml
Translating Languages for AnyConnect User Messages
The ASA provides language translation for the portal and screens displayed to users that initiate
browser-based, Clientless SSL VPN connections, as well as the interface displayed to Cisco AnyConnect
VPN Client users.
This section describes how to configure the ASA to translate these user messages and includes the
following sections:
Understanding Language Translation, page 75-12
Creating Translation Tables, page 75-12
Understanding Language Translation
Functional areas and their messages that are visible to remote users are organized into translation
domains. All messages displayed on the user interface of the Cisco AnyConnect VPN Client are located
in the AnyConnect domain.
The software image package for the ASA includes a translation table template for the AnyConnect
domain. You can export the template, which creates an XML file of the template at the URL you provide.
The message fields in this file are empty. You can edit the messages and import the template to create a
new translation table object that resides in flash memory.
You can also export an existing translation table. The XML file created displays the messages you edited
previously. Reimporting this XML file with the same language name creates an new version of the
translation table object, overwriting previous messages. Changes to the translation table for the
AnyConnect domain are immediately visible to AnyConnect client users.
Creating Translation Tables
The following procedure describes how to create translation tables for the AnyConnect domain:
Step 1 Export a translation table template to a computer with the export webvpn translation-table command
from privileged EXEC mode.
In the following example, the show webvpn translation-table command shows available translation
table templates and tables.
hostname# show import webvpn translation-table
Translation Tables' Templates:
75-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
customization
AnyConnect
CSD
PortForwarder
url-list
webvpn
Citrix-plugin
RPC-plugin
Telnet-SSH-plugin
VNC-plugin
Translation Tables:
Then the user exports the translation table for the AnyConnect translation domain. The filename of the
XML file created is named client and contains empty message fields:
hostname# export webvpn translation-table AnyConnect template
tftp://209.165.200.225/client
In the next example, the user exports a translation table named zh, which was previously imported from
a template. zh is the abbreviation by Microsoft Internet Explorer for the Chinese language.
hostname# export webvpn translation-table customization language zh
tftp://209.165.200.225/chinese_client
Step 2 Edit the Translation Table XML file. The following example shows a portion of the AnyConnect
template. The end of this output includes a message ID field (msgid) and a message string field (msgstr)
for the message Connected, which is displayed on the AnyConnect client GUI when the client
establishes a VPN connection. The complete template contains many pairs of message fields:
# SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2006-11-01 16:39-0700\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=CHARSET\n"
"Content-Transfer-Encoding: 8bit\n"
#: C:\cygwin\home\<user>\cvc\main\Api\AgentIfc.cpp:23
#: C:\cygwin\home\<user>\cvc\main\Api\check\AgentIfc.cpp:22
#: C:\cygwin\home\<user>\cvc\main\Api\save\AgentIfc.cpp:23
#: C:\cygwin\home\<user>\cvc\main\Api\save\AgentIfc.cpp~:20
#: C:\cygwin\home\<user>\cvc\main\Api\save\older\AgentIfc.cpp:22
msgid "Connected"
msgstr ""
The msgid contains the default translation. The msgstr that follows msgid provides the translation. To
create a translation, enter the translated text between the quotes of the msgstr string. For example, to
translate the message Connected with a Spanish translation, insert the Spanish text between the quotes:
msgid "Connected"
msgstr "Conectado"
75-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
Be sure to save the file.
Step 3 Import the translation table using the import webvpn translation-table command from privileged
EXEC mode. Be sure to specify the name of the new translation table with the abbreviation for the
language that is compatible with the browser.
In the following example, the XML file is imported es-usthe abbreviation used by Microsoft Internet
Explorer for Spanish spoken in the United States.
hostname# import webvpn translation-table AnyConnect language es-us
tftp://209.165.200.225/client
hostname# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
hostname# show import webvpn translation-table
Translation Tables' Templates:
AnyConnect
PortForwarder
csd
customization
keepout
url-list
webvpn
Citrix-plugin
RPC-plugin
Telnet-SSH-plugin
VNC-plugin
Translation Tables:
es-us AnyConnect
Configuring Advanced AnyConnect Features
The following section describes advanced features that fine-tune AnyConnect SSL VPN connections,
and includes the following sections:
Enabling Rekey, page 75-14
Enabling and Adjusting Dead Peer Detection, page 75-15
Enabling Keepalive, page 75-16
Using Compression, page 75-16
Adjusting MTU Size, page 75-17
Configuring Session Timeouts, page 75-17
Enabling Rekey
When the ASA and the AnyConnect client client perform a rekey on an SSL VPN connection, they
renegotiate the crypto keys and initialization vectors, increasing the security of the connection.
To enable the client to perform a rekey on an SSL VPN connection for a specific group or user, use the
anyconnect ssl rekey command from group-policy or username webvpn modes.
[no]anyconnect ssl rekey {method {new-tunnel | none | ssl} | time minutes}
method new-tunnel specifies that the client establishes a new tunnel during rekey.
method ssl specifies that the client estanyablishes a new tunnel during rekey.
method none disables rekey.
75-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
Note Configuring the rekey method as ssl or new-tunnel specifies that the client establishes a new
tunnel during rekey instead of the SSL renegotiation taking place during the rekey. See the Cisco
ASA 5500 Series Command Reference, 8.4 for a history of the anyconnect ssl rekey command.
time minutes specifies the number of minutes from the start of the session, or from the last rekey, until
the rekey takes place, from 1 to 10080 (1 week).
In the following example, the client is configured to renegotiate with SSL during rekey, which takes
place 30 minutes after the session begins, for the existing group-policy sales:
hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# anyconnect ssl rekey method ssl
hostname(config-group-webvpn)# anyconnect ssl rekey time 30
Enabling and Adjusting Dead Peer Detection
Dead Peer Detection (DPD) ensures that the ASA (gateway) or the client can quickly detect a condition
where the peer is not responding, and the connection has failed.
To enable DPD on the ASA or client for a specific group or user, and to set the frequency with which
either the ASA or client performs DPD, use the anyconnect dpd-interval command from group-policy
or username webvpn mode:
anyconnect dpd-interval {[gateway {seconds | none}] | [client {seconds | none}]}
Where:
gateway seconds enables DPD performed by the ASA (gateway) and specifies the frequency, from 5 to
3600 seconds, with which the ASA (gateway) performs DPD.
gateway none disables DPD performed by the ASA.
client seconds enable DPD performed by the client, and specifies the frequency, from 5 to 3600 seconds,
with which the client performs DPD.
client none disables DPD performed by the client.
To remove the anyconnect dpd-interval command from the configuration, use the no form of the
command:
no anyconnect dpd-interval {[gateway {seconds | none}] | [client {seconds | none}]}
Note If you enable DTLS, enable Dead Peer Detection (DPD) also. DPD enables a failed DTLS connection
to fallback to TLS. Overwise, the connection terminates.
The following example sets the frequency of DPD performed by the ASA to 30 seconds, and the
frequency of DPD performed by the client set to 10 seconds for the existing group-policy sales:
hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# anyconnect dpd-interval gateway 30
hostname(config-group-webvpn)# anyconnect dpd-interval client 10
75-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
Enabling Keepalive
You can adjust the frequency of keepalive messages to ensure that an SSL VPN connection through a
proxy, firewall, or NAT device remains open, even if the device limits the time that the connection can
be idle. Adjusting the frequency also ensures that the client does not disconnect and reconnect when the
remote user is not actively running a socket-based application, such as Microsoft Outlook or Microsoft
Internet Explorer.
Note Keepalives are enabled by default. If you disable keepalives, in the event of a failover event, SSL
VPN client sessions are not carried over to the standby device.
To set the frequency of keepalive messages, use the keepalive command from group-policy webvpn or
username webvpn configuration mode:
[no] anyconnect keepalive {none | seconds}
none disables client keepalive messages.
seconds enables the client to send keepalive messages, and specifies the frequency of the messages in
the range of 15 to 600 seconds.
The default is keepalive messages are enabled.
Use the no form of the command to remove the command from the configuration and cause the value to
be inherited:
In the following example, the ASA is configured to enable the client to send keepalive messages with a
frequency of 300 seconds (5 minutes), for the existing group-policy sales:
hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)#anyconnect keepalive 300
Using Compression
Compression increases the communications performance between the ASA and the client by reducing
the size of the packets being transferred for low-bandwidth connections. By default, compression for all
SSL VPN connections is enabled on the ASA, both at the global level and for specific groups or users.
Note When implementing compression on broadband connections, you must carefully consider the fact that
compression relies on loss-less connectivity. This is the main reason that it is not enabled by default on
broadband connections.
Compression must be turned-on globally using the anyconnect ssl compression command from global
configuration mode, and then it can be set for specific groups or users with the anyconnect ssl
compression command in group-policy and username webvpn modes.
Changing Compression Globally
To change the global compression settings, use the anyconnect ssl compression command from global
configuration mode:
compression
no compression
To remove the command from the configuration, use the no form of the command.
75-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
In the following example, compression is disabled for all SSL VPN connections globally:
hostname(config)# no compression
Changing Compression for Groups and Users
To change compression for a specific group or user, use the anyconnect ssl compression command in
the group-policy and username webvpn modes:
compression {deflate | none}
no anyconnect ssl compression {deflate | none}
By default, for groups and users, SSL compression is set to deflate (enabled).
To remove the anyconnect ssl compression command from the configuration and cause the value to be
inherited from the global setting, use the no form of the command:
In the following example, compression is disabled for the group-policy sales:
hostname(config)# group-policy sales attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)#anyconnect ssl compression none
Adjusting MTU Size
You can adjust the MTU size (from 256 to 1406 bytes) for SSL VPN connections established by the
client with the anyconnect mtu command from group policy webvpn or username webvpn configuration
mode:
[no]anyconnect mtu size
This command affects only the AnyConnect client. The legacy Cisco SSL VPN Client () is not capable
of adjusting to different MTU sizes.
The default for this command in the default group policy is no anyconnect mtu. The MTU size is
adjusted automatically based on the MTU of the interface that the connection uses, minus the
IP/UDP/DTLS overhead.
This command affects client connections established in SSL and those established in SSL with DTLS.
The following example configures the MTU size to 1200 bytes for the group policy telecommuters:
hostname(config)# group-policy telecommuters attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)#anyconnect mtu 1200
Configuring Session Timeouts
You can limit how long the ASA keeps an AnyConnect VPN connection available to the user even with
no activity. If a VPN session goes idle, you can terminate the connection Terminating the AnyConnect
connection requires the user to re-authenticate their endpoint to the secure gateway and create a new
VPN connection.
The following configuration parameters terminate the VPN session based on a simple timeout:
default-idle-timeout - Terminates any user's session when the session is inactive for the specified
time. The default is 1800 seconds (30 minutes).
vpn-idle-timeout - Terminates any user's session when the session is inactive for the specified time.
For SSL-VPN only, if vpn-idle-timeout is not configured, then default-idle-timeout is used.
The following example shows how set a vpn-idle-timeout of 10 minutes, and to descrease the
default-idle-timeout to 1200 seconds (20 minutes):
75-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuring AnyConnect Connections
hostname(config)# group-policy telecommuters attributes
hostname(config-group-policy)# webvpn
hostname(config-group-webvpn)# vpn-idle-timeout 10
hostname(config-group-webvpn)# default-idle-timeout 1200
Updating AnyConnect Client Images
You can update the client images on the ASA at any time using the following procedure:
Step 1 Copy the new client images to the ASA using the copy command from privileged EXEC mode, or using
another method.
Step 2 If the new clientt image files have the same filenames as the files already loaded, reenter the anyconnect
image command that is in the configuration. If the new filenames are different, uninstall the old files
using the noanyconnect image command. Then use the anyconnect image command to assign an order
to the images and cause the ASA to load the new images.
Enabling IPv6 VPN Access
If you want to configure IPv6 access, you must use the command-line interface to configure IPv6;
ASDM does not support IPv6.
Note The ASA does not support IPv6 over IPsec IKEv2 VPN sessions.
You enable IPv6 access using the ipv6 enable command as part of enabling SSL VPN connections. The
following is an example for an IPv6 connection that enables IPv6 on the outside interface:
hostname(config)# interface GigabitEthernet0/0
hostname(config-if)# ipv6 enable
To enable IPV6 SSL VPN, do the following general actions:
1. Enable IPv6 on the outside interface.
2. Enable IPv6 and an IPv6 address on the inside interface.
3. Configure an IPv6 address local pool for client assigned IP Addresses.
4. Configure an IPv6 tunnel default gateway.
To implement this procedure, do the following steps:
Step 1 Configure Interfaces:
interface GigabitEthernet0/0
nameif outside
security-level 0
ip address 192.168.0.1 255.255.255.0
ipv6 enable ; Needed for IPv6.
!
interface GigabitEthernet0/1
nameif inside
security-level 100
ip address 10.10.0.1 255.255.0.0
ipv6 address 2001:DB8::1/32 ; Needed for IPv6.
ipv6 enable ; Needed for IPv6.
75-19
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Monitoring AnyConnect Connections
Step 2 Configure an 'ipv6 local pool' (used for IPv6 address assignment):
ipv6 local pool ipv6pool 2001:DB8:1:1::5/32 100 ; Use your IPv6 prefix here
Note You still need to configure an IPv4 address pool when using IPv6 (using the ip local pool
command)
Step 3 Add the ipv6 address pool to your tunnel group policy (or group-policy):
tunnel-group YourTunGrp1 general-attributes ipv6-address-pool ipv6pool
Note Again, you must also configure an IPv4 address pool here as well (using the 'address-pool'
command).
Step 4 Configure an IPv6 tunnel default gateway:
ipv6 route inside ::/0 X:X:X:X::X tunneled
Monitoring AnyConnect Connections
To view information about active sessions use the show vpn-sessiondb:
Examples
The Inactivity field shows the elapsed time since an AnyConnect session lost connectivity. If the session
is active, 00:00m:00s appears in this field.
hostname# show vpn-sessiondb
Session Type: SSL VPN Client
Username : lee
Index : 1 IP Addr : 209.165.200.232
Protocol : SSL VPN Client Encryption : 3DES
Hashing : SHA1 Auth Mode : userPassword
TCP Dst Port : 443 TCP Src Port : 54230
Bytes Tx : 20178 Bytes Rx : 8662
Pkts Tx : 27 Pkts Rx : 19
Client Ver : Cisco STC 1.1.0.117
Client Type : Internet Explorer
Group : DfltGrpPolicy
Login Time : 14:32:03 UTC Wed Mar 20 2007
Duration : 0h:00m:04s
Inactivity : 0h:00m:04s
Command Purpose
show vpn-sessiondb
Displays information about active sessions.
vpn-sessiondb logoff
Logs off VPN sessions.
75-20
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Logging Off AnyConnect VPN Sessions
Filter Name :
hostname# vpn-sessiondb logoff
INFO: Number of sessions of type "" logged off : 1
hostname# vpn-sessiondb logoff name tester
Do you want to logoff the VPN session(s)? [confirm]
INFO: Number of sessions with name "tester" logged off : 1
Logging Off AnyConnect VPN Sessions
To log off all VPN sessions, use the vpn-sessiondb logoff command in global configuration mode:
vpn-sessiondb logoff
The following example logs off all VPN sessions:
hostname# vpn-sessiondb logoff
INFO: Number of sessions of type logged off : 1
You can log off individual sessions using either the name argument or the index argument:
vpn-session-db logoff name name
vpn-session-db logoff index index
The sessions that have been inactive the longest time are marked as idle (and are automatically logged
off) so that license capacity is not reached and new users can log in. If the session resumes at a later time,
it is removed from the inactive list.
You can find both the username and the index number (established by the order of the client images) in
the output of the show vpn-sessiondb anyconnect command. The following examples shows the
username lee and index number 1.
hostname# show vpn-sessiondb anyconnect
Session Type: AnyConnect
Username : lee Index : 1
Assigned IP : 192.168.246.1 Public IP : 10.139.1.2
Protocol : AnyConnect-Parent SSL-Tunnel DTLS-Tunnel
License : AnyConnect Premium
Encryption : RC4 AES128 Hashing : SHA1
Bytes Tx : 11079 Bytes Rx : 4942
Group Policy : EngPolicy Tunnel Group : EngGroup
Login Time : 15:25:13 EST Fri Jan 28 2011
Duration : 0h:00m:15s
Inactivity : 0h:00m:00s
NAC Result : Unknown
VLAN Mapping : N/A VLAN : none
The following example terminates the session using the name option of the vpn-session-db logoff
command:
hostname# vpn-sessiondb logoff name lee
Do you want to logoff the VPN session(s)? [confirm]
INFO: Number of sessions with name lee logged off : 1
hostname#
75-21
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Configuration Examples for Enabling AnyConnect Connections
Configuration Examples for Enabling AnyConnect Connections
The following example shows how to configure L2TP over IPsec:
ip local pool sales_addresses 209.165.202.129-209.165.202.158
aaa-server sales_server protocol radius
crypto ipsec transform-set sales_l2tp_transform esp-3des esp-sha-hmac
crypto ipsec transform-set sales_l2tp_transform mode transport
crypto ipsec security-association lifetime seconds 28800
crypto ipsec security-association lifetime kilobytes 4608000
l2tp tunnel hello 100
group-policy sales_policy internal
group-policy sales_policy attributes
wins-server value 209.165.201.3 209.165.201.4
dns-server value 209.165.201.1 209.165.201.2
vpn-tunnel-protocol l2tp-ipsec
tunnel-group sales_tunnel type remote-access
tunnel-group sales_tunnel general-attributes
address-pool sales_addresses
authentication-server-group none
accounting-server-group sales_server
default-group-policy sales_policy
tunnel-group sales_tunnel ppp-attributes
authentication pap
Feature History for AnyConnect Connections
Table 75-1 lists the release history for this feature.
Table 75-1 Feature History for AnyConnect Connections
Feature Name Releases Feature Information
AnyConnect Connections 7.2(1) The following commands were introduced or modified: authentication
eap-proxy, authentication ms-chap-v1, authentication ms-chap-v2,
authentication pap, l2tp tunnel hello, vpn-tunnel-protocol l2tp-ipsec.
IPsec IKEv2 8.4(1) IKEv2 was added to support IPsec IKEv2 connections for AnyConnect and
LAN-to-LAN.
75-22
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 75 Configuring AnyConnect VPN Client Connections
Feature History for AnyConnect Connections
C H A P T E R
76-1
Cisco ASA 5500 Series Configuration Guide using the CLI
76
Configuring AnyConnect Host Scan
The AnyConnect Posture Module provides the AnyConnect Secure Mobility Client the ability to identify
the operating system, anti-virus, anti-spyware, and firewall software installed on the host. The Host Scan
application gathers this information.
Using the secure desktop manager tool in the Adaptive Security Device Manager (ASDM), you can
create a prelogin policy which evaluates the operating system, anti-virus, anti-spyware, and firewall
software Host Scan identifies. Based on the result of the prelogin policys evaluation, you can control
which hosts are allowed to create a remote access connection to the security appliance.
The Host Scan support chart contains the product name and version information for the anti-virus,
anti-spyware, and firewall applications you use in your prelogin policies. We deliver Host Scan and the
Host Scan support chart, as well as other components, in the Host Scan package.
Starting with AnyConnect Secure Mobility Client, release 3.0, Host Scan is available separately from
CSD. This means you can deploy Host Scan functionality without having to install CSD and you will be
able to update your Host Scan support charts by upgrading the latest Host Scan package.
Posture assessment and the AnyConnect telemetry module require Host Scan to be installed on the host.
This chapter contains the following sections:
Host Scan Dependencies and System Requirements, page 76-1
Host Scan Packaging, page 76-2
Installing and Enabling Host Scan on the ASA, page 76-3
Other Important Documentation Addressing Host Scan, page 76-7
Host Scan Dependencies and System Requirements
Dependencies
The AnyConnect Secure Mobility Client with the posture module requires these minimum ASA
components:
ASA 8.4
ASDM 6.4
These AnyConnect features require that you install the posture module.
SCEP authentication
76-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 76 Configuring AnyConnect Host Scan
Host Scan Packaging
AnyConnect Telemetry Module
System Requirements
The posture module can be installed on any of these platforms:
Windows XP (x86 and x86 running on x64)
Windows Vista (x86 and x86 running on x64)
Windows 7 (x86 and x86 running on x64)
Mac OS X 10.5,10.6 (32-bit and 32-bit running on 64-bit)
Linux (32-bit and 32-bit running on 64-bit)
Windows Mobile
Licensing
These are the AnyConnect licensing requirements for the posture module:
AnyConnect Premium for basic Host Scan.
Advanced Endpoint Assessment license is required for
Remediation
Mobile Device Management
Host Scan Packaging
You can load the Host Scan package on to the ASA in one of these ways:
You can upload it as a standalone package: hostscan-version.pkg
You can upload it by uploading an AnyConnect Secure Mobility package:
anyconnect-NGC-win-version-k9.pkg
You can upload it by uploading a Cisco Secure Desktop package: csd_version-k9.pkg
Table 76-1 Host Scan Packages You Load to the ASA
File Description
hostscan-version.pkg This file contains the Host Scan software as well as the Host
Scan library and support charts.
anyconnect-NGC-win-version-k9.pkg This package contains all the Cisco AnyConnect Secure
Mobility Client features including the hostscan-version.pkg
file.
csd_version-k9.pkg This file contains all Cisco Secure Desktop features
including Host Scan software as well as the Host Scan
library and support charts.
This method requires a separate license for Cisco Secure
Desktop.
76-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 76 Configuring AnyConnect Host Scan
Installing and Enabling Host Scan on the ASA
Installing and Enabling Host Scan on the ASA
These tasks describe installing and enabling Host Scan on the ASA:
Installing or Upgrading Host Scan
Enabling or Disabling a Host Scan
Viewing the Host Scan Version Enabled on the ASA
Uninstalling Host Scan
Assigning AnyConnect Feature Modules to Group Policies
Installing or Upgrading Host Scan
Use this procedure to install or upgrade the Host Scan package and enable it using the command line
interface for the ASA.
Prerequisites
Log on to the ASA and enter global configuration mode. In global configuration mode, the ASA
displays this prompt: hostname(config)#
Upload the hostscan_version-k9.pkg file or anyconnect-NGC-win-version-k9.pkg file to the ASA.
Detailed Steps
Command Purpose
Step 1 webvpn
Example:
hostname(config)# webvpn
Enter webvpn configuration mode.
Step 2 csd hostscan image path
Example:
ASAName(webvpn)#csd hostscan image
disk0:/hostscan-3.6.0-k9.pkg
ASAName(webvpn)#csd hostscan image
disk0:/anyconnect-NGC-win-3.0.0327-k9.pkg
Specify the path to the package you want to designate as the
Host Scan image. You can specify a standalone Host Scan
package or an AnyConnect Secure Mobility Client package as
the Host Scan package.
Note For all operating systems, Windows, Linux, and
Mac OS X, customers need to upload the
anyconnect-NGC-win-version-k9.pkg file in order for
the endpoints to install Host Scan.
Step 3 csd enable
Example:
ASAName(webvpn)#csd enable
Enables the Host Scan image you designated in the previous
step.
Step 4 write memory
Example:
hostname(webvpn)# write memory
Saves the running configuration to flash.
After successfully saving the new configuration to flash
memory, you receive the message [OK].
76-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 76 Configuring AnyConnect Host Scan
Installing and Enabling Host Scan on the ASA
Enabling or Disabling a Host Scan
These commands enable or disable an installed Host Scan image using the command line interface of
the ASA.
Prerequisites
Log on to the ASA and enter global configuration mode. In global configuration mode, the ASA displays
this prompt: hostname(config)#
Detailed Steps for Enabling Host Scan
Detailed Steps for Disabling Host Scan
Command Purpose
Step 1 webvpn
Example:
hostname(config)# webvpn
Enter webvpn configuration mode.
Step 2 csd enable
Example:
hostname(config)# csd enable
Enables the standalone Host Scan image or the Host Scan image
in the AnyConnect Secure Mobility Client package if they have
not been uninstalled from your ASA. If neither of those types of
packages is installed and a CSD package is installed, this enables
the Host Scan function in the CSD package.
Command Purpose
Step 1 webvpn
Example:
hostname(config)# webvpn
Enter webvpn configuration mode.
Step 2 no csd enable
Example:
hostname(config)# no csd enable
Disables Host Scan for all installed Host Scan packages.
Note Before you uninstall the enabled Host Scan image, you
must first disable Host Scan using this command.
76-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 76 Configuring AnyConnect Host Scan
Installing and Enabling Host Scan on the ASA
Viewing the Host Scan Version Enabled on the ASA
Use this procedure to determine the enabled Host Scan version using ASAs command line interface.
Prerequisites
Log on to the ASA and enter privileged exec mode. In privileged exec mode, the ASA displays this
prompt: hostname#
Uninstalling Host Scan
Uninstalling Host Scan package removes it from view on the ASDM interface and prevents the ASA
from deploying it even if Host Scan or CSD is enabled. Uninstalling Host Scan does not delete the Host
Scan package from the flash drive.
Prerequisites
Log on to the ASA and enter global configuration mode. In global configuration mode, the ASA displays
this prompt: hostname(config)#.
Detailed Steps
Command Purpose
show webvpn csd hostscan
Example:
hostname# show webvpn csd hostscan
Show the version of Host Scan enabled on the ASA.
Command Purpose
Step 1 webvpn
Example:
hostname(config)# webvpn
Enter webvpn configuration mode.
Step 2 no csd enable
Example:
ASAName(webvpn)#no csd enable
Disables the Host Scan image you want to uninstall.
Step 3 no csd hostscan image path
Example:
hostname(webvpn)#no csd hostscan image
disk0:/hostscan-3.6.0-k9.pkg
hostname(webvpn)#no csd hostscan image
disk0:/anyconnect-NGC-win-3.0.0327-k9.pkg
Specifies the path to the Host Scan image you want to
uninstall. A standalone Host Scan package or an
AnyConnect Secure Mobility Client package may have
been designated as the Host Scan package.
76-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 76 Configuring AnyConnect Host Scan
Installing and Enabling Host Scan on the ASA
Assigning AnyConnect Feature Modules to Group Policies
This procedure associates AnyConnect feature modules with a group policy. When VPN users connect
to the ASA, the ASA downloads and installs these AnyConnect feature modules to their endpoint
computer.
Prerequisites
Log on to the ASA and enter global configuration mode. In global configuration mode, the ASA displays
this prompt: hostname(config)#
Detailed Steps
Step 4 write memory
Example:
hostname(webvpn)# write memory
Saves the running configuration to flash.
After successfully saving the new configuration to flash
memory, you receive the message [OK].
Command Purpose
Command Purpose
Step 1 group-policy name internal
Example:
hostname(config)# group-policy PostureModuleGroup
internal
Adds an internal group policy for Network Client Access
Step 2 group-policy name attributes
Example:
hostname(config)# group-policy PostureModuleGroup
attributes
Edits the new group policy. After entering the command,
you receive the prompt for group policy configuration
mode, hostname(config-group-policy)#.
Step 3 webvpn
Example:
hostname(config-group-policy)# webvpn
Enters group policy webvpn configuration mode. After
you enter the command, the ASA returns this prompt:
hostname(config-group-webvpn)#
76-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 76 Configuring AnyConnect Host Scan
Other Important Documentation Addressing Host Scan
Other Important Documentation Addressing Host Scan
Once Host Scan gathers the posture credentials from the endpoint computer, you will need to understand
subjects like, configuring prelogin policies, configuring dynamic access policies, and using Lua
expressions to make use of the information.
These topics are covered in detail in these documents:
Cisco Secure Desktop Configuration Guides
Cisco Adaptive Security Device Manager Configuration Guides
See also the Cisco AnyConnect Secure Mobility Client Administrator Guide, Release 3.0 for more
information about how Host Scan works with AnyConnect clients.
Step 4 hostname(config-group-webvpn)# anyconnect modules
value AnyConnect Module Name
Example:
hostname(config-group-webvpn)# anyconnect modules
value websecurity,telemetry,posture
Configures the group policy to download AnyConnect
feature modules for all users in the group. The value of
the anyconnect module command can contain one or
more of the following values. When specifying more than
one module, separate the values with a comma.
value AnyConnect Module Name
dart AnyConnect DART (Diagnostics and
Reporting Tool)
nam AnyConnect Network Access Manager
vpngina AnyConnect SBL (Start Before Logon)
websecurity AnyConnect Web Security Module
telemetry AnyConnect Telemetry Module
posture AnyConnect Posture Module
none Used by itself to remove all AnyConnect
modules from the group policy.
To remove one of the modules, re-send the command
specifying only the module values you want to keep. For
example, this command removes the websecurity
module:
hostname(config-group-webvpn)# anyconnect modules
value telemetry,posture
Step 5 write memory
Example:
hostname(config-group-webvpn)# write memory
Saves the running configuration to flash.
After successfully saving the new configuration to flash
memory, you receive the message [OK] and the ASA
returns you to this prompt:
hostname(config-group-webvpn)#
Command Purpose
76-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 76 Configuring AnyConnect Host Scan
Other Important Documentation Addressing Host Scan
P A R T 1 7
Configuring Logging, SNMP, and Smart
Call Home
C H A P T E R
77-1
Cisco ASA 5500 Series Configuration Guide using the CLI
77
Configuring Logging
This chapter describes how to configure and manage logs for the ASA and includes the following
sections:
Information About Logging, page 77-1
Licensing Requirements for Logging, page 77-5
Prerequisites for Logging, page 77-5
Guidelines and Limitations, page 77-5
Configuring Logging, page 77-6
Monitoring the Logs, page 77-19
Configuration Examples for Logging, page 77-20
Feature History for Logging, page 77-20
Information About Logging
System logging is a method of collecting messages from devices to a server running a syslog daemon.
Logging to a central syslog server helps in aggregation of logs and alerts. Cisco devices can send their
log messages to a UNIX-style syslog service. A syslog service accepts messages and stores them in files,
or prints them according to a simple configuration file. This form of logging provides protected
long-term storage for logs. Logs are useful both in routine troubleshooting and in incident handling.
The ASA system logs provide you with information for monitoring and troubleshooting the ASA. With
the logging feature, you can do the following:
Specify which syslog messages should be logged.
Disable or change the severity level of a syslog message.
Specify one or more locations where syslog messages should be sent, including an internal buffer,
one or more syslog servers, ASDM, an SNMP management station, specified e-mail addresses, or
to Telnet and SSH sessions.
Configure and manage syslog messages in groups, such as by severity level or class of message.
Specify whether or not a rate-limit is applied to syslog generation.
Specify what happens to the contents of the internal log buffer when it becomes full: overwrite the
buffer, send the buffer contents to an FTP server, or save the contents to internal flash memory.
Filter syslog messages by locations, severity level, class, or a custom message list.
77-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Information About Logging
This section includes the following topics:
Logging in Multiple Context Mode, page 77-2
Analyzing Syslog Messages, page 77-2
Syslog Message Format, page 77-3
Severity Levels, page 77-3
Message Classes and Range of Syslog IDs, page 77-4
Filtering Syslog Messages, page 77-4
Using Custom Message Lists, page 77-4
Logging in Multiple Context Mode
Each security context includes its own logging configuration and generates its own messages. If you log
in to the system or admin context, and then change to another context, messages you view in your session
are only those messages that are related to the current context.
Syslog messages that are generated in the system execution space, including failover messages, are
viewed in the admin context along with messages generated in the admin context. You cannot configure
logging or view any logging information in the system execution space.
You can configure the ASA to include the context name with each message, which helps you differentiate
context messages that are sent to a single syslog server. This feature also helps you to determine which
messages are from the admin context and which are from the system; messages that originate in the
system execution space use a device ID of system, and messages that originate in the admin context use
the name of the admin context as the device ID.
Analyzing Syslog Messages
The following are some examples of the type of information you can obtain from a review of various
syslog messages:
Connections that are allowed by ASA security policies. These messages help you spot holes that
remain open in your security policies.
Connections that are denied by ASA security policies. These messages show what types of activity
are being directed toward your secured inside network.
Using the ACE deny rate logging feature shows attacks that are occurring on your ASA.
IDS activity messages can show attacks that have occurred.
User authentication and command usage provide an audit trail of security policy changes.
Bandwidth usage messages show each connection that was built and torn down as well as the
duration and traffic volume used.
Protocol usage messages show the protocols and port numbers used for each connection.
Address translation audit trail messages record NAT or PAT connections being built or torn down,
which are useful if you receive a report of malicious activity coming from inside your network to
the outside world.
77-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Information About Logging
Syslog Message Format
Syslog messages begin with a percent sign (%) and are structured as follows:
%ASA Level Message_number: Message_text
Field descriptions are as follows:
Severity Levels
Table 77-1 lists the syslog message severity levels. You can assign custom colors to each of the severity
levels to make it easier to distinguish them in the ASDM log viewers. To configure syslog message color
settings, either choose the Tools > Preferences > Syslog tab or, in the log viewer itself, click Color
Settings on the toolbar.
Note The ASA does not generate syslog messages with a severity level of zero (emergencies). This level is
provided in the logging command for compatibility with the UNIX syslog feature but is not used by the
ASA.
ASA The syslog message facility code for messages that are generated by the ASA. This
value is always ASA.
Level 1 through 7. The level reflects the severity of the condition described by the syslog
messagethe lower the number, the more severe the condition. See Table 77-1 for
more information.
Message_number A unique six-digit number that identifies the syslog message.
Message_text A text string that describes the condition. This portion of the syslog message
sometimes includes IP addresses, port numbers, or usernames.
Table 77-1 Syslog Message Severity Levels
Level Number Severity Level Description
0 emergencies System is unusable.
1 alert Immediate action is needed.
2 critical Critical conditions.
3 error Error conditions.
4 warning Warning conditions.
5 notification Normal but significant conditions.
6 informational Informational messages only.
7 debugging Debugging messages only.
77-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Information About Logging
Message Classes and Range of Syslog IDs
For a list of syslog message classes and the ranges of syslog message IDs that are associated with each
class, see the syslog message guide.
Filtering Syslog Messages
You can filter generated syslog messages so that only certain syslog messages are sent to a particular
output destination. For example, you could configure the ASA to send all syslog messages to one output
destination and to send a subset of those syslog messages to a different output destination.
Specifically, you can configure the ASA so that syslog messages are directed to an output destination
according to the following criteria:
Syslog message ID number
Syslog message severity level
Syslog message class (equivalent to a functional area of the ASA)
You customize these criteria by creating a message list that you can specify when you set the output
destination. Alternatively, you can configure the ASA to send a particular message class to each type of
output destination independently of the message list.
You can use syslog message classes in two ways:
Specify an output location for an entire category of syslog messages using the logging class
command.
Create a message list that specifies the message class using the logging list command.
The syslog message class provides a method of categorizing syslog messages by type, equivalent to a
feature or function of the ASA. For example, the vpnc class denotes the VPN client.
All syslog messages in a particular class share the same initial three digits in their syslog message ID
numbers. For example, all syslog message IDs that begin with the digits 611 are associated with the vpnc
(VPN client) class. Syslog messages associated with the VPN client feature range from 611101 to
611323.
In addition, most of the ISAKMP syslog messages have a common set of prepended objects to help
identify the tunnel. These objects precede the descriptive text of a syslog message when available. If the
object is not known at the time that the syslog message is generated, the specific heading = value
combination does not appear.
The objects are prefixed as follows:
Group = groupname, Username = user, IP = IP_address
Where the group is the tunnel-group, the username is the username from the local database or AAA
server, and the IP address is the public IP address of the remote access client or L2L peer.
Using Custom Message Lists
Creating a custom message list is a flexible way to exercise control over which syslog messages are sent
to which output destination. In a custom syslog message list, you specify groups of syslog messages
using any or all of the following criteria: severity level, message IDs, ranges of syslog message IDs, or
message class.
For example, you can use message lists to do the following:
77-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Licensing Requirements for Logging
Select syslog messages with the severity levels of 1 and 2 and send them to one or more e-mail
addresses.
Select all syslog messages associated with a message class (such as ha) and save them to the internal
buffer.
A message list can include multiple criteria for selecting messages. However, you must add each
message selection criterion with a new command entry. It is possible to create a message list that
includes overlapping message selection criteria. If two criteria in a message list select the same message,
the message is logged only once.
Licensing Requirements for Logging
The following table shows the licensing requirements for this feature:
Prerequisites for Logging
Logging has the following prerequisites:
The syslog server must run a server program called syslogd. Windows (except for Windows 95 and
Windows 98) provides a syslog server as part of its operating system. For Windows 95 and Windows
98, you must obtain a syslogd server from another vendor.
To view logs generated by the ASA, you must specify a logging output destination. If you enable
logging without specifying a logging output destination, the ASA generates messages but does not
save them to a location from which you can view them. You must specify each different logging
output destination separately. For example, to designate more than one syslog server as an output
destination, enter a new command for each syslog server.
Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
Supported in single and multiple context modes.
Firewall Mode Guidelines
Supported in routed and transparent firewall modes.
IPv6 Guidelines
Does not support IPv6.
Additional Guidelines
Sending syslogs over TCP is not supported on a standby ASA.
Model License Requirement
All models Base License.
77-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
The ASA supports the configuration of 16 syslog servers with the logging host command in single
context mode. In multiple context mode, the limitation is 4 servers per context.
Configuring Logging
This section describes how to configure logging and includes the following topics:
Enabling Logging, page 77-6
Configuring an Output Destination, page 77-6
Note The minimum configuration depends on what you want to do and what your requirements are for
handling syslog messages in the ASA.
Enabling Logging
To enable logging, enter the following command:
What to Do Next
See the Configuring an Output Destination section on page 77-6.
Configuring an Output Destination
To optimize syslog message usage for troubleshooting and performance monitoring, we recommend that
you specify one or more locations where syslog messages should be sent, including an internal log
buffer, one or more external syslog servers, ASDM, an SNMP management station, the console port,
specified e-mail addresses, or Telnet and SSH sessions.
This section includes the following topics:
Sending Syslog Messages to an External Syslog Server, page 77-8
Sending Syslog Messages to the Internal Log Buffer, page 77-9
Sending Syslog Messages to an E-mail Address, page 77-10
Sending Syslog Messages to ASDM, page 77-11
Sending Syslog Messages to the Console Port, page 77-11
Sending Syslog Messages to an SNMP Server, page 77-11
Sending Syslog Messages to a Telnet or SSH Session, page 77-12
Creating a Custom Event List, page 77-13
Command Purpose
logging enable
Example:
hostname(config)# logging enable
Enables logging. To disable logging, enter the no logging
enable command.
77-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Generating Syslog Messages in EMBLEM Format to a Syslog Server, page 77-14
Generating Syslog Messages in EMBLEM Format to Other Output Destinations, page 77-14
Changing the Amount of Internal Flash Memory Available for Logs, page 77-15
Configuring the Logging Queue, page 77-15
Sending All Syslog Messages in a Class to a Specified Output Destination, page 77-16
Enabling Secure Logging, page 77-16
Including the Device ID in Non-EMBLEM Format Syslog Messages, page 77-17
Including the Date and Time in Syslog Messages, page 77-18
Disabling a Syslog Message, page 77-18
Changing the Severity Level of a Syslog Message, page 77-18
Limiting the Rate of Syslog Message Generation, page 77-19
77-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Sending Syslog Messages to an External Syslog Server
You can archive messages according to the available disk space on the external syslog server, and
manipulate logging data after it is saved. For example, you could specify actions to be executed when
certain types of syslog messages are logged, extract data from the log and save the records to another
file for reporting, or track statistics using a site-specific script.
To send syslog messages to an external syslog server, perform the following steps:
Command Purpose
Step 1 logging host interface_name syslog_ip
[tcp[/port] | udp[/port] [format emblem]]
Example:
hostname(config)# logging host dmz1
192.168.1.5 udp 1026 format emblem
Configures the ASA to send messages to a syslog server.
The format emblem keyword enables EMBLEM format
logging for the syslog server with UDP only. The
interface_name argument specifies the interface through
which you access the syslog server. The syslog_ip argument
specifies the IP address of the syslog server. The tcp[/port] or
udp[/port] keyword and argument pair specify that the ASA
and ASASM should use TCP or UDP to send syslog messages
to the syslog server.
You can configure the ASA to send data to a syslog server
using either UDP or TCP, but not both. The default protocol is
UDP if you do not specify a protocol.
If you specify TCP, the ASA discover when the syslog server
fails and as a security protection, new connections through the
ASA are blocked. To allow new connections regardless of
connectivity to a TCP syslog server, see Step 3. If you specify
UDP, the ASA continue to allow new connections whether or
not the syslog server is operational. Valid port values for
either protocol are 1025 through 65535. The default UDP port
is 514. The default TCP port is 1470.
Step 2 logging trap {severity_level | message_list}
Example:
hostname(config)# logging trap errors
Specifies which syslog messages should be sent to the syslog
server. You can specify the severity level number (1 through
7) or name. For example, if you set the severity level to 3, then
the ASA send syslog messages for severity levels 3, 2, and 1.
You can specify a custom message list that identifies the
syslog messages to send to the syslog server.
Step 3 logging permit-hostdown
Example:
hostname(config)# logging permit-hostdown
(Optional) Disables the feature to block new connections
when a TCP-connected syslog server is down. If the ASA is
configured to send syslog messages to a TCP-based syslog
server, and if either the syslog server is down or the log queue
is full, then new connections are blocked. New connections
are allowed again after the syslog server is back up and the log
queue is no longer full. For more information about the log
queue, see the Configuring the Logging Queue section on
page 77-15.
Step 4 logging facility number
Example:
hostname(config)# logging facility 21
(Optional) Sets the logging facility to a value other than 20,
which is what most UNIX systems expect.
77-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Sending Syslog Messages to the Internal Log Buffer
To send syslog messages to the internal log buffer, perform the following steps:
Command Purpose
Step 1 logging buffered {severity_level | message_list}
Example:
hostname(config)# logging buffered critical
hostname(config)# logging buffered level 2
hostname(config)# logging buffered notif-list
Specifies which syslog messages should be sent to
the internal log buffer, which serves as a temporary
storage location. New messages are appended to the
end of the list. When the buffer is full, that is, when
the buffer wraps, old messages are overwritten as new
messages are generated, unless you configure the
ASA to save the full buffer to another location. To
empty the internal log buffer, enter the clear logging
buffer command.
Step 2 logging buffer-size bytes
Example:
hostname(config)# logging buffer-size 16384
Changes the size of the internal log buffer. The buffer
size is 4 KB.
Step 3 Choose one of the following options:
logging flash-bufferwrap
Example:
hostname(config)# logging flash-bufferwrap
When saving the buffer content to another location,
the ASA create log files with names that use the
following time-stamp format:
LOG-YYYY-MM-DD-HHMMSS.TXT
where YYYY is the year, MM is the month, DD is the
day of the month, and HHMMSS is the time in hours,
minutes, and seconds.
The ASA continues to save new messages to the
internal log buffer and saves the full log buffer
content to the internal flash memory.
logging ftp-bufferwrap
Example:
hostname(config)# logging ftp-bufferwrap
When saving the buffer content to another location,
the ASA creates log files with names that use the
following time-stamp format:
LOG-YYYY-MM-DD-HHMMSS.TXT
where YYYY is the year, MM is the month, DD is the
day of the month, and HHMMSS is the time in hours,
minutes, and seconds.
The ASA continues saving new messages to the
internal log buffer and saves the full log buffer
content to an FTP server.
77-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Sending Syslog Messages to an E-mail Address
To send syslog messages to an e-mail address, perform the following steps:
logging ftp-server server path username password
Example:
hostname(config)# logging ftp-server 10.1.1.1
/syslogs logsupervisor 1luvMy10gs
Identifies the FTP server on which you want to store
log buffer content. The server argument specifies the
IP address of the external FTP server. The path
argument specifies the directory path on the FTP
server where the log buffer data is to be saved. This
path is relative to the FTP root directory. The
username argument specifies a username that is valid
for logging into the FTP server. The password
argument indicates the password for the username
specified.
logging savelog [savefile]
Example:
hostname(config)# logging savelog latest-logfile.txt
Saves the current log buffer content to the internal
flash memory.
Command Purpose
Command Purpose
Step 1 logging mail {severity_level | message_list}
Example:
hostname(config)# logging mail high-priority
Specifies which syslog messages should be sent to an e-mail
address. When sent by e-mail, the device name appears in the
subject line of the e-mail message and the syslog message
appears in the body of the e-mail message. For this reason, we
recommend configuring this option to notify administrators of
syslog messages with high severity levels, such as critical,
alert, and emergency.
Step 2 logging from-address email_address
Example:
hostname(config)# logging from-address
xxx-001@example.com
Specifies the source e-mail address to be used when sending
syslog messages to an e-mail address.
Step 3 logging recipient-address e-mail_address
[severity_level]
Example:
hostname(config)# logging recipient-address
admin@example.com
Specifies the recipient e-mail address to be used when sending
syslog messages to an e-mail address.
Step 4 smtp-server ip_address
Example:
hostname(config)# smtp-server 10.1.1.1
Specifies the SMTP server to be used when sending syslog
messages to an e-mail address.
77-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Sending Syslog Messages to ASDM
To send syslog messages to ASDM, perform the following steps:
Sending Syslog Messages to the Console Port
To send syslog messages to the console port, enter the following command:
Sending Syslog Messages to an SNMP Server
To enable logging to an SNMP server, enter the following command:
Command Purpose
Step 1 logging asdm {severity_level | message_list}
Example:
hostname(config)# logging asdm 2
Specifies which syslog messages should be sent to
ASDM. The ASA sets aside a buffer area for syslog
messages waiting to be sent to ASDM and saves
messages in the buffer as they occur. The ASDM log
buffer is a different buffer than the internal log buffer.
When the ASDM log buffer is full, the ASA deletes
the oldest syslog message to make room in the buffer
for new ones. Deletion of the oldest syslog message
to make room for new ones is the default setting in
ASDM. To control the number of syslog messages
retained in the ASDM log buffer, you can change the
size of the buffer.
Step 2 logging asdm-buffer-size num_of_msgs
Example:
hostname(config)# logging asdm-buffer-size 200
Specifies the number of syslog messages to be
retained in the ASDM log buffer. To empty the
current content of the ASDM log buffer, enter the
clear logging asdm command.
Command Purpose
logging console {severity_level | message_list}
Example:
hostname(config)# logging console errors
Specifies which syslog messages should be sent to the console
port.
Command Purpose
logging history [logging_list | level]
Example:
hostname(config)# logging history errors
Enables SNMP logging and specifies which messages are to
be sent to SNMP servers. To disable SNMP logging, enter the
no logging history command.
77-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Sending Syslog Messages to a Telnet or SSH Session
To send syslog messages to a Telnet or SSH session, perform the following steps:
Command Purpose
Step 1 logging monitor {severity_level | message_list}
Example:
hostname(config)# logging monitor 6
Specifies which syslog messages should be sent to a
Telnet or SSH session.
Step 2 terminal monitor
Example:
hostname(config)# terminal monitor
Enables logging to the current session only. If you log
out and then log in again, you need to reenter this
command. To disable logging to the current session,
enter the terminal no monitor command.
77-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Creating a Custom Event List
To create a custom event list, perform the following steps:
Command Purpose
Step 1 logging list name {level level [class message_class]
| message start_id[-end_id]}
Example:
hostname(config)# logging list notif-list level 3
Specifies criteria for selecting messages to be saved
in the internal log buffer. For example, if you set the
severity level to 3, then the ASA sends syslog
messages for severity levels 3, 2, and 1.
The name argument specifies the name of the list. The
level level keyword and argument pair specify the
severity level. The class message_class keyword and
argument pair specify a particular message class. The
message start_id[-end_id] keyword and argument
pair specify an individual syslog message number or
a range of numbers.
Note Do not use the names of severity levels as the
name of a syslog message list. Prohibited
names include emergencies, alert, critical,
error, warning, notification, informational,
and debugging. Similarly, do not use the first
three characters of these words at the
beginning of an event list name. For example,
do not use an event list name that starts with
the characters err.
Step 2 logging list name {level level [class message_class]
| message start_id[-end_id]}
Example:
hostname(config)# logging list notif-list message
104024-105999
hostname(config)# logging list notif-list level
critical
hostname(config)# logging list notif-list level
warning class ha
(Optional) Adds more criteria for message selection
to the list. Enter the same command as in the previous
step, specifying the name of the existing message list
and the additional criterion. Enter a new command for
each criterion that you want to add to the list. For
example, you can specify criteria for syslog messages
to be included in the list as the following:
Syslog message IDs that fall into the range of
104024 to 105999.
All syslog messages with the critical severity
level or higher (emergency, alert, or critical).
All ha class syslog messages with the warning
severity level or higher (emergency, alert,
critical, error, or warning).
Note A syslog message is logged if it satisfies any
of these conditions. If a syslog message
satisfies more than one of the conditions, the
message is logged only once.
77-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Generating Syslog Messages in EMBLEM Format to a Syslog Server
To generate syslog messages in EMBLEM format to a syslog server, enter the following command:
Generating Syslog Messages in EMBLEM Format to Other Output Destinations
To generate syslog messages in EMBLEM format to other output destinations, enter the following
command:
Command Purpose
logging host interface_name ip_address
{tcp[/port] | udp[/port]] [format emblem]
Example:
hostname(config)# logging host interface_1 127.0.0.1
udp format emblem
Sends syslog messages in EMBLEM format to a syslog server
over UDP using port 514.
The format emblem keyword enables EMBLEM format
logging for the syslog server (UDP only). The interface_name
argument specifies the interface through which you access the
syslog server. The ip_address argument specifies the IP
address of the syslog server. The tcp[/port] or udp[/port]
keyword and argument pair specify that the ASA should use
TCP or UDP to send syslog messages to the syslog server.
You can configure the ASA to send data to a syslog server
using either UDP or TCP, but not both. The default protocol is
UDP if you do not specify a protocol.
You can use multiple logging host commands to specify
additional servers that would all receive syslog messages. If
you configure two or more logging servers, make sure that you
limit the logging severity level to warnings for all logging
servers.
If you specify TCP, the ASA discovers when the syslog server
fails and as a security protection, new connections through the
ASA are blocked. If you specify UDP, the ASA continues to
allow new connections whether or not the syslog server is
operational. Valid port values for either protocol are 1025
through 65535. The default UDP port is 514. The default TCP
port is 1470.
Note Sending syslogs over TCP is not supported on a
standby ASA.
Command Purpose
logging emblem
Example:
hostname(config)# logging emblem
Sends syslog messages in EMBLEM format to output
destinations other than a syslog server, such as Telnet or SSH
sessions.
77-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Changing the Amount of Internal Flash Memory Available for Logs
To change the amount of internal flash memory available for logs, perform the following steps:
Configuring the Logging Queue
To configure the logging queue, enter the following command:
Command Purpose
Step 1 logging flash-maximum-allocation kbytes
Example:
hostname(config)# logging
flash-maximum-allocation 1200
Specifies the maximum amount of internal flash memory
available for saving log files. By default, the ASA can use up
to 1 MB of internal flash memory for log data. The minimum
amount of internal flash memory that must be free for the
ASAto save log data is 3 MB.
If a log file being saved to internal flash memory would cause
the amount of free internal flash memory to fall below the
configured minimum limit, the ASA deletes the oldest log
files to ensure that the minimum amount of memory remains
free after saving the new log file. If there are no files to delete
or if, after all old files have been deleted, free memory is still
below the limit, the ASA fails to save the new log file.
Step 2 logging flash-minimum-free kbytes
Example:
hostname(config)# logging flash-minimum-free
4000
Specifies the minimum amount of internal flash memory that
must be free for the ASA to save a log file.
Command Purpose
logging queue message_count
Example:
hostname(config)# logging queue 300
Specifies the number of syslog messages that the ASA can
hold in its queue before sending them to the configured output
destination. The ASAhas a fixed number of blocks in memory
that can be allocated for buffering syslog messages while they
are waiting to be sent to the configured output destination. The
number of blocks required depends on the length of the syslog
message queue and the number of syslog servers specified.
The default queue size is 512 syslog messages. The queue size
is limited only by block memory availability. Valid values are
from 0 to 8192 messages, depending on the platform. If the
logging queue is set to zero, the queue is the maximum
configurable size (8192 messages), depending on the
platform. The maximum queue size by platform is as follows:
ASA-55051024
ASA-55102048
On all other platforms8192
77-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Sending All Syslog Messages in a Class to a Specified Output Destination
To send all syslog messages in a class to a specified output destination, enter the following command:
Enabling Secure Logging
To enable secure logging, enter the following command:
Command Purpose
logging class message_class {buffered | console |
history | mail | monitor | trap} [severity_level]
Example:
hostname(config)# logging class ha buffered alerts
Overrides the configuration in the specified output destination
command. For example, if you specify that messages at
severity level 7 should go to the internal log buffer and that ha
class messages at severity level 3 should go to the internal log
buffer, then the latter configuration takes precedence. The
buffered, history, mail, monitor, and trap keywords specify
the output destination to which syslog messages in this class
should be sent. The history keyword enables SNMP logging.
The monitor keyword enables Telnet and SSH logging. The
trap keyword enables syslog server logging. Select one
destination per command line entry. To specify that a class
should go to more than one destination, enter a new command
for each output destination.
Command Purpose
logging host interface_name syslog_ip [tcp/port |
udp/port] [format emblem] [secure]
Example:
hostname(config)# logging host inside 10.0.0.1
TCP/1500 secure
Enables secure logging.
The interface_name argument specifies the interface on which
the syslog server resides. The syslog_ip argument specifies the
IP address of the syslog server. The port argument specifies the
port (TCP or UDP) that the syslog server listens to for syslog
messages. The tcp keyword specifies that the ASA should use
TCP to send syslog messages to the syslog server. The udp
keyword specifies that the ASA should use UDP to send syslog
messages to the syslog server. The format emblem keyword
enables EMBLEM format logging for the syslog server. The
secure keyword specifies that the connection to the remote
logging host should use SSL/TLS for TCP only.
Note Secure logging does not support UDP; an error occurs
if you try to use this protocol.
77-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Including the Device ID in Non-EMBLEM Format Syslog Messages
To include the device ID in non-EMBLEM format syslog messages, enter the following command:
Command Purpose
logging device-id [context-name | hostname |
ipaddress interface_name | string text]
Example:
hostname(config)# logging device-id hostname
hostname(config)# logging device-id context-name
Configures the ASA to include a device ID in
non-EMBLEM-format syslog messages. You can specify only
one type of device ID for syslog messages.The context-name
keyword indicates that the name of the current context should
be used as the device ID (applies to multiple context mode
only). If you enable the logging device ID for the admin
context in multiple context mode, messages that originate in
the system execution space use a device ID of system, and
messages that originate in the admin context use the name of
the admin context as the device ID.
The hostname keyword specifies that the hostname of the
ASA should be used as the device ID. The ipaddress
interface_name keyword and argument pair specify that the
interface IP address specified as interface_name should be
used as the device ID. If you use the ipaddress keyword, the
device ID becomes the specified ASA interface IP address,
regardless of the interface from which the syslog message is
sent. This keyword provides a single, consistent device ID for
all syslog messages that are sent from the device. The string
text keyword and argument pair specify that the text string
should be used as the device ID. The string can include as
many as 16 characters. You cannot use blank spaces or any of
the following characters:
& (ampersand)
(single quote)
(double quote)
< (less than)
> (greater than)
? (question mark)
Note If enabled, the device ID does not appear in
EMBLEM-formatted syslog messages nor in SNMP
traps.
77-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuring Logging
Including the Date and Time in Syslog Messages
To include the date and time in syslog messages, enter the following command:
Disabling a Syslog Message
To disable a specified syslog message, enter the following command:
Changing the Severity Level of a Syslog Message
To change the severity level of a syslog message, enter the following command:
Command Purpose
logging timestamp
hostname(config)# logging timestamp
Example:
hostname(config)# logging timestamp
LOG-2008-10-24-081856.TXT
Specifies that syslog messages should include the date and
time that they were generated. To remove the date and time
from syslog messages, enter the no logging timestamp
command.
Command Purpose
no logging message message_number
Example:
hostname(config)# no logging message 113019
Prevents the ASA from generating a particular syslog
message. To reenable a disabled syslog message, enter the
logging message message_number command (for example,
logging message 113019). To reenable logging of all disabled
syslog messages, enter the clear config logging disabled
command.
Command Purpose
logging message message_ID level severity_level
Example:
hostname(config)# logging message 113019 level 5
Specifies the severity level of a syslog message. To reset the
severity level of a syslog message to its setting, enter the no
logging message message_ID level current_severity_level
command (for example, no logging message 113019 level 5).
To reset the severity level of all modified syslog messages to
their settings, enter the clear configure logging level
command.
77-19
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Monitoring the Logs
Limiting the Rate of Syslog Message Generation
To limit the rate of syslog message generation, enter the following command:
Monitoring the Logs
To monitor the logs and assist in monitoring the system performance, enter one of the following
commands:
Examples
The following example shows the logging information that displays for the show logging command:
hostname(config)# show logging
Syslog logging: enabled
Facility: 16
Timestamp logging: disabled
Standby logging: disabled
Deny Conn when Queue Full: disabled
Console logging: disabled
Monitor logging: disabled
Buffer logging: disabled
Trap logging: level errors, facility 16, 3607 messages logged
Logging to infrastructure 10.1.2.3
Command Purpose
logging rate-limit {unlimited | {num [interval]}}
message syslog_id | level severity_level
Example:
hostname(config)# logging rate-limit 1000 600 level
6
Applies a specified severity level (1 through 7) to a set of
messages or to an individual message (not the destination)
within a specified time period. Rate limits affect the volume of
messages being sent to all configured destinations. To reset
the logging rate limit to the default value, enter the clear
running-config logging rate-limit command. To reset the
logging rate limit, enter the clear configure logging
rate-limit command.
Command Purpose
show logging
Shows syslog messages, including the severity level.
Note The maximum number of syslog messages that are
available to view is 1000, which is the default setting.
The maximum number of syslog messages that are
available to view is 2000.
show logging message
Shows a list of syslog messages with modified severity levels
and disabled syslog messages.
show logging message message_ID
Shows the severity level of a specific syslog message.
show logging queue
Shows the logging queue and queue statistics.
show logging rate-limit
Shows the disallowed syslog messages.
show running-config logging rate-limit
Shows the current logging rate-limit setting.
77-20
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Configuration Examples for Logging
History logging: disabled
Device ID: 'inside' interface IP address 10.1.1.1
Mail logging: disabled
ASDM logging: disabled
Configuration Examples for Logging
The following examples show how to control both whether a syslog message is enabled and the severity
level of the specified syslog message:
hostname(config)# show logging message 403503
syslog 403503: -level errors (enabled)
hostname(config)# logging message 403503 level 1
hostname(config)# show logging message 403503
syslog 403503: -level errors, current-level alerts (enabled)
hostname(config)# no logging message 403503
hostname(config)# show logging message 403503
syslog 403503: -level errors, current-level alerts (disabled)
hostname(config)# logging message 403503
hostname(config)# show logging message 403503
syslog 403503: -level errors, current-level alerts (enabled)
hostname(config)# no logging message 403503 level 3
hostname(config)# show logging message 403503
syslog 403503: -level errors (enabled)
Feature History for Logging
Table 77-2 lists each feature change and the platform release in which it was implemented.
Table 77-2 Feature History for Logging
Feature Name
Platform
Releases Feature Information
Logging 7.0(1) Provides ASA network logging information through various output destinations,
and includes the option to view and save log files.
Rate limit 7.0(4) Limits the rate at which syslog messages are generated.
We introduced the following command: logging rate-limit.
Logging list 7.2(1) Creates a logging list to use in other commands to specify messages by various
criteria (logging level, event class, and message IDs).
We introduced the following command: logging list.
77-21
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Feature History for Logging
Secure logging 8.0(2) Specifies that the connection to the remote logging host should use SSL/TLS.
This option is valid only if the protocol selected is TCP.
We modified the following command: logging host.
Logging class 8.0(4), 8.1(1) Added support for the ipaa event class of logging messages.
We modified the following command: logging class.
Logging class and saved
logging buffers
8.2(1) Added support for the dap event class of logging messages.
We modified the following command: logging class.
Added support to clear the saved logging buffers (ASDM, internal, FTP, and
flash).
We introduced the following command: clear logging queue bufferwrap.
Password encryption 8.3(1) Added support for password encryption.
We modified the following command: logging ftp server.
Enhanced logging and
connection blocking
8.3(2) When you configure a syslog server to use TCP, and the syslog server is
unavailable, the ASA blocks new connections that generate syslog messages
until the server becomes available again (for example, VPN, firewall, and
cut-through-proxy connections). This feature has been enhanced to also block
new connections when the logging queue on the ASA is full; connections resume
when the logging queue is cleared.
This feature was added for compliance with Common Criteria EAL4+. Unless
required, we recommended allowing connections when syslog messages cannot
be sent or received. To allow connections, continue to use the logging
permit-hostdown command.
We modified the following command: show logging.
We introduced the following syslog messages: 414005, 414006, 414007, and
414008.
Table 77-2 Feature History for Logging (continued)
Feature Name
Platform
Releases Feature Information
77-22
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 77 Configuring Logging
Feature History for Logging
C H A P T E R
78-1
Cisco ASA 5500 Series Configuration Guide using the CLI
78
Configuring NetFlow Secure Event Logging (NSEL)
This chapter describes how to configure NSEL, a security logging mechanism that is built on NetFlow
Version 9 technology, and how to handle events and syslog messages through NSEL.
This chapter includes the following sections:
Information About NSEL, page 78-1
Licensing Requirements for NSEL, page 78-3
Prerequisites for NSEL, page 78-3
Guidelines and Limitations, page 78-4
Configuring NSEL, page 78-4
Monitoring NSEL, page 78-10
Configuration Examples for NSEL, page 78-12
Where to Go Next, page 78-13
Additional References, page 78-13
Feature History for NSEL, page 78-14
Information About NSEL
The ASA and ASASM support NetFlow Version 9 services. For more information about NetFlow
services, see the RFCs section on page 78-14.
The ASA and ASASM implementations of NSEL provide a stateful, IP flow tracking method that exports
records that indicate significant events in a flow. In stateful flow tracking, tracked flows go through a
series of state changes. NSEL events are used to export data about flow status and are triggered by the
event that caused the state change.
The significant events that are tracked include flow-create, flow-teardown, flow-denied (excluding those
flows that are denied by EtherType ACLs), and flow-update. In addition, the ASA and ASASM
implementation of NSEL generates periodic NSEL events and flow-update events to provide periodic
byte counters over the duration of the flow. These events are usually time-driven, which makes them
more in line with traditional Netflow; however, these events may also be triggered by state changes in
the flow.
Each NSEL record has an event ID and an extended event ID field, which describes the flow event.
The ASA and ASASM implementations of NSEL provide the following major functions:
78-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Information About NSEL
Tracks flow-create, flow-teardown, and flow-denied events, and generates appropriate NSEL data
records.
Triggers flow-update events and generates appropriate NSEL data records.
Defines and exports templates that describe the progression of a flow. Templates describe the format
of the data records that are exported through NetFlow. Each event has several record formats or
templates associated with it.
Tracks configured NSEL collectors and delivers templates and data records to these configured
NSEL collectors through NetFlow over UDP only.
Sends template information periodically to NSEL collectors. Collectors receive template
definitions, normally before receiving flow records.
Filters NSEL events based on the traffic and event type through Modular Policy Framework, then
sends records to different collectors. Traffic is matched based on the order in which classes are
configured. After a match is found, no other classes are checked. The supported event types are
flow-create, flow-denied, flow-teardown, flow-update, and all. Records can be sent to different
collectors. For example, with two collectors, you can do the following:
Log all flow-denied events that match access list 1 to collector 1.
Log all flow-create events to collector 1.
Log all flow-teardown events to collector 2.
Log all flow-update events to collector 1.
Delays the export of flow-create events.
Using NSEL and Syslog Messages
Table 78-1 lists the syslog messages that have an equivalent NSEL event, event ID, and extended event
ID. The extended event ID provides more detail about the event (for example, which ACLingress or
egresshas denied a flow).
Note Enabling NetFlow to export flow information makes the syslog messages that are listed in Table 78-1
redundant. In the interest of performance, we recommend that you disable redundant syslog messages,
because the same information is exported through NetFlow. You can enable or disable individual syslog
messages by following the procedure in the Disabling and Reenabling NetFlow-related Syslog
Messages section on page 78-9.
Table 78-1 Syslog Messages and Equivalent NSEL Events
Syslog Message Description NSEL Event ID NSEL Extended Event ID
106100 Generated whenever an ACL is
encountered.
1Flow was created (if the
ACL allowed the flow).
3Flow was denied (if the
ACL denied the flow).
0If the ACL allowed the flow.
1001Flow was denied by the
ingress ACL.
1002Flow was denied by the
egress ACL.
106015 A TCP flow was denied because
the first packet was not a SYN
packet.
3Flow was denied. 1004Flow was denied because
the first packet was not a TCP
SYN packet.
78-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Licensing Requirements for NSEL
Note When NSEL and syslog messages are both enabled, there is no guarantee of chronological ordering
between the two logging types.
Licensing Requirements for NSEL
Prerequisites for NSEL
NSEL has the following prerequisites:
IP address and hostname assignments must be unique throughout the NetFlow configuration.
You must have at least one configured collector before you can use NSEL.
You must configure NSEL collectors before you can configure filters via Modular Policy
Framework.
106023 When a flow was denied by an
ACL attached to an interface
through the access-group
command.
3Flow was denied. 1001Flow was denied by the
ingress ACL.
1002Flow was denied by the
egress ACL.
302013, 302015,
302017, 302020
TCP, UDP, GRE, and ICMP
connection creation.
1Flow was created. 0Ignore.
302014, 302016,
302018, 302021
TCP, UDP, GRE, and ICMP
connection teardown.
2Flow was deleted. 0Ignore.
> 2000Flow was torn down.
313001 An ICMP packet to the device
was denied.
3Flow was denied. 1003To-the-box flow was
denied because of configuration.
313008 An ICMP v6 packet to the device
was denied.
3Flow was denied. 1003To-the-box flow was
denied because of configuration.
710003 An attempt to connect to the
device interface was denied.
3Flow was denied. 1003To-the-box flow was
denied because of configuration.
Model License Requirement
All models Base License.
Table 78-1 Syslog Messages and Equivalent NSEL Events (continued)
Syslog Message Description NSEL Event ID NSEL Extended Event ID
78-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Guidelines and Limitations
Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
Supported in single and multiple context mode.
Firewall Mode Guidelines
Supported in routed and transparent firewall mode.
IPv6 Guidelines
Supports IPv6 for the class-map, match any and class-default commands. The match access-list
commands only support IPv4 access lists.
Additional Guidelines and Limitations
If you have previously configured flow-export actions using the flow-export enable command, and
you upgrade to a later version, then your configuration is automatically converted to the new
Modular Policy Framework flow-export event-type command, which is described under the
policy-map command.
Flow-export actions are not supported in interface-based policies. You can configure flow-export
actions in a class-map only with the match access-list, match any, or class-default commands. You
can only apply flow-export actions in a global service policy.
To view bandwidth usage for NetFlow records (not available in real-time), you must use the threat
detection feature.
Configuring NSEL
This section describes how to configure NSEL and includes the following topics:
Configuring NSEL Collectors, page 78-5
Configuring Flow-Export Actions Through Modular Policy Framework, page 78-5
Configuring Template Timeout Intervals, page 78-7
Changing the Time Interval for Sending Flow-Update Events to a Collector, page 78-8
Disabling and Reenabling NetFlow-related Syslog Messages, page 78-9
Clearing Runtime Counters, page 78-10
78-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Configuring NSEL
Configuring NSEL Collectors
To configure NSEL collectors, enter the following command:
What to Do Next
See the Configuring Flow-Export Actions Through Modular Policy Framework section on page 78-5.
Configuring Flow-Export Actions Through Modular Policy Framework
To export NSEL events by defining all classes with flow-export actions, perform the following steps:
Command Purpose
flow-export destination interface-name
ipv4-address|hostname udp-port
Example:
hostname (config)# flow-export destination inside
209.165.200.225 2002
Adds, edits, or deletes an NSEL collector to which NetFlow
packets are sent. The destination keyword indicates that a
NSEL collector is being configured. The interface-name
argument is the name of the ASA and ASA Services Module
interface through which the collector is reached. The
ipv4-address argument is the IP address of the machine
running the collector application. The hostname argument is
the destination IP address or name of the collector. The
udp-port argument is the UDP port number to which NetFlow
packets are sent. You can configure a maximum of five
collectors. After a collector is configured, template records
are automatically sent to all configured NSEL collectors.
Note Make sure that collector applications use the Event
Time field to correlate events.
Command Purpose
Step 1 class-map flow_export_class
Example:
hostname (config-pmap)# class-map flow_export_class
Defines the class map that identifies traffic for which
NSEL events need to be exported. The
flow_export_class argument is the name of the class
map.
Step 2 Choose one of the following options:
match access-list flow_export_acl
Example:
hostname (config-cmap)# match access-list
flow_export_acl
Configures the access list to match specific traffic.
The flow_export_acl argument is the name of the
access list.
match any
Example:
hostname (config-cmap)# match any
Matches any traffic.
78-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Configuring NSEL
Step 3 policy-map flow_export_policy
Example:
hostname(config)# policy-map flow_export_policy
Defines the policy map to apply flow-export actions
to the defined classes. The flow_export_policy
argument is the name of the policy map.
If you create a new policy map and apply it globally
according to Step 6, the remaining inspection policies
are deactivated.
Alternatively, to insert a NetFlow class in the existing
policy, enter the class flow_export_class command
after the policy-map global_policy command.
For more information about creating or modifying
the Modular Policy Framework, see Chapter 32,
Configuring a Service Policy Using the Modular
Policy Framework.
Step 4 class flow_export_class
Example:
hostname (config-pmap)# class flow_export_class
Defines the class to apply flow-export actions. The
flow_export_class argument is the name of the class.
Step 5 flow-export event-type event-type destination
flow_export_host1 [flow_export_host2]
Example:
hostname (config-pmap-c)# flow-export event-type all
destination 209.165.200.230
Configures a flow-export action. The event_type
keyword is the name of the supported event being
filtered. The flow_export_host argument is the IP
address of a host. The destination keyword is the IP
address of the configured collector.
Step 6 service-policy flow_export_policy global
Example:
hostname (config)# service-policy flow_export_policy
global
Adds or edits the service policy globally. The
flow_export_policy argument is the name of the
policy map.
Command Purpose
78-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Configuring NSEL
What to Do Next
See the Configuring Template Timeout Intervals section on page 78-7.
Configuring Template Timeout Intervals
To configure template timeout intervals, enter the following command:
Command Purpose
flow-export template timeout-rate minutes
Example:
hostname (config)# flow-export template timeout-rate
15
Specifies the interval at which template records are sent to all
configured output destinations. The template keyword
indicates the template-specific configurations. The
timeout-rate keyword specifies the time before templates are
resent. The minutes argument specifies the time interval in
minutes at which the templates are resent. The default value
is 30 minutes.
78-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Configuring NSEL
What to Do Next
See the Changing the Time Interval for Sending Flow-Update Events to a Collector section on
page 78-8.
Changing the Time Interval for Sending Flow-Update Events to a Collector
To change the time interval at which periodic flow-update events are to be sent to a collector, enter the
following command:
Command Purpose
flow-export active refresh-interval value
Example:
hostname (config)# flow-export active
refresh-interval 30
Configures NetFlow parameters for active connections. The
value argument specifies the time interval between
flow-update events in minutes. Valid values are from 1 - 60
minutes. The default value is 1 minute.
If you have already configured the flow-export delay
flow-create command, and you then configure the
flow-export active refresh-interval command w ith an
interval value that is not at least 5 seconds more than the delay
value, the following warning message appears at the console:
WARNING: The current delay flow-create value
configuration may cause flow-update events to appear
before flow-creation events.
If you have already configured the flow-export active
refresh-interval command, and you then configure the
flow-export delay flow-create command w ith a delayvalue
that is not at least 5 seconds less than the interval value, the
following warning message appears at the console:
WARNING: The current delay flow-create value
configuration may cause flow-update events to appear
before flow-creation events.
78-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Configuring NSEL
What to Do Next
See the Delaying Flow-Create Events section on page 78-9.
Delaying Flow-Create Events
To delay the sending of flow-create events, enter the following command:
What to Do Next
See the Disabling and Reenabling NetFlow-related Syslog Messages section on page 78-9.
Disabling and Reenabling NetFlow-related Syslog Messages
To disable and reenable NetFlow-related syslog messages, perform the following steps:
Command Purpose
flow-export delay flow-create seconds
Example:
hostname (config)# flow-export delay flow-create 10
Delays the sending of a flow-create event by the specified
number of seconds. The seconds argument indicates the
amount of time allowed for the delay in seconds. If this
command is not configured, there is no delay, and the
flow-create event is exported as soon as the flow is created. If
the flow is torn down before the configured delay, the
flow-create event is not sent; an extended flow teardown event
is sent instead.
Command Purpose
Step 1 logging flow-export-syslogs disable
Example:
hostname(config)# logging flow-export-syslogs
disable
Disables syslog messages that have become
redundant because of NSEL.
Note Although you execute this command in
global configuration mode, it is not stored in
the configuration. Only the no logging
message xxxxxx commands are stored in the
configuration.
Step 2 logging message xxxxxx
Example:
hostname(config)# logging message 302013
Reenables syslog messages individually, where
xxxxxx is the specified syslog message that you want
to reenable.
Step 3 logging flow-export-syslogs enable
Example:
hostname(config)# logging flow-export-syslogs enable
Reenables all NSEL events at the same time.
78-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Monitoring NSEL
What to Do Next
See the Clearing Runtime Counters section on page 78-10.
Clearing Runtime Counters
To reset runtime counters, enter the following command:
What to Do Next
See the Monitoring NSEL section on page 78-10.
Monitoring NSEL
You can use syslog messages to help troubleshoot errors or monitor system usage and performance.You
can view real-time syslog messages that have been saved in the log buffer in a separate window, which
include an explanation of the message, details about the message, and recommended actions to take, if
necessary, to resolve an error. For more information, see the Using NSEL and Syslog Messages section
on page 78-2.
NSEL Monitoring Commands
To monitor NSEL, enter one of the following commands:
Examples
The following example shows how to display flow-export counters:
hostname (config)# show flow-export counters
Command Purpose
clear flow-export counters
Example:
hostname# clear flow-export counters
Resets all runtime counters for NSEL to zero.
Command Purpose
show flow-export counters
Shows runtime counters, including statistical data and error
data, for NSEL.
show logging flow-export-syslogs
Lists all syslog messages that are captured by NSEL events.
show running-config flow-export
Shows the currently configured NetFlow commands.
show running-config logging
Shows disabled syslog messages, which are redundant syslog
messages, because they export the same information through
NetFlow.
78-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Monitoring NSEL
destination: inside 209.165.200.225 2055
Statistics:
packets sent 250
Errors:
block allocation errors 0
invalid interface 0
template send failure 0
no route to collector 0
The following example shows how to display the flow-export active configuration:
hostname (config)# show running-config flow-export active
flow-export active refresh-interval 2
The following example shows how to display the flow-export delay configuration:
hostname (config)# show running-config flow-export delay
flow-export delay flow-create 30
The following example shows how to display the flow-export destination configurations:
hostname (config)# show running-config flow-export destination
flow-export destination inside 192.68.10.70 9996
The following example shows how to display the flow-export template configuration:
hostname (config)# show running-config flow-export template
flow-export template timeout-rate 1
The following example shows how to display flow-export syslog messages:
hostname# show logging flow-export-syslogs
Syslog ID Type Status
302013 Flow Created Enabled
302015 Flow Created Enabled
302017 Flow Created Enabled
302020 Flow Created Enabled
302014 Flow Deleted Enabled
302016 Flow Deleted Enabled
302018 Flow Deleted Enabled
302021 Flow Deleted Enabled
106015 Flow Denied Enabled
106023 Flow Denied Enabled
313001 Flow Denied Enabled
313008 Flow Denied Enabled
710003 Flow Denied Enabled
106100 Flow Created/Denied Enabled
The following example shows how to display current syslog message settings:
hostname (config)# show running-config logging
no logging message 313008
no logging message 313001
78-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Configuration Examples for NSEL
Configuration Examples for NSEL
The following examples show how to filter NSEL events, with the specified collectors already
configured:
flow-export destination inside 209.165.200.2055
flow-export destination outside 209.165.201.29 2055
flow-export destination outside 209.165.201.27 2055
Log all events between hosts 209.165.200.224 and hosts 209.165.201.224 to 209.165.200.230, and log
all other events to 209.165.201.29:
hostname (config)# access-list flow_export_acl permit ip host 209.165.200.224 host
209.165.201.224
hostname (config)# class-map flow_export_class
hostname (config-cmap)# match access-list flow_export_acl
hostname (config)# policy-map flow_export_policy
hostname (config-pmap)# class flow_export_class
hostname (config-pmap-c)# flow-export event-type all destination 209.165.200.230
hostname (config-pmap)# class class-default
hostname (config-pmap-c)# flow-export event-type all destination 209.165.201.29
hostname (config)# service-policy flow_export_policy global
Log flow-create events to 209.165.200.230, flow-teardown events to 209.165.201.29, flow-denied
events to 209.165.201.27, and flow-update events to 209.165.200.230:
hostname (config)# policy-map flow_export_policy
hostname (config-pmap)# class class-default
hostname (config-pmap-c)# flow-export event-type flow-creation destination 209.165.200.230
hostname (config-pmap-c)# flow-export event-type flow-teardown destination 209.165.201.29
hostname (config-pmap-c)# flow-export event-type flow-denied destination 209.165.201.27
hostname (config-pmap-c)# flow-export event-type flow-update destination 209.165.200.230
hostname (config)# service-policy flow_export_policy global
Log flow-create events between hosts 209.165.200.224 and 209.165.200.230 to 209.165.201.29, and log
all flow-denied events to 209.165.201.27:
hostname (config)# access-list flow_export_acl permit ip host 209.165.200.224 host
209.165.200.230
hostname (config)# class-map flow_export_class
hostname (config)# match access-list flow_export_acl
hostname (config)# policy-map flow_export_policy
hostname (config-pmap)# class flow_export_class
hostname (config-pmap-c)# flow-export event-type flow-creation destination 209.165.200.29
hostname (config-pmap-c)# flow-export event-type flow-denied destination 209.165.201.27
hostname (config-pmap)# class class-default
hostname (config-pmap-c)# flow-export event-type flow-denied destination 209.165.201.27
hostname (config)# service-policy flow_export_policy global
Note You must enter the following command:
hostname (config-pmap-c)# flow-export event-type flow-denied destination 209.165.201.27
for flow_export_acl, because traffic is not checked after the first match, and you must explicitly define
the action to log flow-denied events that match flow_export_acl.
Log all traffic except traffic between hosts 209.165.201.27 and 209.165.201.50 to 209.165.201.27:
hostname (config)# access-list flow_export_acl deny ip host 209.165.201.30 host
209.165.201.50
78-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Where to Go Next
hostname (config)# access-list flow_export_acl permit ip any any
hostname (config)# class-map flow_export_class
hostname (config-cmap)# match access-list flow_export_acl
hostname (config)# policy-map flow_export_policy
hostname (config-pmap)# class flow_export_class
hostname (config-pmap-c)# flow-export event-type all destination 209.165.201.27
hostname (config)# service-policy flow_export_policy global
Where to Go Next
To configure the syslog server, see Chapter 77, Configuring Logging.
Additional References
For additional information related to implementing NSEL, see the following sections:
Related Documents, page 78-14
RFCs, page 78-14
78-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Feature History for NSEL
Related Documents
RFCs
Feature History for NSEL
Table 78-2 lists each feature change and the platform release in which it was implemented..
Related Topic Document Title
Using NSEL and Syslog Messages, page 78-2 syslog message guide
Information about the implementation of NSEL on the
ASA and ASASM
Cisco ASA 5500 Series Implementation Note for NetFlow Collectors
See the following article at
https://supportforums.cisco.com/docs/DOC-6113.
Configuring NetFlow on the ASA and ASASM using
ASDM
See the following article at
https://supportforums.cisco.com/docs/DOC-6114.
RFC Title
3954 Cisco Systems NetFlow Services Export Version 9
78-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Feature History for NSEL
Table 78-2 Feature History for NSEL
Feature Name
Platform
Releases Feature Information
NetFlow 8.1(1) The NetFlow feature enhances the ASA logging capabilities by logging flow-based events
through the NetFlow protocol. NetFlow Version 9 services are used to export information
about the progression of a flow from start to finish. The NetFlow implementation exports
records that indicate significant events in the life of a flow. This implementation is
different from traditional NetFlow, which exports data about flows at regular intervals. The
NetFlow module also exports records about flows that are denied by access lists. You can
configure an ASA 5580 to send the following events using NetFlow: flow create, flow
teardown, and flow denied (only flows denied by ACLs are reported).
We introduced the following commands: clear flow-export counters, flow-export
enable, flow-export destination, flow-export template timeout-rate, logging
flow-export syslogs enable, logging flow-export syslogs disable, show flow-export
counters, show logging flow-export-syslogs.
NetFlow
Filtering
8.1(2) You can filter NetFlow events based on traffic and event type, then send records to different
collectors. For example, you can log all flow-create events to one collector, and log
flow-denied events to a different collector.
We modified the following commands: class, class-map, flow-export event-type
destination, match access-list, policy-map, service-policy.
For short-lived flows, NetFlow collectors benefit from processing a single event instead of
two events: flow create and flow teardown. You can configure a delay before sending the
flow-create event. If the flow is torn down before the timer expires, only the flow teardown
event is sent. The teardown event includes all information regarding the flow; no loss of
information occurs.
We introduced the following command: flow-export delay flow-create.
NSEL 8.2(1) The NetFlow feature has been ported to all available models of the ASA.
NSEL 8.4(5) Flow-update events have been introduced to provide periodic byte counters for flow traffic.
You can change the time interval at which flow-update events are sent to the NetFlow
collector. You can filter to which collectors flow-update records will be sent.
We introduced the following command: flow-export active refresh-interval.
We modified the following command: flow-export event-type.
78-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 78 Configuring NetFlow Secure Event Logging (NSEL)
Feature History for NSEL
C H A P T E R
79-1
Cisco ASA 5500 Series Configuration Guide using the CLI
79
Configuring SNMP
This chapter describes how to configure SNMP to monitor the ASA and includes the following sections:
Information About SNMP, page 79-1
Licensing Requirements for SNMP, page 79-17
Prerequisites for SNMP, page 79-17
Guidelines and Limitations, page 79-17
Configuring SNMP, page 79-18
Troubleshooting Tips, page 79-24
Monitoring SNMP, page 79-26
Configuration Examples for SNMP, page 79-28
Where to Go Next, page 79-29
Additional References, page 79-29
Feature History for SNMP, page 79-31
Information About SNMP
SNMP is an application-layer protocol that facilitates the exchange of management information between
network devices and is part of the TCP/IP protocol suite. This section describes SNMP and includes the
following topics:
Information About SNMP Terminology, page 79-2
Information About MIBs and Traps, page 79-2
SNMP Object Identifiers, page 79-3
SNMP Physical Vendor Type Values, page 79-5
Supported Tables in MIBs, page 79-11
Supported Traps (Notifications), page 79-12
SNMP Version 3, page 79-15
The ASA provides support for network monitoring using SNMP Versions 1, 2c, and 3, and supports the
use of all three versions simultaneously. The SNMP agent running on the ASA interface lets you monitor
the ASA and through network management systems (NMSs), such as HP OpenView. The ASA supports
SNMP read-only access through issuance of a GET request. SNMP write access is not allowed, so you
cannot make changes with SNMP. In addition, the SNMP SET request is not supported.
79-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
You can configure the ASA to send traps, which are unsolicited messages from the managed device to
the management station for certain events (event notifications) to an NMS, or you can use the NMS to
browse the MIBs on the ASA. MIBs are a collection of definitions, and the ASA maintains a database
of values for each definition. Browsing a MIB means issuing a series of GET-NEXT or GET-BULK
requests of the MIB tree from the NMS to determine values.
The ASA has an SNMP agent that notifies designated management stations if events occur that are
predefined to require a notification, for example, when a link in the network goes up or down. The
notification it sends includes an SNMP OID, which identifies itself to the management stations. The
ASASNMP agent also replies when a management station asks for information.
Information About SNMP Terminology
Table 79-1 lists the terms that are commonly used when working with SNMP:
Information About MIBs and Traps
MIBs are either standard or enterprise-specific. Standard MIBs are created by the IETF and documented
in various RFCs. A trap reports significant events occurring on a network device, most often errors or
failures. SNMP traps are defined in either standard or enterprise-specific MIBs. Standard traps are
created by the IETF and documented in various RFCs. SNMP traps are compiled into the ASA software.
If needed, you can also download RFCs, standard MIBs, and standard traps from the following locations:
http://www.ietf.org/
Table 79-1 SNMP Terminology
Term Description
Agent The SNMP server running on the ASA. The SNMP agent has the following features:
Responds to requests for information and actions from the network management station.
Controls access to its Management Information Base, the collection of objects that the SNMP
manager can view or change.
Does not allow set operations.
Browsing Monitoring the health of a device from the network management station by polling required information
from the SNMP agent on the device. This activity may include issuing a series of GET-NEXT or
GET-BULK requests of the MIB tree from the network management station to determine values.
Management
Information
Bases (MIBs)
Standardized data structures for collecting information about packets, connections, buffers, failovers, and
so on. MIBs are defined by the product, protocols, and hardware standards used by most network devices.
SNMP network management stations can browse MIBs and request specific data or events be sent as they
occur.
Network
management
stations (NMSs)
The PCs or workstations set up to monitor SNMP events and manage devices, such as the ASA.
Object identifier
(OID)
The system that identifies a device to its NMS and indicates to users the source of information monitored
and displayed.
Trap Predefined events that generate a message from the SNMP agent to the NMS. Events include alarm
conditions such as linkup, linkdown, coldstart, warmstart, authentication, or syslog messages.
79-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
ftp://ftp-sj.cisco.com/pub/mibs
Download a complete list of Cisco MIBs, traps, and OIDs from the following location:
http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml
In addition, download Cisco OIDs by FTP from the following location:
ftp://ftp.cisco.com/pub/mibs/oid/oid.tar.gz
Note In software versions 7.2(1), 8.0(2), and later, the interface information accessed through SNMP refreshes
about every 5 seconds. As a result, we recommend that you wait for at least 5 seconds between
consecutive polls.
SNMP Object Identifiers
Each Cisco system-level product has an SNMP object identifier (OID) for use as a MIB-II sysObjectID.
The CISCO-PRODUCTS-MIB includes the OIDs that can be reported in the sysObjectID object in the
SNMPv2-MIB. You can use this value to identify the model type. Table 79-2 lists the sysObjectID OIDs
for ASA models.
Table 79-2 SNMP Object Identifiers
Product Identifier sysObjectID Model Number
ASA 5505 ciscoASA5505 (ciscoProducts 745) Cisco ASA 5505
ASA 5510 ciscoASA5510 (ciscoProducts 669) Cisco ASA 5510
ASA 5510 ciscoASA5510sc (ciscoProducts 773) Cisco ASA 5510 security context
ASA 5510 ciscoASA5510sy (ciscoProducts 774) Cisco ASA 5510 system context
ASA 5520 ciscoASA5520 (ciscoProducts 670) Cisco ASA 5520
ASA 5520 ciscoASA5520sc (ciscoProducts 671) Cisco ASA 5520 security context
ASA 5520 ciscoASA5520sy (ciscoProducts 764) Cisco ASA 5520 system context
ASA 5540 ciscoASA5540 (ciscoProducts 672) Cisco ASA 5540
ASA 5540 ciscoASA5540sc (ciscoProducts 673) Cisco ASA 5540 security context
ASA 5540 ciscoASA5540sy (ciscoProducts 765) Cisco ASA 5540 system context
ASA 5550 ciscoASA5550 (ciscoProducts 753) Cisco ASA 5550
ASA 5550 ciscoASA5550sc (ciscoProducts 763) Cisco ASA 5550 security context
ASA 5550 ciscoASA 5550sy (ciscoProducts 766) Cisco ASA 5550 system context
ASA5580 ciscoASA5580 (ciscoProducts 914) Cisco ASA 5580
ASA5580 ciscoASA5580 (ciscoProducts 915) Cisco ASA 5580 security context
ASA5580 ciscoASA5580 (ciscoProducts 916) Cisco ASA 5580 system context
ASA5585-SSP10 ciscoASA5585Ssp10 (ciscoProducts 1194) ASA 5585-X SSP-10
ASA5585-SSP20 ciscoASA5585Ssp20 (ciscoProducts 1195) ASA 5585-X SSP-20
ASA5585-SSP40 ciscoASA5585Ssp40 (ciscoProducts 1196) ASA 5585-X SSP-40
ASA5585-SSP60 ciscoASA5585Ssp60 (ciscoProducts 1197) ASA 5585-X SSP-60
ASA5585-SSP10 ciscoASA5585Ssp10sc (ciscoProducts 1198) ASA 5585-X SSP-10 security context
79-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
ASA5585-SSP20 ciscoASA5585Ssp20sc (ciscoProducts 1199) ASA 5585-X SSP-20 security context
ASA5585-SSP40 ciscoASA5585Ssp40sc (ciscoProducts 1200) ASA 5585-X SSP-40 security context
ASA5585-SSP60 ciscoASA5585Ssp60sc (ciscoProducts 1201) ASA 5585-X SSP-60 security context
ASA5585-SSP10 ciscoASA5585Ssp10sy (ciscoProducts 1202) ASA 5585-X SSP-10 system context
ASA5585-SSP20 ciscoASA5585Ssp20sy (ciscoProducts 1203) ASA 5585-X SSP-20 system context
ASA5585-SSP40 ciscoASA5585Ssp40sy (ciscoProducts 1204) ASA 5585-X SSP-40 system context
ASA5585-SSP60 ciscoASA5585Ssp60sy (ciscoProducts 1205) ASA 5585-X SSP-60 system context
ASA Services Module for
Catalyst switches
ciscoAsaSm1 (ciscoProducts 1277) Adaptive Security Appliance (ASA)
Services Module for Catalyst switches
ASA Services Module for
Catalyst switches security
context
ciscoAsaSm1sc (ciscoProducts 1275) Adaptive Security Appliance (ASA)
Services Module for Catalyst switches
security context
ASA Services Module for
Catalyst switches security
context with No Payload
Encryption
ciscoAsaSm1K7sc (ciscoProducts 1334) Adaptive Security Appliance (ASA)
Services Module for Catalyst switches
security context with No Payload
Encryption
ASA Services Module for
Catalyst switches system
context
ciscoAsaSm1sy (ciscoProducts 1276) Adaptive Security Appliance (ASA)
Services Module for Catalyst switches
system context
ASA Services Module for
Catalyst switches system
context with No Payload
Encryption
ciscoAsaSm1K7sy (ciscoProducts 1335) Adaptive Security Appliance (ASA)
Services Module for Catalyst switches
system context with No Payload
Encryption
ASA Services Module for
Catalyst switches system
context with No Payload
Encryption
ciscoAsaSm1K7 (ciscoProducts 1336) Adaptive Security Appliance (ASA)
Services Module for Catalyst switches
with No Payload Encryption
ASA 5512 ciscoASA5512 (ciscoProducts 1407) ASA 5512 Adaptive Security Appliance
ASA 5525 ciscoASA5525 (ciscoProducts 1408) ASA 5525 Adaptive Security Appliance
ASA 5545 ciscoASA5545 (ciscoProducts 1409) ASA 5545 Adaptive Security Appliance
ASA 5555 ciscoASA5555 (ciscoProducts 1410) ASA 5555 Adaptive Security Appliance
ASA 5512 Security
Context
ciscoASA5512sc (ciscoProducts 1411) ASA 5512 Adaptive Security Appliance
Security Context
ASA 5525 Security
Context
ciscoASA5525sc (ciscoProducts 1412) ASA 5525 Adaptive Security Appliance
Security Context
ASA 5545 Security
Context
ciscoASA5545sc (ciscoProducts 1413) ASA 5545 Adaptive Security Appliance
Security Context
ASA 5555 Security
Context
ciscoASA5555sc (ciscoProducts 1414) ASA 5555 Adaptive Security Appliance
Security Context
ASA 5512 System Context ciscoASA5512sy (ciscoProducts 1415) ASA 5512 Adaptive Security Appliance
System Context
ASA 5515 System Context ciscoASA5515sy (ciscoProducts 1416) ASA 5515 Adaptive Security Appliance
System Context
Table 79-2 SNMP Object Identifiers (continued)
79-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
SNMP Physical Vendor Type Values
Each Cisco chassis or standalone system has a unique type number for SNMP use. The
entPhysicalVendorType OIDs are defined in the CISCO-ENTITY-VENDORTYPE-OID-MIB. This
value is returned in the entPhysicalVendorType object from the ASA SNMP agent. You can use this value
to identify the type of component (module, power supply, fan, sensors, CPU, and so on). Table 79-3 lists
the physical vendor type values for the ASA models.
ASA 5525 System Context ciscoASA5525sy (ciscoProducts1417) ASA 5525 Adaptive Security Appliance
System Context
ASA 5545 System Context ciscoASA5545sy (ciscoProducts 1418) ASA 5545 Adaptive Security Appliance
System Context
ASA 5555 System Context ciscoASA5555sy (ciscoProducts 1419) ASA 5555 Adaptive Security Appliance
System Context
ASA 5515 Security
Context
ciscoASA5515sc (ciscoProducts 1420) ASA 5515 Adaptive Security Appliance
System Context
ASA 5515 ciscoASA5515 (ciscoProducts 1421) ASA 5515 Adaptive Security Appliance
Table 79-2 SNMP Object Identifiers (continued)
Table 79-3 SNMP Physical Vendor Type Values
Item entPhysicalVendorType OID Description
ASA Services Module for Catalyst switches cevCat6kWsSvcAsaSm1 (cevModuleCat6000Type 169)
ASA Services Module for Catalyst switches with No
Payload Encryption
cevCat6kWsSvcAsaSm1K7 (cevModuleCat6000Type 186)
ASA 5505 chassis cevChassisASA5505 (cevChassis 560)
ASA 5510 chassis cevChassisASA5510 (cevChassis 447)
Cisco Adaptive Security Appliance (ASA) 5512
Adaptive Security Appliance
cevChassisASA5512 (cevChassis 1113)
Cisco Adaptive Security Appliance (ASA) 5512
Adaptive Security Appliance with No Payload
Encryption
cevChassisASA5512K7 (cevChassis 1108 )
Cisco Adaptive Security Appliance (ASA) 5515
Adaptive Security Appliance
cevChassisASA5515 (cevChassis 1114)
Cisco Adaptive Security Appliance (ASA) 5515
Adaptive Security Appliance with No Payload
Encryption
cevChassisASA5515K7 (cevChassis 1109 )
ASA 5520 chassis cevChassisASA5520 (cevChassis 448)
Cisco Adaptive Security Appliance (ASA) 5525
Adaptive Security Appliance
cevChassisASA5525 (cevChassis 1115)
Cisco Adaptive Security Appliance (ASA) 5525
Adaptive Security Appliance with No Payload
Encryption
cevChassisASA5525K7 (cevChassis 1110 )
ASA 5540 chassis cevChassisASA5540 (cevChassis 449)
79-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
Cisco Adaptive Security Appliance (ASA) 5545
Adaptive Security Appliance
cevChassisASA5545 (cevChassis 1116)
Cisco Adaptive Security Appliance (ASA) 5545
Adaptive Security Appliance with No Payload
Encryption
cevChassisASA5545K7 (cevChassis 1111 )
ASA 5550 chassis cevChassisASA5550 (cevChassis 564)
Cisco Adaptive Security Appliance (ASA) 5555
Adaptive Security Appliance
cevChassisASA5555 (cevChassis 1117)
Cisco Adaptive Security Appliance (ASA) 5555
Adaptive Security Appliance with No Payload
Encryption
cevChassisASA5555K7 (cevChassis 1112 )
ASA 5580 chassis cevChassisASA5580 (cevChassis 704)
Central Processing Unit for Cisco Adaptive Security
Appliance 5512
cevCpuAsa5512 (cevModuleCpuType 229)
Central Processing Unit for Cisco Adaptive Security
Appliance 5512 with no Payload Encryption
cevCpuAsa5512K7 (cevModuleCpuType 224)
Central Processing Unit for Cisco Adaptive Security
Appliance 5515
cevCpuAsa5515 (cevModuleCpuType 230)
Central Processing Unit for Cisco Adaptive Security
Appliance 5515 with no Payload Encryption
cevCpuAsa5515K7 (cevModuleCpuType 225)
Central Processing Unit for Cisco Adaptive Security
Appliance 5525
cevCpuAsa5525 (cevModuleCpuType 231)
Central Processing Unit for Cisco Adaptive Security
Appliance 5525 with no Payload Encryption
cevCpuAsa5525K7 (cevModuleCpuType 226)
Central Processing Unit for Cisco Adaptive Security
Appliance 5545
cevCpuAsa5545 (cevModuleCpuType 232)
Central Processing Unit for Cisco Adaptive Security
Appliance 5545 with no Payload Encryption
cevCpuAsa5545K7 (cevModuleCpuType 227)
Central Processing Unit for Cisco Adaptive Security
Appliance 5555
cevCpuAsa5555 (cevModuleCpuType 233)
Central Processing Unit for Cisco Adaptive Security
Appliance 5555 with no Payload Encryption
cevCpuAsa5555K7 (cevModuleCpuType 228)
CPU for ASA 5580 cevCpuAsa5580 (cevModuleType 200)
CPU for ASA 5585 SSP-10 cevCpuAsa5585Ssp10 (cevModuleCpuType 204)
CPU for ASA 5585 SSP-10 No Payload Encryption cevCpuAsa5585Ssp10K7 ( cevModuleCpuType 205)
CPU for ASA 5585 SSP-20 cevCpuAsa5585Ssp20 (cevModuleCpuType 206)
CPU for ASA 5585 SSP-20 No Payload Encryption cevCpuAsa5585Ssp20K7 (cevModuleCpuType 207)
CPU for ASA 5585 SSP-40 cevCpuAsa5585Ssp40 (cevModuleCpuType 208)
CPU for ASA 5585 SSP-40 No Payload Encryption cevCpuAsa5585Ssp40K7 (cevModuleCpuType 209)
CPU for ASA 5585 SSP-60 cevCpuAsa5585Ssp60 (cevModuleCpuType 210)
CPU for ASA 5585 SSP-60 No Payload Encryption cevCpuAsa5585Ssp60K (cevModuleCpuType 211)
Table 79-3 SNMP Physical Vendor Type Values (continued)
79-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
CPU for Cisco ASA Services Module for Catalyst
switches
cevCpuAsaSm1 (cevModuleCpuType 222)
CPU for Cisco ASA Services Module with No
Payload Encryption for Catalyst switches
cevCpuAsaSm1K7 (cevModuleCpuType 223)
Chassis Cooling Fan in Adapative Security Appliance
5512
cevFanASA5512ChassisFan (cevFan 163)
Chassis Cooling Fan in Adapative Security Appliance
5512 with No Payload Encryption
cevFanASA5512K7ChassisFan (cevFan 172)
Chassis Cooling Fan in Adapative Security Appliance
5515
cevFanASA5515ChassisFan (cevFan 164)
Chassis Cooling Fan in Adapative Security Appliance
5515 with No Payload Encryption
cevFanASA5515K7ChassisFan (cevFan 171)
Chassis Cooling Fan in Adapative Security Appliance
5525
cevFanASA5525ChassisFan (cevFan 165)
Chassis Cooling Fan in Adapative Security Appliance
5525 with No Payload Encryption
cevFanASA5525K7ChassisFan (cevFan 170)
Chassis Cooling Fan in Adapative Security Appliance
5545
cevFanASA5545ChassisFan (cevFan 166)
Chassis Cooling Fan in Adapative Security Appliance
5545 with No Payload Encryption
cevFanASA5545K7ChassisFan (cevFan 169)
Power Supply Fan in Adapative Security Appliance
5545 with No Payload Encryption
cevFanASA5545K7PSFan (cevFan 161)
Power Supply Fan in Adapative Security Appliance
5545
cevFanASA5545PSFan (cevFan 159)
Chassis Cooling Fan in Adapative Security Appliance
5555
cevFanASA5555ChassisFan (cevFan 167)
Chassis Cooling Fan in Adapative Security Appliance
5555 with No Payload Encryption
cevFanASA5555K7ChassisFan (cevFan 168)
Power Supply Fan in Adapative Security Appliance
5555
cevFanASA5555PSFan (cevFan 160)
Power Supply Fan in Adapative Security Appliance
5555 with No Payload Encryption
cevFanASA5555PSFanK7 (cevFan 162)
Fan type for ASA 5580 cevFanASA5580Fan (cevFan 138)
Power supply fan for ASA 5585-X cevFanASA5585PSFan (cevFan 146)
ASA 5580 4-port GE copper interface card cevModuleASA5580Pm4xlgeCu (cevModuleASA5580Type 1)
10-Gigabit Ethernet interface cevPort10GigEthernet (cevPort 315)
Gigabit Ethernet port cevPortGe (cevPort 109)
Power Supply unit in Adapative Security Appliance
5545
cevPowerSupplyASA5545PSInput (cevPowerSupply 323)
Presence Sensor for Power Supply input in Adaptive
Security Appliance 5545
cevPowerSupplyASA5545PSPresence (cevPowerSupply 321)
Table 79-3 SNMP Physical Vendor Type Values (continued)
79-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
Power Supply unit in Adapative Security Appliance
5555
cevPowerSupplyASA5555PSInput (cevPowerSupply 324)
Presence Sensor for Power Supply input in Adaptive
Security Appliance 5555
cevPowerSupplyASA5555PSPresence (cevPowerSupply 322)
Power supply input for ASA 5580 cevPowerSupplyASA5580PSInput (cevPowerSupply 292)
Power supply input for ASA 5585 cevPowerSupplyASA5585PSInput (cevPowerSupply 304)
Cisco Adaptive Security Appliance (ASA) 5512
Chassis Fan sensor
cevSensorASA5512ChassisFanSensor (cevSensor 120)
Chassis Ambient Temperature Sensor for Cisco
Adaptive Security Appliance 5512
cevSensorASA5512ChassisTemp (cevSensor 107)
Central Processing Unit Temperature Sensor for
Cisco Adaptive Security Appliance 5512
cevSensorASA5512CPUTemp (cevSensor 96)
Cisco Adaptive Security Appliance (ASA) 5512 with
No Payload Encryption Chassis Fan sensor
cevSensorASA5512K7ChassisFanSensor (cevSensor 125)
Central Processing Unit Temperature Sensor for
Cisco Adaptive Security Appliance 5512 with No
Payload Encryption
cevSensorASA5512K7CPUTemp (cevSensor 102)
Sensor for Chassis Cooling Fan in Adapative Security
Appliance 5512 with No Payload Encryption
cevSensorASA5512K7PSFanSensor (cevSensor 116)
Sensor for Chassis Cooling Fan in Adapative Security
Appliance 5512
cevSensorASA5512PSFanSensor (cevSensor 119)
Cisco Adaptive Security Appliance (ASA) 5515
Chassis Fan sensor
cevSensorASA5515ChassisFanSensor (cevSensor 121)
Chassis Ambient Temperature Sensor for Cisco
Adaptive Security Appliance 5515
cevSensorASA5515ChassisTemp (cevSensor 98)
Central Processing Unit Temperature Sensor for
Cisco Adaptive Security Appliance 5515
cevSensorASA5515CPUTemp (cevSensor 97)
Cisco Adaptive Security Appliance (ASA) 5515 with
No Payload Encryption Chassis Fan sensor
cevSensorASA5515K7ChassisFanSensor (cevSensor 126)
Central Processing Unit Temperature Sensor for
Cisco Adaptive Security Appliance 5515 with No
Payload Encryption
cevSensorASA5515K7CPUTemp (cevSensor 103)
Sensor for Chassis Cooling Fan in Adapative Security
Appliance 5515 with No Payload Encryption
cevSensorASA5515K7PSFanSensor (cevSensor 115)
Sensor for Chassis Cooling Fan in Adapative Security
Appliance 5515
cevSensorASA5515PSFanSensor (cevSensor 118)
Cisco Adaptive Security Appliance (ASA) 5525
Chassis Fan sensor
cevSensorASA5525ChassisFanSensor (cevSensor 122)
Chassis Ambient Temperature Sensor for Cisco
Adaptive Security Appliance 5525
cevSensorASA5525ChassisTemp (cevSensor 108)
Central Processing Unit Temperature Sensor for
Cisco Adaptive Security Appliance 5525
cevSensorASA5525CPUTemp (cevSensor 99)
Table 79-3 SNMP Physical Vendor Type Values (continued)
79-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
Cisco Adaptive Security Appliance (ASA) 5525 with
No Payload Encryption Chassis Fan sensor
cevSensorASA5525K7ChassisFanSensor (cevSensor 127)
Central Processing Unit Temperature Sensor for
Cisco Adaptive Security Appliance 5525 with No
Payload Encryption
cevSensorASA5525K7CPUTemp (cevSensor 104)
Sensor for Chassis Cooling Fan in Adapative Security
Appliance 5525 with No Payload Encryption
cevSensorASA5525K7PSFanSensor (cevSensor 114)
Sensor for Chassis Cooling Fan in Adapative Security
Appliance 5525
cevSensorASA5525PSFanSensor (cevSensor 117)
Cisco Adaptive Security Appliance (ASA) 5545
Chassis Fan sensor
cevSensorASA5545ChassisFanSensor (cevSensor 123)
Chassis Ambient Temperature Sensor for Cisco
Adaptive Security Appliance 5545
cevSensorASA5545ChassisTemp (cevSensor 109)
Central Processing Unit Temperature Sensor for
Cisco Adaptive Security Appliance 5545
cevSensorASA5545CPUTemp (cevSensor 100)
Cisco Adaptive Security Appliance (ASA) 5545 with
No Payload Encryption Chassis Fan sensor
cevSensorASA5545K7ChassisFanSensor (cevSensor 128)
Chassis Ambient Temperature Sensor for Cisco
Adaptive Security Appliance 5545 with No Payload
Encryption
cevSensorASA5545K7ChassisTemp (cevSensor 90)
Central Processing Unit Temperature Sensor for
Cisco Adaptive Security Appliance 5545 with No
Payload Encryption
cevSensorASA5545K7CPUTemp (cevSensor 105)
Sensor for Chassis Cooling Fan in Adapative Security
Appliance 5545 with No Payload Encryption
cevSensorASA5545K7PSFanSensor (cevSensor 113)
Presence Sensor for Power Supply input in Adaptive
Security Appliance 5545 with No Payload Encryption
cevSensorASA5545K7PSPresence (cevSensor 87)
Temperature Sensor for Power Supply Fan in
Adapative Security Appliance 5545 with No Payload
Encryption
cevSensorASA5545K7PSTempSensor (cevSensor 94)
Sensor for Power Supply Fan in Adapative Security
Appliance 5545 with No Payload Encryption
cevSensorASA5545PSFanSensor (cevSensor 89)
Presence Sensor for Power Supply input in Adaptive
Security Appliancce 5545
cevSensorASA5545PSPresence (cevSensor 130)
Presence Sensor for Power Supply input in Adaptive
Security Appliancce 5555
cevSensorASA5545PSPresence (cevSensor 131)
Temperature Sensor for Power Supply Fan in
Adapative Security Appliance 5545
cevSensorASA5545PSTempSensor (cevSensor 92)
Cisco Adaptive Security Appliance (ASA) 5555
Chassis Fan sensor
cevSensorASA5555ChassisFanSensor (cevSensor 124)
Chassis Ambient Temperature Sensor for Cisco
Adaptive Security Appliance 5555
cevSensorASA5555ChassisTemp (cevSensor 110)
Central Processing Unit Temperature Sensor for
Cisco Adaptive Security Appliance 5555
cevSensorASA5555CPUTemp (cevSensor 101)
Table 79-3 SNMP Physical Vendor Type Values (continued)
79-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
Cisco Adaptive Security Appliance (ASA) 5555 with
No Payload Encryption Chassis Fan sensor
cevSensorASA5555K7ChassisFanSensor (cevSensor 129)
Chassis Ambient Temperature Sensor for Cisco
Adaptive Security Appliance 5555 with No Payload
Encryption
cevSensorASA5555K7ChassisTemp (cevSensor 111)
Central Processing Unit Temperature Sensor for
Cisco Adaptive Security Appliance 5555 with No
Payload Encryption
cevSensorASA5555K7CPUTemp (cevSensor 106)
Sensor for Chassis Cooling Fan in Adapative Security
Appliance 5555 with No Payload Encryption
cevSensorASA5555K7PSFanSensor (cevSensor 112)
Presence Sensor for Power Supply input in Adaptive
Security Appliance 5555 with No Payload Encryption
cevSensorASA5555K7PSPresence (cevSensor 88)
Temperature Sensor for Power Supply Fan in
Adapative Security Appliance 5555 with No Payload
Encryption
cevSensorASA5555K7PSTempSensor (cevSensor 95)
Sensor for Power Supply Fan in Adapative Security
Appliance 5555
cevSensorASA5555PSFanSensor (cevSensor 91)
Temperature Sensor for Power Supply Fan in
Adapative Security Appliance 5555
cevSensorASA5555PSTempSensor (cevSensor 93)
Sensor type for ASA 5580 cevSensorASA5580FanSensor (cevSensor 76)
Sensor for power supply input for ASA 5580 cevSensorASA5580PSInput (cevSensor 74)
Sensor for power supply fan for ASA 5585-X cevSensorASA5585PSFanSensor (cevSensor 86)
Sensor for power supply input for ASA 5585-X cevSensorASA5585PSInput (cevSensor 85)
CPU temperature sensor for ASA 5585 SSP-10 cevSensorASA5585SSp10CPUTemp (cevSensor 77)
CPU temperature sensor for ASA 5585 SSP-10 No
Payload Encryption
cevSensorASA5585SSp10K7CPUTemp (cevSensor 78)
CPU temperature sensor for ASA 5585 SSP-20 cevSensorASA5585SSp20CPUTemp (cevSensor 79)
CPU temperature sensor for ASA 5585 SSP-20 No
Payload Encryption
cevSensorASA5585SSp20K7CPUTemp (cevSensor 80)
CPU temperature sensor for ASA 5585 SSP-40 cevSensorASA5585SSp40CPUTemp (cevSensor 81)
CPU temperature sensor for ASA 5585 SSP-40 No
Payload Encryption
cevSensorASA5585SSp40K7CPUTemp (cevSensor 82)
CPU temperature sensor for ASA 5585 SSP-60 cevSensorASA5585SSp60CPUTemp (cevSensor 83)
CPU temperature sensor for ASA 5585 SSP-60 No
Payload Encryption
cevSensorASA5585SSp60K7CPUTemp (cevSensor 84)
Table 79-3 SNMP Physical Vendor Type Values (continued)
79-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
Supported Tables in MIBs
Table 79-4 lists the supported tables and objects for the specified MIBs.
Table 79-4 Supported Tables and Objects in MIBs
MIB Name Supported Tables and Objects
CISCO-ENHANCED-MEMPOOL-MIB cempMemPoolTable, cempMemPoolIndex, cempMemPoolType,
cempMemPoolName, cempMemPoolAlternate, cempMemPoolValid,
cempMemPoolUsed, cempMemPoolFree, cempMemPoolUsedOvrflw,
cempMemPoolHCUsed, cempMemPoolFreeOvrflw,
cempMemPoolHCFree
CISCO-ENTITY-SENSOR-EXT-MIB
Note Not supported on the
ASA Services Module.
ceSensorExtThresholdTable
CISCO-L4L7MODULE-RESOURCE-LIMIT-MIB ciscoL4L7ResourceLimitTable
DISMAN-EVENT-MIB mteTriggerTable, mteTriggerThresholdTable, mteObjectsTable,
mteEventTable, mteEventNotificationTable
DISMAN-EXPRESSION-MIB
Note Not supported on the
ASA Services Module.
expExpressionTable, expObjectTable, expValueTable
ENTITY-SENSOR-MIB
Note Not supported on the
ASA Services Module.
entPhySensorTable
NAT-MIB natAddrMapTable, natAddrMapIndex, natAddrMapName,
natAddrMapGlobalAddrType, natAddrMapGlobalAddrFrom,
natAddrMapGlobalAddrTo, natAddrMapGlobalPortFrom,
natAddrMapGlobalPortTo, natAddrMapProtocol,
natAddrMapAddrUsed, natAddrMapRowStatus,
cnatAddrBindNumberOfEntries, cnatAddrBindSessionCount
79-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
Supported Traps (Notifications)
Table 79-5 lists the supported traps (notifications) and their associated MIBs.
Table 79-5 Supported Traps (Notifications)
Trap and MIB Name Varbind List Description
authenticationFailure
(SNMPv2-MIB)
For SNMP Version 1 or 2, the community
string provided in the SNMP request is
incorrect. For SNMP Version 3, a report
PDU is generated instead of a trap if the
auth or priv passwords or usernames are
incorrect.
The snmp-server enable traps snmp
authentication command is used to
enable and disable transmission of these
traps.
cefcFRUInserted
(CISCO-ENTITY-FRU-CONTROL-MIB)
The snmp-server enable traps entity
fru-insert command is used to enable
this notification.
cefcFRURemoved
(CISCO-ENTITY-FRU-CONTROL-MIB)
The snmp-server enable traps entity
fru-remove command is used to enable
this notification.
79-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
ceSensorExtThresholdNotification
(CISCO-ENTITY-SENSOR-EXT-MIB)
Note Not supported on the
ASA Services Module.
ceSensorExtThresholdValue,
entPhySensorValue,
entPhySensorType,
entPhysicalName
The snmp-server enable traps entity
[power-supply-failure | fan-failure |
cpu-temperature] command is used to
enable transmission of the entity
threshold notifications. This notification
is sent for a power supply failure. The
objects sent identify the fan and CPU
temperature.
The snmp-server enable traps entity
fan-failure command is used to enable
transmission of the fan failure trap.
The snmp-server enable traps entity
power-supply-failure command is used
to enable transmission of the power
supply failure trap.
The snmp-server enable traps entity
chassis-fan-failure command is used to
enable transmission of the chassis fan
failure trap.
The snmp-server enable traps entity
cpu-temperature command is used to
enable transmission of the high CPU
temperature trap.
The snmp-server enable traps entity
power-supply-presence command is
used to enable transmission of the power
supply presence failure trap.
The snmp-server enable traps entity
power-supply-temperature command is
used to enable transmission of the power
supply temperature threshold trap.
The snmp-server enable traps entity
chassis-temperature command is used
to enable transmission of the chassis
ambient temperature trap.
cipSecTunnelStart
(CISCO-IPSEC-FLOW-MONITOR-MIB)
cipSecTunLifeTime,
cipSecTunLifeSize
The snmp-server enable traps ipsec
start command is used to enable
transmission of this trap.
cipSecTunnelStop
(CISCO-IPSEC-FLOW-MONITOR-MIB)
cipSecTunActiveTime The snmp-server enable traps ipsec
stop command is used to enable
transmission of this trap.
ciscoRasTooManySessions
(CISCO-REMOTE-ACCESS-MONITOR
-MIB)
crasNumSessions, crasNumUsers,
crasMaxSessionsSupportable,
crasMaxUsersSupportable,
crasThrMaxSessions
The snmp-server enable traps
remote-access
session-threshold-exceeded command is
used to enable transmission of these
traps.
Table 79-5 Supported Traps (Notifications) (continued)
79-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
clogMessageGenerated
(CISCO-SYSLOG-MIB)
clogHistFacility, clogHistSeverity,
clogHistMsgName,
clogHistMsgText,
clogHistTimestamp
Syslog messages are generated.
The value of the clogMaxSeverity object
is used to decide which syslog messages
are sent as traps.
The snmp-server enable traps syslog
command is used to enable and disable
transmission of these traps.
clrResourceLimitReached
(CISCO-L4L7MODULE-RESOURCE
-LIMIT-MIB)
crlResourceLimitValueType,
crlResourceLimitMax,
clogOriginIDType, clogOriginID
The snmp-server enable traps
connection-limit-reached command is
used to enable transmission of the
connection-limit-reached notification.
The clogOriginID object includes the
context name from which the trap
originated.
coldStart
(SNMPv2-MIB)
The SNMP agent has started.
The snmp-server enable traps snmp
coldstart command is used to enable and
disable transmission of these traps.
cpmCPURisingThreshold
(CISCO-PROCESS-MIB)
cpmCPURisingThresholdValue,
cpmCPUTotalMonIntervalValue,
cpmCPUInterruptMonIntervalValue,
cpmCPURisingThresholdPeriod,
cpmProcessTimeCreated,
cpmProcExtUtil5SecRev
The snmp-server enable traps cpu
threshold rising command is used to
enable transmission of the cpu threshold
rising notification. The
cpmCPURisingThresholdPeriod object is
sent with the other objects.
entConfigChange
(ENTITY-MIB)
The snmp-server enable traps entity
config-change fru-insert fru-remove
command is used to enable this
notification.
Note This notification is only sent in
multimode when a security
context is created or removed.
linkDown
(IF-MIB)
ifIndex, ifAdminStatus,
ifOperStatus
The linkdown trap for interfaces.
The snmp-server enable traps snmp
linkdown command is used to enable and
disable transmission of these traps.
linkUp
(IF-MIB)
ifIndex, ifAdminStatus,
ifOperStatus
The linkup trap for interfaces.
The snmp-server enable traps snmp
linkup command is used to enable and
disable transmission of these traps.
Table 79-5 Supported Traps (Notifications) (continued)
79-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
SNMP Version 3
This section describes SNMP Version 3 and includes the following topics:
SNMP Version 3 Overview, page 79-15
Security Models, page 79-16
SNMP Groups, page 79-16
SNMP Users, page 79-16
SNMP Hosts, page 79-16
Implementation Differences Between the ASA, ASA Services Module, and the Cisco IOS Software,
page 79-16
SNMP Version 3 Overview
SNMP Version 3 provides security enhancements that are not available in SNMP Version 1 or SNMP
Version 2c. SNMP Versions 1 and 2c transmit data between the SNMP server and SNMP agent in clear
text. SNMP Version 3 adds authentication and privacy options to secure protocol operations. In addition,
this version controls access to the SNMP agent and MIB objects through the User-based Security Model
mteTriggerFired
(DISMAN-EVENT-MIB)
mteHotTrigger, mteHotTargetName,
mteHotContextName, mteHotOID,
mteHotValue, cempMemPoolName,
cempMemPoolHCUsed
The snmp-server enable traps
memory-threshold command is used to
enable the memory threshold notification.
The mteHotOID is set to
cempMemPoolHCUsed. The
cempMemPoolName and
cempMemPoolHCUsed objects are sent
with the other objects.
mteTriggerFired
(DISMAN-EVENT-MIB)
Note Not supported on the
ASA Services Module.
mteHotTrigger, mteHotTargetName,
mteHotContextName, mteHotOID,
mteHotValue, ifHCInOctets,
ifHCOutOctets, ifHighSpeed,
entPhysicalName
The snmp-server enable traps
interface-threshold command is used to
enable the interface threshold
notification. The entPhysicalName
objects are sent with the other objects.
natPacketDiscard
(NAT-MIB)
ifIndex The snmp-server enable traps nat
packet-discard command is used to
enable the NAT packet discard
notification. This notification is rate
limited for 5 minutes and is generated
when IP packets are discarded by NAT
because mapping space is not available.
The ifIndex gives the ID of the mapped
interface.
warmStart
(SNMPv2-MIB)
The snmp-server enable traps snmp
warmstart command is used to enable
and disable transmission of these traps.
Table 79-5 Supported Traps (Notifications) (continued)
79-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Information About SNMP
(USM) and View-based Access Control Model (VACM). The ASA also support the creation of SNMP
groups and users, as well as hosts, which is required to enable transport authentication and encryption
for secure SNMP communications.
Security Models
For configuration purposes, the authentication and privacy options are grouped together into security
models. Security models apply to users and groups, which are divided into the following three types:
NoAuthPrivNo Authentication and No Privacy, which means that no security is applied to
messages.
AuthNoPrivAuthentication but No Privacy, which means that messages are authenticated.
AuthPrivAuthentication and Privacy, which means that messages are authenticated and encrypted.
SNMP Groups
An SNMP group is an access control policy to which users can be added. Each SNMP group is
configured with a security model, and is associated with an SNMP view. A user within an SNMP group
must match the security model of the SNMP group. These parameters specify what type of authentication
and privacy a user within an SNMP group uses. Each SNMP group name and security model pair must
be unique.
SNMP Users
SNMP users have a specified username, a group to which the user belongs, authentication password,
encryption password, and authentication and encryption algorithms to use. The authentication algorithm
options are MD5 and SHA. The encryption algorithm options are DES, 3DES, and AES (which is
available in 128, 192, and 256 versions). When you create a user, you must associate it with an SNMP
group. The user then inherits the security model of the group.
SNMP Hosts
An SNMP host is an IP address to which SNMP notifications and traps are sent. To configure SNMP
Version 3 hosts, along with the target IP address, you must configure a username, because traps are only
sent to a configured user. SNMP target IP addresses and target parameter names must be unique on the
ASA. Each SNMP host can have only one username associated with it. To receive SNMP traps, after you
have added the snmp-server host command, make sure that you configure the user credentials on the
NMS to match the credentials for the ASA.
Implementation Differences Between the ASA, ASA Services Module, and the Cisco IOS Software
The SNMP Version 3 implementation in the ASA and ASASM differs from the SNMP Version 3
implementation in the Cisco IOS software in the following ways:
The local-engine and remote-engine IDs are not configurable. The local engine ID is generated when
the ASA starts or when a context is created.
No support exists for view-based access control, which results in unrestricted MIB browsing.
Support is restricted to the following MIBs: USM, VACM, FRAMEWORK, and TARGET.
You must create users and groups with the correct security model.
79-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Licensing Requirements for SNMP
You must remove users, groups, and hosts in the correct sequence.
Use of the snmp-server host command creates an ASA rule to allow incoming SNMP traffic.
Licensing Requirements for SNMP
The following table shows the licensing requirements for this feature:
Prerequisites for SNMP
SNMP has the following prerequisite:
You must have Cisco Works for Windows or another SNMP MIB-II compliant browser to receive SNMP
traps or browse a MIB.
Guidelines and Limitations
This section includes the guidelines and limitations for this feature.
Context Mode Guidelines
Supported in single and multiple context mode.
Firewall Mode Guidelines
Supported in routed and transparent firewall mode.
Failover Guidelines
Supported in SNMP Version 3.
The SNMP client in each ASA shares engine data with its peer. Engine data includes the engineID,
engineBoots, and engineTime objects of the SNMP-FRAMEWORK-MIB. Engine data is written as
a binary file to flash:/snmp/contextname.
IPv6 Guidelines
Does not support IPv6.
Additional Guidelines
Does not support view-based access control, but the VACM MIB is available for browsing to
determine default view settings.
The ENTITY-MIB is not available in the non-admin context. Use the IF-MIB instead to perform
queries in the non-admin context.
License Requirement
Base License: Base (DES).
Optional license: Strong (3DES, AES)
79-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Configuring SNMP
Does not support SNMP Version 3 for the AIP SSM or AIP SSC.
Does not support SNMP debugging.
Does not support retireval of ARP information.
Does not support SNMP SET commands.
When using NET-SNMP Version 5.4.2.1, only supports the encryption algorithm version of
AES128. Does not support the encryption algorithm versions of AES256 or AES192.
Changes to the existing configuration are rejected if the result places the SNMP feature in an
inconsistent state.
For SNMP Version 3, configuration must occur in the following order: group, user, host.
Before a group is deleted, you must ensure that all users associated with that group are deleted.
Before a user is deleted, you must ensure that no hosts are configured that are associated with that
username.
If users have been configured to belong to a particular group with a certain security model, and if
the security level of that group is changed, you must do the following in this sequence:
Remove the users from that group.
Change the group security level.
Add users that belong to the new group.
The creation of custom views to restrict user access to a subset of MIB objects is not supported.
All requests and traps are available in the default Read/Notify View only.
The connection-limit-reached trap is generated in the admin context. To generate this trap. you must
have at least one snmp-server host configured in the user context in which the connection limit has
been reached.
The value returned for ifNumber will be larger than the number of interfaces that you can query
through SNMP, because ifNumber includes hidden internal interfaces that are not viewable.
You cannot query for the chassis temperature for the ASA 5585 SSP-40 (NPE).
Configuring SNMP
This section describes how to configure SNMP and includes the following topics:
Enabling SNMP, page 79-18
Configuring SNMP Traps, page 79-20
Configuring a CPU Usage Threshold, page 79-21
Configuring a Physical Interface Threshold, page 79-21
Using SNMP Version 1 or 2c, page 79-22
Using SNMP Version 3, page 79-23
Enabling SNMP
The SNMP agent that runs on the ASA performs two functions:
Replies to SNMP requests from NMSs.
79-19
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Configuring SNMP
Sends traps (event notifications) to NMSs.
To enable the SNMP agent and identify an NMS that can connect to the SNMP server, enter the following
command:
Command Purpose
snmp-server enable
Example:
hostname(config)# snmp-server
enable
Ensures that the SNMP server on the ASA is enabled. By default, the SNMP server
is enabled.
79-20
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Configuring SNMP
What to Do Next
See the Configuring SNMP Traps section on page 79-20.
Configuring SNMP Traps
To designate which traps that the SNMP agent generates and how they are collected and sent to NMSs,
enter the following command:
Command Purpose
snmp-server enable traps [all |
syslog | snmp [authentication |
linkup | linkdown | coldstart |
warmstart] | entity [config-change |
fru-insert | fru-remove | fan-failure
| cpu-temperature | chassis-fan-
failure | power-supply-failure] |
chassis-temperature |
power-supply-presence |
power-supply-temperature] ikev2
[start | stop] |ipsec [start | stop]
| remote-access
[session-threshold-exceeded]|
connection-limit-reached | cpu
threshold rising |
interface-threshold |
memory-threshold | nat
[packet-discard]
Example:
hostname(config)# snmp-server enable
traps snmp authentication linkup
linkdown coldstart warmstart
Note The interface-threshold trap is not
supported on the ASASM.
Sends individual traps, sets of traps, or all traps to the NMS. Enables syslog
messages to be sent as traps to the NMS. The default configuration has all
SNMP standard traps enabled, as shown in the example. To disable these traps,
use the no snmp-server enable traps snmp command. If you enter this
command and do not specify a trap type, the default is the syslog trap. By
default, the syslog trap is enabled. The default SNMP traps continue to be
enabled with the syslog trap. You need to configure both the logging history
command and the snmp-server enable traps syslog command to generate traps
from the syslog MIB. To restore the default enabling of SNMP traps, use the
clear configure snmp-server command. All other traps are disabled by default.
Keywords available in the admin context only:
connection-limit-reached
entity
memory-threshold
Traps generated through the admin context only for physically connected
interfaces in the system context:
interface-threshold
All other traps are available in the admin and user contexts in single mode. In
multi-mode, the fan-failure trap, the power-supply-failure trap, and the
cpu-temperature trap are generated only from the admin context, and not the
user contexts (applies only to the ASA 5512-X, 5515-X, 5525-X, 5545-X, and
5555-X).
If the CPU usage is greater than the configured threshold value for the
configured monitoring period, the cpu threshold rising trap is generated.
When the used system context memory reaches 80 percent of the total system
memory, the memory-threshold trap is generated from the admin context. For
all other user contexts, this trap is generated when the used memory reaches 80
percent of the total system memory in that particular context.
Note SNMP does not monitor voltage sensors.
79-21
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Configuring SNMP
What to Do Next
See the Configuring a CPU Usage Threshold section on page 79-21.
Configuring a CPU Usage Threshold
To configure the CPU usage threshold, enter the following command:
What to Do Next
See the Configuring a Physical Interface Threshold section on page 79-21.
Configuring a Physical Interface Threshold
To configure the physical interface threshold, enter the following command:
What to Do Next
Choose one of the following:
See the Using SNMP Version 1 or 2c section on page 79-22.
See the Using SNMP Version 3 section on page 79-23.
Command Purpose
snmp cpu threshold rising
threshold_value monitoring_period
Example:
hostname(config)# snmp cpu threshold
rising 75% 30 minutes
Configures the threshold value for a high CPU threshold and the threshold
monitoring period. To clear the threshold value and monitoring period of the
CPU utilization, use the no form of this command. If the snmp cpu threshold
rising command is not configured, the default for the high threshold level is
over 70 percent, and the default for the critical threshold level is over 95 percent.
The default monitoring period is set to 1 minute.
You cannot configure the critical CPU threshold level, which is maintained at a
constant 95 percent. Valid threshold values for a high CPU threshold range from
10 to 94 percent. Valid values for the monitoring period range from 1 to 60
minutes.
Command Purpose
snmp interface threshold
threshold_value
Example:
hostname(config)# snmp interface
threshold 75%
Note Not supported on the
ASA Services Module.
Configures the threshold value for an SNMP physical interface. To clear the
threshold value for an SNMP physical interface, use the no form of this
command. The threshold value is defined as a percentage of interface bandwidth
utilization. Valid threshold values range from 30 to 99 percent. The default
value is 70 percent.
The snmp interface threshold command is available only in the admin context.
Note Physical interface usage is monitored in single mode and multimode,
and traps for physical interfaces in the system context are sent through
the admin context. Only physical interfaces are used to compute
threshold usage.
79-22
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Configuring SNMP
Using SNMP Version 1 or 2c
To configure parameters for SNMP Version 1 or 2c, perform the following steps:
Detailed Steps
Command Purpose
Step 1 snmp-server host interface)
hostname | ip_address} [trap |
poll] [community
community-string] [version {1 |
2c username}] [udp-port port]
Example:
hostname(config)# snmp-server
host mgmt 10.7.14.90 version 2
hostname(config)# snmp-server
host corp 172.18.154.159
community public
Specifies the recipient of an SNMP notification, indicates the interface
from which traps are sent, and identifies the name and IP address of the
NMS or SNMP manager that can connect to the ASA. The trap keyword
limits the NMS to receiving traps only. The poll keyword limits the NMS
to sending requests (polling) only. By default, SNMP traps are enabled.
By default, the UDP port is 162. The community string is a shared secret
key between the ASA and the NMS. The key is a case-sensitive value up
to 32 alphanumeric characters. Spaces are not permitted. The default
community-string is public. The ASA uses this key to determine whether
the incoming SNMP request is valid. For example, you could designate a
site with a community string and then configure the ASA and the
management station with the same string. The ASA uses the specified
string and does not respond to requests with an invalid community string.
For more information about SNMP hosts, see the SNMP Hosts section
on page 79-16.
Note To receive traps, after you have added the snmp-server host
command, make sure that you configure the user on the NMS with
the same credentials as the credentials configured on the ASA.
Step 2 snmp-server community
community-string
Example:
hostname(config)# snmp-server
community onceuponatime
Sets the community string, which is for use only with SNMP Version 1 or
2c.
Step 3 snmp-server [contact | location]
text
Example:
hostname(config)# snmp-server
location building 42
hostname(config)# snmp-server
contact EmployeeA
Sets the SNMP server location or contact information.
79-23
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Configuring SNMP
What to Do Next
See the Monitoring SNMP section on page 79-26.
Using SNMP Version 3
To configure parameters for SNMP Version 3, perform the following steps:
Detailed Steps
Command Purpose
Step 1 snmp-server group group-name v3
[auth | noauth | priv]
Example:
hostname(config)# snmp-server
group testgroup1 v3 auth
Specifies a new SNMP group, which is for use only with SNMP Version
3. When a community string is configured, two additional groups with the
name that matches the community string are autogenerated: one for the
Version 1 security model and one for the Version 2 security model. For
more information about security models, see the Security Models
section on page 79-16. The auth keyword enables packet authentication.
The noauth keyword indicates no packet authentication or encryption is
being used. The priv keyword enables packet encryption and
authentication. No default values exist for the auth or priv keywords.
Step 2 snmp-server user username
group-name {v3 [encrypted]] [auth
{md5 | sha]} auth-password [priv
[des | 3des | aes]
[128 | 192 | 256] priv-password
Example:
hostname(config)# snmp-server
user testuser1 testgroup1 v3 auth
md5 testpassword aes 128
mypassword
hostname(config)# snmp-server
user testuser1 public v3
encrypted auth md5
00:11:22:33:44:55:66:77:88:99:AA:
BB:CC:DD:EE:FF
Configures a new user for an SNMP group, which is for use only with
SNMP Version 3. The username argument is the name of the user on the
host that belongs to the SNMP agent. The group-name argument is the
name of the group to which the user belongs. The v3 keyword specifies
that the SNMP Version 3 security model should be used and enables the
use of the encrypted, priv, and the auth keywords. The encrypted
keyword specifies the password in encrypted format. Encrypted
passwords must be in hexadecimal format. The auth keyword specifies
which authentication level (md5 or sha) should be used. The priv
keyword specifies the encryption level. No default values for the auth or
priv keywords, or default passwords exist. For the encryption algorithm,
you can specify either the des, 3des, or aes keyword. You can also specify
which version of the AES encryption algorithm to use: 128, 192, or 256.
The auth-password argument specifies the authentication user password.
The priv-password argument specifies the encryption user password.
Note If you forget a password, you cannot recover it and you must
reconfigure the user. You can specify a plain-text password or a
localized digest. The localized digest must match the
authentication algorithm selected for the user, which can be either
MD5 or SHA. When the user configuration is displayed on the
console or is written to a file (for example, the
startup-configuration file), the localized authentication and
privacy digests are always displayed instead of a plain-text
password (see the second example). The minimum length for a
password is 1 alphanumeric character; however, we recommend
that you use at least 8 alphanumeric characters for security.
79-24
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Troubleshooting Tips
What to Do Next
See the Monitoring SNMP section on page 79-26.
Troubleshooting Tips
To ensure that the SNMP process that receives incoming packets from the NMS is running, enter the
following command:
hostname(config)# show process | grep snmp
To capture syslog messages from SNMP and have them appear on the ASA or ASASM console, enter
the following commands:
hostname(config)# logging list snmp message 212001-212015
hostname(config)# logging console snmp
To make sure that the SNMP process is sending and receiving packets, enter the following commands:
hostname(config)# clear snmp-server statistics
hostname(config)# show snmp-server statistics
Step 3 snmp-server host interface
{hostname | ip_address} [trap |
poll] [community
community-string] [version {1 |
2c | 3 username}] [udp-port port]
Example:
hostname(config)# snmp-server
host mgmt 10.7.14.90 version 3
testuser1
hostname(config)# snmp-server
host mgmt 10.7.26.5 version 3
testuser2
Specifies the recipient of an SNMP notification. Indicates the interface
from which traps are sent. Identifies the name and IP address of the NMS
or SNMP manager that can connect to the ASA. The trap keyword limits
the NMS to receiving traps only. The poll keyword limits the NMS to
sending requests (polling) only. By default, SNMP traps are enabled. By
default, the UDP port is 162. The community string is a shared secret key
between the ASA and the NMS. The key is a case-sensitive value up to 32
alphanumeric characters. Spaces are not permitted. The default
community-string is public. The ASA uses this key to determine whether
the incoming SNMP request is valid. For example, you could designate a
site with a community string and then configure the ASAand the NMS
with the same string. The ASAuses the specified string and does not
respond to requests with an invalid community string. For more
information about SNMP hosts, see the SNMP Hosts section on
page 79-16.
Note When SNMP Version 3 hosts are configured on the ASA, a user
must be associated with that host. To receive traps, after you have
added the snmp-server host command, make sure that you
configure the user on the NMS with the same credentials as the
credentials configured on the ASA.
Step 4 snmp-server [contact | location]
text
Example:
hostname(config)# snmp-server
location building 42
hostname(config)# snmp-server
contact EmployeeA
Sets the SNMP server location or contact information.
Command Purpose
79-25
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Troubleshooting Tips
The output is based on the SNMP group of the SNMPv2-MIB.
To make sure that SNMP packets are going through the ASA or ASASM and to the SNMP process, enter
the following commands:
hostname(config)# clear asp drop
hostname(config)# show asp drop
If the NMS cannot request objects successfully or is not handing incoming traps from the ASA or
ASASM correctly, use a packet capture to isolate the problem, by entering the following commands:
hostname (config)# access-list snmp permit udp any eq snmptrap any
hostname (config)# access-list snmp permit udp any any eq snmp
hostname (config)# capture snmp type raw-data access-list snmp interface mgmt
hostname (config)# copy /pcap capture:snmp tftp://192.0.2.5/exampledir/snmp.pcap
If the ASA or ASASM is not performing as expected, obtain information about network topology and
traffic by doing the following:
For the NMS configuration, obtain the following information:
Number of timeouts
Retry count
Engine ID caching
Username and password used
Run the following commands:
show block
show interface
show process
show cpu
If a fatal error occurs, to help in reproducing the error, send a traceback file and the output of the show
tech-support command to Cisco TAC.
If SNMP traffic is not being allowed through the ASA or ASASM interfaces, you might also need to
permit ICMP traffic from the remote SNMP server using the icmp permit command.
For the ASA 5580, differences may appear in the physical interface statistics output and the logical
interface statistics output between the show interface command and the show traffic command.
Interface Types and Examples
The interface types that produce SNMP traffic statistics include the following:
LogicalStatistics collected by the software driver, which are a subset of physical statistics.
PhysicalStatistics collected by the hardware driver. Each physical named interface has a set of
logical and physical statistics associated with it. Each physical interface may have more than one
VLAN interface associated with it. VLAN interfaces only have logical statistics.
Note For a physical interface that has multiple VLAN interfaces associated with it, be aware that
SNMP counters for ifInOctets and ifOutoctets OIDs match the aggregate traffic counters for that
physical interface.
79-26
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Monitoring SNMP
VLAN-onlySNMP uses logical statistics for ifInOctets and ifOutOctets.
The examples in Table 79-6 show the differences in SNMP traffic statistics. Example 1 shows the
difference in physical and logical output statistics for the show interface command and the show traffic
command. Example 2 shows output statistics for a VLAN-only interface for the show interface
command and the show traffic command. The example shows that the statistics are close to the output
that appears for the show traffic command.
Monitoring SNMP
NMSs are the PCs or workstations that you set up to monitor SNMP events and manage devices, such as
the ASA.You can monitor the health of a device from an NMS by polling required information from the
SNMP agent that has been set up on the device. Predefined events from the SNMP agent to the NMS
generate syslog messages. This section includes the following topics:
SNMP Syslog Messaging, page 79-27
SNMP Monitoring, page 79-27
Table 79-6 SNMP Traffic Statistics for Physical and VLAN Interfaces
Example 1 Example 2
hostname# show interface GigabitEthernet3/2
interface GigabitEthernet3/2
description fullt-mgmt
nameif mgmt
security-level 10
ip address 10.7.14.201 255.255.255.0
management-only
hostname# show traffic
(Condensed output)
Physical Statistics
GigabitEthernet3/2:
received (in 121.760 secs)
36 packets 3428 bytes
0 pkts/sec 28 bytes/sec
Logical Statistics
mgmt:
received (in 117.780 secs)
36 packets 2780 bytes
0 pkts/sec 23 bytes/sec
The following examples show the SNMP output statistics for the
management interface and the physical interface. The ifInOctets
value is close to the physical statistics output that appears in the
show traffic command output but not to the logical statistics
output.
ifIndex of the mgmt interface:
IF_MIB::ifDescr.6 = Adaptive Security Appliance mgmt
interface
ifInOctets that corresponds to the physical interface statistics:
IF-MIB::ifInOctets.6 = Counter32:3246
hostname# show interface GigabitEthernet0/0.100
interface GigabitEthernet0/0.100
vlan 100
nameif inside
security-level 100
ip address 10.7.1.101 255.255.255.0 standby
10.7.1.102
hostname# show traffic
inside
received (in 9921.450 secs)
1977 packets 126528 bytes
0 pkts/sec 12 bytes/sec
transmitted (in 9921.450 secs)
1978 packets 126556 bytes
0 pkts/sec 12 bytes/sec
ifIndex of VLAN inside:
IF-MIB::ifDescr.9 = Adaptive Security Appliance
inside interface
IF-MIB::ifInOctets.9 = Counter32: 126318
79-27
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Monitoring SNMP
SNMP Syslog Messaging
SNMP generates detailed syslog messages that are numbered 212nnn. Syslog messages indicate the
status of SNMP requests, SNMP traps, SNMP channels, and SNMP responses from the ASA to a
specified host on a specified interface.
For detailed information about syslog messages, see syslog message guide.
Note SNMP polling fails if SNMP syslog messages exceed a high rate (approximately 4000 per second).
SNMP Monitoring
To monitor SNMP, enter one of the following commands:
Examples
The following example shows how to display SNMP server statistics:
hostname(config)# show snmp-server statistics
0 SNMP packets input
0 Bad SNMP version errors
0 Unknown community name
0 Illegal operation for community name supplied
0 Encoding errors
0 Number of requested variables
0 Number of altered variables
0 Get-request PDUs
0 Get-next PDUs
Command Purpose
show running-config [default]
snmp-server
Shows all SNMP server configuration information.
show running-config snmp-server group
Shows SNMP group configuration settings.
show running-config snmp-server host
Shows configuration settings used by SNMP to control messages and
notifications sent to remote hosts.
show running-config snmp-server user
Shows SNMP user-based configuration settings.
show snmp-server engineid
Shows the ID of the SNMP engine configured.
show snmp-server group
Shows the names of configured SNMP groups.
Note If the community string has already been configured, two extra groups
appear by default in the output. This behavior is normal.
show snmp-server statistics
Shows the configured characteristics of the SNMP server.
To reset all SNMP counters to zero, use the clear snmp-server statistics
command.
show snmp-server user
Shows the configured characteristics of users.
79-28
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Configuration Examples for SNMP
0 Get-bulk PDUs
0 Set-request PDUs (Not supported)
0 SNMP packets output
0 Too big errors (Maximum packet size 512)
0 No such name errors
0 Bad values errors
0 General errors
0 Response PDUs
0 Trap PDUs
The following example shows how to display the SNMP server running configuration:
hostname(config)# show running-config snmp-server
no snmp-server location
no snmp-server contact
snmp-server enable traps snmp authentication linkup linkdown coldstart
Configuration Examples for SNMP
This section includes the following topics:
Configuration Example for SNMP Versions 1 and 2c, page 79-28
Configuration Example for SNMP Version 3, page 79-28
Configuration Example for SNMP Versions 1 and 2c
The following example shows how the ASA can receive SNMP requests from host 192.0.2.5 on the
inside interface but does not send any SNMP syslog requests to any host:
hostname(config)# snmp-server host 192.0.2.5
hostname(config)# snmp-server location building 42
hostname(config)# snmp-server contact EmployeeA
hostname(config)# snmp-server community ohwhatakeyisthee
Configuration Example for SNMP Version 3
The following example shows how the ASA can receive SNMP requests using the SNMP Version 3
security model, which requires that the configuration follow this specific order: group, followed by user,
followed by host:
hostname(config)# snmp-server group v3 vpn-group priv
hostname(config)# snmp-server user admin vpn group v3 auth sha letmein priv 3des cisco123
hostname(config)# snmp-server host mgmt 10.0.0.1 version 3 priv admin
79-29
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Where to Go Next
Where to Go Next
To configure the syslog server, see Chapter 77, Configuring Logging.
Additional References
For additional information related to implementing SNMP, see the following sections:
RFCs for SNMP Version 3, page 79-29
MIBs, page 79-29
Application Services and Third-Party Tools, page 79-31
RFCs for SNMP Version 3
MIBs
For a list of supported MIBs and traps for the ASAby release, see the following URL:
http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml
Not all OIDs in MIBs are supported. To obtain a list of the supported SNMP MIBs and OIDs for a
specific ASA, enter the following command:
hostname(config)# show snmp-server oidlist
Note Although the oidlist keyword does not appear in the options list for the show snmp-server command
help, it is available. However, this command is for Cisco TAC use only. Contact the Cisco TAC before
using this command.
The following is sample output from the show snmp-server oidlist command:
hostname(config)# show snmp-server oidlist
[0] 1.3.6.1.2.1.1.1. sysDescr
[1] 1.3.6.1.2.1.1.2. sysObjectID
[2] 1.3.6.1.2.1.1.3. sysUpTime
[3] 1.3.6.1.2.1.1.4. sysContact
[4] 1.3.6.1.2.1.1.5. sysName
[5] 1.3.6.1.2.1.1.6. sysLocation
RFC Title
3410 Introduction and Applicability Statements for Internet Standard Management Framework
3411 An Architecture for Describing SNMP Management Frameworks
3412 Message Processing and Dispatching for the Simple Network Management Protocol (SNMP)
3413 Simple Network Management Protocol (SNMP) Applications
3414 User-based Security Model (USM) for Version 3 of the Simple Network Management Protocol (SNMP)
3826 The Advanced Encryption Standard (AES) Cipher Algorithm in the SNMP User-based Security Model
79-30
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Additional References
[6] 1.3.6.1.2.1.1.7. sysServices
[7] 1.3.6.1.2.1.2.1. ifNumber
[8] 1.3.6.1.2.1.2.2.1.1. ifIndex
[9] 1.3.6.1.2.1.2.2.1.2. ifDescr
[10] 1.3.6.1.2.1.2.2.1.3. ifType
[11] 1.3.6.1.2.1.2.2.1.4. ifMtu
[12] 1.3.6.1.2.1.2.2.1.5. ifSpeed
[13] 1.3.6.1.2.1.2.2.1.6. ifPhysAddress
[14] 1.3.6.1.2.1.2.2.1.7. ifAdminStatus
[15] 1.3.6.1.2.1.2.2.1.8. ifOperStatus
[16] 1.3.6.1.2.1.2.2.1.9. ifLastChange
[17] 1.3.6.1.2.1.2.2.1.10. ifInOctets
[18] 1.3.6.1.2.1.2.2.1.11. ifInUcastPkts
[19] 1.3.6.1.2.1.2.2.1.12. ifInNUcastPkts
[20] 1.3.6.1.2.1.2.2.1.13. ifInDiscards
[21] 1.3.6.1.2.1.2.2.1.14. ifInErrors
[22] 1.3.6.1.2.1.2.2.1.16. ifOutOctets
[23] 1.3.6.1.2.1.2.2.1.17. ifOutUcastPkts
[24] 1.3.6.1.2.1.2.2.1.18. ifOutNUcastPkts
[25] 1.3.6.1.2.1.2.2.1.19. ifOutDiscards
[26] 1.3.6.1.2.1.2.2.1.20. ifOutErrors
[27] 1.3.6.1.2.1.2.2.1.21. ifOutQLen
[28] 1.3.6.1.2.1.2.2.1.22. ifSpecific
[29] 1.3.6.1.2.1.4.1. ipForwarding
[30] 1.3.6.1.2.1.4.20.1.1. ipAdEntAddr
[31] 1.3.6.1.2.1.4.20.1.2. ipAdEntIfIndex
[32] 1.3.6.1.2.1.4.20.1.3. ipAdEntNetMask
[33] 1.3.6.1.2.1.4.20.1.4. ipAdEntBcastAddr
[34] 1.3.6.1.2.1.4.20.1.5. ipAdEntReasmMaxSize
[35] 1.3.6.1.2.1.11.1. snmpInPkts
[36] 1.3.6.1.2.1.11.2. snmpOutPkts
[37] 1.3.6.1.2.1.11.3. snmpInBadVersions
[38] 1.3.6.1.2.1.11.4. snmpInBadCommunityNames
[39] 1.3.6.1.2.1.11.5. snmpInBadCommunityUses
[40] 1.3.6.1.2.1.11.6. snmpInASNParseErrs
[41] 1.3.6.1.2.1.11.8. snmpInTooBigs
[42] 1.3.6.1.2.1.11.9. snmpInNoSuchNames
[43] 1.3.6.1.2.1.11.10. snmpInBadValues
[44] 1.3.6.1.2.1.11.11. snmpInReadOnlys
[45] 1.3.6.1.2.1.11.12. snmpInGenErrs
[46] 1.3.6.1.2.1.11.13. snmpInTotalReqVars
[47] 1.3.6.1.2.1.11.14. snmpInTotalSetVars
[48] 1.3.6.1.2.1.11.15. snmpInGetRequests
[49] 1.3.6.1.2.1.11.16. snmpInGetNexts
[50] 1.3.6.1.2.1.11.17. snmpInSetRequests
[51] 1.3.6.1.2.1.11.18. snmpInGetResponses
[52] 1.3.6.1.2.1.11.19. snmpInTraps
[53] 1.3.6.1.2.1.11.20. snmpOutTooBigs
[54] 1.3.6.1.2.1.11.21. snmpOutNoSuchNames
[55] 1.3.6.1.2.1.11.22. snmpOutBadValues
[56] 1.3.6.1.2.1.11.24. snmpOutGenErrs
[57] 1.3.6.1.2.1.11.25. snmpOutGetRequests
[58] 1.3.6.1.2.1.11.26. snmpOutGetNexts
[59] 1.3.6.1.2.1.11.27. snmpOutSetRequests
[60] 1.3.6.1.2.1.11.28. snmpOutGetResponses
[61] 1.3.6.1.2.1.11.29. snmpOutTraps
[62] 1.3.6.1.2.1.11.30. snmpEnableAuthenTraps
[63] 1.3.6.1.2.1.11.31. snmpSilentDrops
[64] 1.3.6.1.2.1.11.32. snmpProxyDrops
[65] 1.3.6.1.2.1.31.1.1.1.1. ifName
[66] 1.3.6.1.2.1.31.1.1.1.2. ifInMulticastPkts
[67] 1.3.6.1.2.1.31.1.1.1.3. ifInBroadcastPkts
[68] 1.3.6.1.2.1.31.1.1.1.4. ifOutMulticastPkts
[69] 1.3.6.1.2.1.31.1.1.1.5. ifOutBroadcastPkts
79-31
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Feature History for SNMP
[70] 1.3.6.1.2.1.31.1.1.1.6. ifHCInOctets
--More--
Application Services and Third-Party Tools
For information about SNMP support, see the following URL:
http://www.cisco.com/en/US/tech/tk648/tk362/tk605/tsd_technology_support_sub-protocol_home.htm
l
For information about using third-party tools to walk SNMP Version 3 MIBs, see the following URL:
http://www.cisco.com/en/US/docs/security/asa/asa83/snmp/snmpv3_tools.html
Feature History for SNMP
Table 79-7 lists each feature change and the platform release in which it was implemented.
Table 79-7 Feature History for SNMP
Feature Name
Platform
Releases Feature Information
SNMP Versions 1
and 2c
7.0(1) Provides ASA network monitoring and event information by transmitting data
between the SNMP server and SNMP agent through the clear text community string.
SNMP Version 3 8.2(1) Provides 3DES or AES encryption and support for SNMP Version 3, the most secure
form of the supported security models. This version allows you to configure users,
groups, and hosts, as well as authentication characteristics by using the USM. In
addition, this version allows access control to the agent and MIB objects and includes
additional MIB support.
We introduced or modified the following commands: show snmp-server engineid,
show snmp-server group, show snmp-server user, snmp-server group,
snmp-server user, snmp-server host.
Password encryption 8.3(1) Supports password encryption.
We modified the following commands: snmp-server community, snmp-server
host.
79-32
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 79 Configuring SNMP
Feature History for SNMP
SNMP traps and
MIBs
8.4(1) Supports the following additional keywords: connection-limit-reached, cpu
threshold rising, entity cpu-temperature, entity fan-failure, entity power-supply,
ikev2 stop | start, interface-threshold, memory-threshold, nat packet-discard,
warmstart.
The entPhysicalTable reports entries for sensors, fans, power supplies, and related
components.
Supports the following additional MIBs: CISCO-ENTITY-SENSOR-EXT-MIB,
CISCO-ENTITY-FRU-CONTROL-MIB, CISCO-PROCESS-MIB,
CISCO-ENHANCED-MEMPOOL-MIB,
CISCO-L4L7MODULE-RESOURCE-LIMIT-MIB, DISMAN-EVENT-MIB,
DISMAN-EXPRESSION-MIB, ENTITY-SENSOR-MIB, NAT-MIB.
Supports the following additional traps: ceSensorExtThresholdNotification,
clrResourceLimitReached, cpmCPURisingThreshold, mteTriggerFired,
natPacketDiscard, warmStart.
We introduced or modified the following commands: snmp cpu threshold rising,
snmp interface threshold, snmp-server enable traps.
IF-MIB ifAlias OID
support
8.2(5)/8.4(2) The ASA now supports the ifAlias OID. When you browse the IF-MIB, the ifAlias
OID will be set to the value that has been set for the interface description.
SNMP traps 8.6(1) Supports the following additional keywords for the ASA 5512-X, 5515-X, 5525-X,
5545-X, and 5555-X: entity power-supply-presence, entity power-supply-failure,
entity chassis-temperature, entity chassis-fan-failure, entity
power-supply-temperature.
We modified the following command: snmp-server enable traps.
NAT MIB 8.4(5) Added the cnatAddrBindNumberOfEntries and cnatAddrBindSessionCount OIDs to
support the xlate_count and max_xlate_count entries, which are the equivalent to
allowing polling using the show xlate count command.
Table 79-7 Feature History for SNMP (continued)
Feature Name
Platform
Releases Feature Information
C H A P T E R
80-1
Cisco ASA 5500 Series Configuration Guide using the CLI
80
Configuring Anonymous Reporting and
Smart Call Home
The Smart Call Home feature provides personalized, e-mail-based and web-based notification to
customers about critical events involving their individual systems, often before customers know that a
critical event has occurred.
The Anonymous Reporting feature is a subfeature of the Smart Call Home feature and allows Cisco to
anonymously receive minimal error and health information from the device.
Note You might have received a popup dialog that invites you to do the following:
Enable Anonymous Reporting to help improve the ASA platform.
Register for Smart Home Notifications to receive personalized, proactive assistance from Cisco.
For information about the dialog, see the Anonymous Reporting and Smart Call Home Prompt section
on page 80-3.
This chapter describes how to use and configure Anonymous Reporting and Smart Call Home, and it
includes the following sections:
Information About Anonymous Reporting and Smart Call Home, page 80-1
Licensing Requirements for Anonymous Reporting and Smart Call Home, page 80-4
Prerequisites for Smart Call Home and Anonymous Reporting, page 80-5
Guidelines and Limitations, page 80-5
Configuring Anonymous Reporting and Smart Call Home, page 80-6
Monitoring Smart Call Home, page 80-19
Configuration Example for Smart Call Home, page 80-19
Feature History for Anonymous Reporting and Smart Call Home, page 80-20
Information About Anonymous Reporting and Smart Call Home
This section includes the following topics:
Information About Anonymous Reporting, page 80-2
Information About Smart Call Home, page 80-4
80-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Information About Anonymous Reporting and Smart Call Home
Information About Anonymous Reporting
Customers can help to improve the ASA platform by enabling Anonymous Reporting, which allows
Cisco to securely receive minimal error and health information from the device. If you enable the feature,
your customer identity will remain anonymous, and no identifying information will be sent.
Enabling Anonymous Reporting creates a trust point and installs a certificate. A CA certificate is
required for your ASA to validate the server certificate present on the Smart Call Home web server and
to form the HTTPS session so that your ASA can send messages securely. Cisco imports a certificate
that is predefined in the software. If you decide to enable Anonymous Reporting, a certificate is installed
on the ASA with a hardcoded trust point name: _SmartCallHome_ServerCA. When you enable
Anonymous Reporting, this trust point is created, the appropriate certificate is installed, and you receive
a message about this action. The certificate then shows up in your configuration.
If the appropriate certificate already exists in your configuration when you enable Anonymous
Reporting, no trust point is created, and no certificate is installed.
Note When you enable Anonymous Reporting you acknowledge your consent to transfer the specified data to
Cisco or to vendors operating on Ciscos behalf (including countries outside of the U.S.).
Cisco maintains the privacy of all customers. For information about Ciscos treatment of personal
information, see the Cisco Privacy Statement at the following URL:
http://www.cisco.com/web/siteassets/legal/privacy.html
What is Sent to Cisco?
Messages are sent to Cisco once a month and whenever the ASA reloads. These messages are categorized
by alert groups, which are predefined subsets of Smart Call Home alerts that are supported on the ASA:
configuration alerts, inventory alerts, and crash information alerts.
Inventory alerts consist of output from the following commands:
show versionDisplays the ASA software version, hardware configuration, license key, and related
uptime data for the device.
show environmentShows system environment information for ASA system components, such as
hardware operational status for the chassis, drivers, fans, and power supplies, as well as temperature
status, voltage, and CPU usage.
show inventoryRetrieves and displays inventory information about each Cisco product that is
installed in the networking device. Each product is identified by unique device information, called
the UDI, which is a combination of three separate data elements: the product identifier (PID), the
version identifier (VID), and the serial number (SN).
show failover stateDisplays the failover state of both units in a failover pair. The information
displayed includes the primary or secondary status of the unit, the Active/Standby status of the unit,
and the last reported reason for failover.
show moduleShows information about any modules installed on the ASAs, for example,
information about an AIP SSC installed on the ASA 5505 or information about an SSP installed on
the ASA 5585-X, and information about an IPS SSP installed on an ASA 5585-X.
Configuration alerts consist of output from the following commands:
show contextShows allocated interfaces and the configuration file URL, the number of contexts
configured, or, if you enable AR in the system execution space, from a list of all contexts.
80-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Information About Anonymous Reporting and Smart Call Home
show call-home registered-module statusDisplays the registered module status. If you use
system configuration mode, the command displays system module status based on the entire device,
not per context.
Upon a system crash, modified information from the following command is sent:
show crashinfo (truncated)Upon an unexpected software reload, the device sends a modified
crash information file with only the traceback section of the file included, so only function calls,
register values, and stack dumps are reported to Cisco.
For more information about ASA commands, see the Cisco ASA 5500 Series Command Reference
document.
DNS Requirement
A DNS server must be configured properly for your ASA to reach the Cisco Smart Call Home server and
send messages to Cisco. Because it is possible that your ASA resides in a private network and does not
have access to the public network, Cisco verifies your DNS configuration and then configures it for you,
if necessary, by doing the following:
1. Performing a DNS lookup for all DNS servers configured.
2. Getting the DNS server from the DHCP server by sending DHCPINFORM messages on the highest
security-level interface.
3. Using the Cisco DNS servers for lookup.
4. Randomly using a static IP addresses for tools.cisco.com.
The above tasks are performed without changing the current configuration. (For example, the DNS
server learned from DHCP will not be added to the configuration.)
If there is no DNS server configured, and your ASA cannot reach the Cisco Smart Call Home Server,
Cisco generates a syslog message with the warning severity for every Smart Call Home message sent
to remind you to configure DNS properly.
For information about system log messages, see the Cisco ASA 5500 Series System Log Messages.
Anonymous Reporting and Smart Call Home Prompt
When you enter configuration mode you receive a prompt that invites you to enable the Anonymous
Reporting and Smart Call Home features if the following criteria are met:
At the prompt you may choose [Y]es, [N]o, [A]sk later. If you choose [A]sk later, then you are reminded
again in seven days or when the ASA reloads. If you continue to choose [A]sk later, the ASA prompts
two more times at seven-day intervals before it assumes a [N]o response and does not ask again.
At the ASDM prompt you can select from the following options:
AnonymousEnables Anonymous Reporting.
Registered (enter an e-mail address)Enables Smart Call Home and registers your ASA with Cisco
TAC.
Do not enable Smart Call HomeDoes not enable Smart Call Home and does not ask again.
Remind Me LaterDefers the decision. You are reminded again in seven days or whenever the ASA
reloads. The ASA prompts two more times at seven-day intervals before it assumes a Do not enable
Smart Call Home response and does not ask again.
80-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Licensing Requirements for Anonymous Reporting and Smart Call Home
If you did not receive the prompt, you may enable Anonymous Reporting or Smart Call Home by
performing the steps in the Configuring Anonymous Reporting section on page 80-6 or the
Configuring Smart Call Home section on page 80-7.
Information About Smart Call Home
When fully configured, Smart Call Home detects issues at your site and reports them back to Cisco or
through other user-defined channels (such as e-mail or directly to you), often before you know that these
issues exist. Depending upon the seriousness of these problems, Cisco responds to customers regarding
their system configuration issues, product end-of-life announcements, security advisory issues, and so
on.
In this manner, Smart Call Home offers proactive diagnostics and real-time alerts on the ASA and
provides high network availability and increased operational efficiency through proactive and quick
issue resolution by doing the following:
Identifying issues quickly with continuous monitoring, real-time proactive alerts, and detailed
diagnostics.
Making you aware of potential problems through Smart Call Home notifications, in which a service
request has been opened, with all diagnostic data attached.
Resolving critical problems faster with direct, automatic access to experts in Cisco TAC.
Smart Call Home offers increased operational efficiency by providing you with the ability to do the
following:
Use staff resources more efficiently by reducing troubleshooting time.
Generate service requests to Cisco TAC automatically, routed to the appropriate support team, which
provides detailed diagnostic information that speeds problem resolution.
The Smart Call Home Portal offers quick, web-based access to required information that provides you
with the ability to do the following:
Review all Smart Call Home messages, diagnostics, and recommendations in one place.
Check service request status quickly.
View the most up-to-date inventory and configuration information for all Smart Call Home-enabled
devices.
Licensing Requirements for Anonymous Reporting and Smart
Call Home
The following table shows the licensing requirements for Anonymous Reporting and Smart Call Home:
Model License Requirement
All models Base License.
80-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Prerequisites for Smart Call Home and Anonymous Reporting
Prerequisites for Smart Call Home and Anonymous Reporting
Smart Call Home and Anonymous Reporting have the following prerequisites:
DNS must be configured. (See the DNS Requirement section on page 80-3 and see the
Configuring the DNS Server section on page 10-11.)
Guidelines and Limitations
Firewall Mode Guidelines
Supported in routed and transparent firewall modes.
Context Mode Guidelines
Supported in single mode and multiple context mode.
IPv6 Guidelines
Supports IPv6.
Additional Guidelines for Anonymous Reporting
If an Anonymous Reporting message cannot be sent on the first try, the ASA retries two more times
before dropping the message.
Anonymous Reporting can coexist with other Smart Call Home configurations without changing the
existing configuration. For example, if Smart Call Home is off before enabling Anonymous
Reporting, it remains off, even after enabling Anonymous Reporting.
Output from the show running-config all command shows details about the Anonymous Reporting
user profile.
If Anonymous Reporting is enabled, you cannot remove the trust point, and when Anonymous
Reporting is disabled, the trust point remains. If Anonymous Reporting is disabled, users can
remove the trustpoint, but disabling Anonymous Reporting will not cause the trustpoint to be
removed.
Additional Guidelines for Smart Call Home
In multiple context mode, the snapshots command is divided into two commands: one to obtain
information from the system context and one to obtain information from the regular context.
The Smart Call Home back-end server can accept messages in XML format only.
80-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
While Anonymous Reporting is a subfeature of the Smart Call Home feature and allows Cisco to
anonymously receive minimal error and health information from the device, the Smart Call Home feature
is more robust and allows for customized support of your system health, allowing Cisco TAC to monitor
your devices and open a case when there is an issue, often before you know the issue occurred.
Generally speaking, you can have both features configured on your system at the same time, yet
configuring the robust Smart Call Home feature provides the same functionality as Anonymous
reporting, plus personalized service.
This section includes the following topics:
Configuring Anonymous Reporting, page 80-6
Configuring Smart Call Home, page 80-7
Configuring Anonymous Reporting
To configure Anonymous Reporting and securely provide minimal error and health information to Cisco,
perform the following steps:
Detailed Steps
Command Purpose
Step 1 call-home reporting anonymous
Example:
hostname(config)# call-home reporting
anonymous
Enables the Anonymous Reporting feature and creates a new
anonymous profile.
Entering this command creates a trust point and installs a
certificate that is used to verify the identity of the Cisco web
server.
Step 2 call-home test reporting anonymous
Example:
hostname(config)# call-home test reporting
anonymous
(Optional) Tests that the Anonymous Reporting feature is fully
enabled. Also ensures that you have connectivity to the server and
that your system is able to send messages.
A success or error message returns test results.
80-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
Configuring Smart Call Home
This section describes how to configure the Smart Call Home feature.
This section includes the following topics:
Enabling Smart Call Home, page 80-7
Declaring and Authenticating a CA Trust Point, page 80-8
Configuring DNS, page 80-8
Subscribing to Alert Groups, page 80-9
Testing Call Home Communications, page 80-11
Optional Configuration Procedures, page 80-13
Enabling Smart Call Home
This section contains information about performing basic setup for the Smart Call Home feature.
To enable Smart Call Home and activate your call-home profile, perform this task:
Step 1 service call-home
Example:
hostname(config)# service call-home
Enables the smart call home service.
Step 2 call-home
Example:
hostname(config)# call-home
Enters call-home configuration mode.
Step 3 contact-email-addr email
Example:
hostname(cfg-call-home)# contact-email-addr
username@example.com
Configures the mandatory contact address. The
address should be the Cisco.com ID account
associated with the device.
Step 4 profile profile-name
Example:
hostname(cfg-call-home)# profile CiscoTAC-1
Enables the profile.
The default profile name is CiscoTAC-1.
Step 5 active
Example:
hostname(cfg-call-home-profile)# active
Activates the call home profile.
To disable this profile, enter the no active command.
Step 6 destination transport-method http
Example:
hostname(cfg-call-home-profile)# destination
transport-method http
Configures the destination transport method for the
smart call-home message receiver.
The default destination transport method is e-mail.
To configure e-mail see the Sending the Output of
a Command section on page 80-12.
80-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
Declaring and Authenticating a CA Trust Point
If Smart Call Home is configured to send messages to a web server through HTTPS, you need to
configure the ASA to trust the certificate of the web server or the certificate of the Certificate Authority
(CA) that issued the certificate. The Cisco Smart Call Home Production server certificate is issued by
Verisign. The Cisco Smart Call Home Staging server certificate is issued by Digital Signature Trust Co.
Detailed Steps
To declare and authenticate the Cisco server security certificate and establish communication with the
Cisco HTTPS server for Smart Call Home service, perform this task:
Configuring DNS
You must configure DNS so that the HTTPS URLs in the Smart Call Home profile can successfully
resolve.
To configure DNS, perform the following tasks:
Step 1 crypto ca truspoint trustpoint-name
Example:
hostname(config)# crypto ca trustpoint cisco
Configures a trustpoint and prepares for certificate
enrollment.
Note If you use HTTP as the transport method,
you must install a security certificate
through a trustpoint, which is required for
HTTPS. Find the specific certificate to
install at the following URL:
http://www.cisco.com/en/US/docs/switches/lan
/smart_call_home/SCH31_Ch6.html#wp10353
80
Step 2 enroll terminal
Example:
hostname(ca-trustpoint)# enroll terminal
Specifies a manual cut-and-paste method of
certificate enrollment.
Step 3 exit
hostname(ca-trustpoint)# exit
Exits CA trustpoint configuration mode and returns
to global configuration mode.
Step 4 crypto ca authenticate trustpoint
Example:
hostname(ca-trustpoint)# crypto ca authenticate
cisco
Authenticates the named CA. The CA name should
match the trust point name specified in the crypto ca
trustpoint command. At the prompt, paste the
security certificate text.
Step 5 quit
Example:
hostname(ca-trustpoint)# quit
%Do you accept this certificate [yes/no]:
yes
Specifies the end of the security certificate text and
confirms acceptance of th entered security
certificate.
80-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
Subscribing to Alert Groups
An alert group is a predefined subset of the Smart Call Home alerts that are supported on the ASA.
Different types of Smart Call Home alerts are grouped into different alert groups depending upon their
type.
This section includes the following alert group topics:
Configuring Periodic Notification, page 80-9
Information about the Message Severity Threshold, page 80-9
Configuring Alert Group Subscription, page 80-10
Configuring Periodic Notification
When you subscribe a destination profile to either the Configuration or the Inventory alert group, you
can choose to receive the alert group messages asynchronously or periodically at a specified time. The
sending period can be one of the following:
DailySpecify the time of the day to send, using an hour:minute format hh:mm, with a 24-hour
clock (for example, 14:30).
WeeklySpecify the day of the week and time of day in the format day hh:mm, where the day of
the week is spelled out (for example, monday).
MonthlySpecify the numeric date, from 1 to 31, and the time of day, in the format date hh:mm.
Information about the Message Severity Threshold
When you subscribe a destination profile to certain alert groups, you can set a threshold for sending alert
group messages based upon the message level severity. (See Table 80-1). Any message with a value
lower than the destination profiles specified threshold is not sent to the destination.
Step 1 dns domain-lookup name
Example:
hostname(config)# dns domain-lookup corp
Enables DNS lookup on a specific interface.
Step 2 dns server-group group name
Example:
hostname(config)# DNS server-group DefaultDNS
Enters the server group submode to configure the
parameters for that server group.
We suggest that you use the default server group
name: DefaultDNS.
Step 3 name-server name
Example:
hostname(config-dns-server-group)# name-server
192.168.1.1
Specifies the IP address of the DNS server.
Step 4 (Optional)
domain-name name
Example:
hostname(config-dns-server-group)# domain name
domainexample
Specifies the domain name.
80-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
Configuring Alert Group Subscription
To subscribe a destination profile to an alert group, perform this task:
Detailed Steps
Table 80-1 Severity and Syslog Level Mapping
Level Keyword
Equivalent Syslog
Level Description
9 catastrophic N/A Network-wide catastrophic failure.
8 disaster N/A Significant network impact.
7 fatal Emergency (0) System is unusable.
6 critical Alert (1) Critical conditions, immediate attention needed.
5 major Critical (2) Major conditions.
4 minor Error (3) Minor conditions.
3 warning Warning (4) Warning conditions
2 notification Notice (5) Basic notification and informational messages.
Possibly independently insignificant.
1 normal Information (6) Normal event signifying return to normal state.
0 debugging Debug (7) Debugging messages (default setting).
Command Purpose
Step 1 call-home
Example:
hostname(config) # call-home
Enters call-home configuration mode.
Step 2 alert-group {all | configuration | diagnostic |
environment | inventory | syslog}
Example:
ciscoasa(cfg-call-home)# alert-group all
Enables the specified Smart Call Home group. Use
the keyword all to enable all alert groups. By
default, all alert groups are enabled.
Step 3 profile profile-name
Example:
hostname(cfg-call-home)# profile profile1
Enters the profile configuration submode for the
specified destination profile.
Step 4 subscribe-to-alert-group configuration [periodic
{daily hh:mm | monthly date hh:mm | weekly day
hh:mm}]
Example:
hostname(cfg-call-home-profile)#
subscribe-to-alert-group configuration periodic
weekly Wednesday 23:30
Subscribes this destination profile to the
configuration alert group. The configuration alert
group can be configured for periodic notification, as
described in the Subscribing to Alert Groups
section on page 80-9.
To subscribe to all available alert groups, use the
subscribe-to-alert-group all command.
80-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
Testing Call Home Communications
You can test Smart Call Home communications by sending messages manually using two command
types. To send a user-defined Smart Call Home test message, use the call-home test command. To send
a specific alert group message, use the call-home send command.
These sections describe Smart Call Home communication:
Sending a Smart Call Home Test Message Manually, page 80-12
Sending a Smart Call Home Alert Group Message Manually, page 80-12
Sending the Output of a Command, page 80-12
Step 5 subscribe-to-alert-group environment [severity
{catastrophic | disaster | emergencies | alert |
critical | errors | warnings | notifications |
informational | debugging}]
Example:
hostname(cfg-call-home-profile)#
subscribe-to-alert-group examplealertgroupname
severity critical
Subscribes to group events with the specified
severity level. The alert group can be configured to
filter messages based on severity, as described in
Table 80-1.
Step 6 subscribe-to-alert-group syslog [severity
{catastrophic | disaster | fatal | critical | major
| minor | warning | notification | normal |
debugging} [pattern string]]
Example:
hostname(cfg-call-home-profile)#
subscribe-to-alert-group syslog severity
notification pattern UPDOWN
Subscribes to syslog events with a severity level or
message ID. The syslog alert group can be
configured to filter messages based on severity, as
described in Table 80-1.
Step 7 subscribe-to-alert-group inventory [periodic {daily
hh:mm | monthly date hh:mm | weekly day hh:mm}]
Example:
hostname(cfg-call-home-profile)#
subscribe-to-alert-group inventory periodic daily
06:30
Subscribes to inventory events. The configuration
alert group can be configured for periodic
notification, as described in the Subscribing to
Alert Groups section on page 80-9.
Step 8 subscribe-to-alert-group telemetry periodic {hourly
| daily | monthly day | weekly day [hh:mm]}
Example:
hostname(cfg-call-home-profile)#
subscribe-to-alert-group monthly 15
Subscribes to telemetry periodic events. The
configuration alert group can be configured for
periodic notification, as described in the
Subscribing to Alert Groups section on page 80-9.
Step 9 subscribe-to-alert-group snapshot periodic {interval
minutes | hourly | daily | monthly day_of_month |
weekly day_of_week [hh:mm]}
Example:
hostname(cfg-call-home-profile)#
subscribe-to-alert-group snapshot periodic interval
weekly wendesday 23:15
Subscribes to snapshot periodic events. The
configuration alert group can be configured for
periodic notification, as described in the
Subscribing to Alert Groups section on page 80-9.
Command Purpose
80-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
Sending a Smart Call Home Test Message Manually
To manually send a Smart Call Home test message, perform this task:
Sending a Smart Call Home Alert Group Message Manually
To manually trigger a Call Home alert group message, perform this task:
Sending the Output of a Command
You can use the call-home send command to execute a CLI command and e-mail the command output
to Cisco or to an e-mail address that you specify.
When sending the output of a command, the following guidelines apply:
The specified CLI command can be any run command, including commands for all modules.
If you specify an e-mail address, the command output is sent to that address. If no e-mail address is
specified, the output is sent to Cisco TAC. The e-mail is sent in log text format with the service
number, if specified, in the subject line.
The service number is required only if no e-mail address is specified or if a Cisco TAC e-mail
address is specified.
To execute a CLI command and e-mail the command output, perform this task:
Command Purpose
call-home test [test-message] profile profile-name
Example:
hostname# call-home test [testing123] profile
profile1
Sends a test message using a profile configuration.
Step 1 call-home send alert-group {inventory |
configuration | snapshot | telemetry}
[profile profile-name]
Example:
hostname# call-home send alert-group
inventory
Sends an inventory alert group message to one destination profile,
if specified. If no profile is specified, sends messages to all
profiles that are subscribed to the inventory or configuration
group.
Command Purpose
call-home send cli command [email email]
Example:
hostname# call-home send cli command email
username@example.com
Sends command output to an e-mail address.
80-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
Optional Configuration Procedures
This section includes the following topics:
Configuring Smart Call Home Customer Contact Information, page 80-13
Configuring the Mail Server, page 80-15
Configuring Call Home Traffic Rate Limiting, page 80-15
Destination Profile Management, page 80-16
Configuring Smart Call Home Customer Contact Information
Obtain the following customer contact information to configure this task:
E-mail address (required)
Phone number (optional)
Street address (optional)
Contract ID (optional)
Customer name (optional)
Customer ID (optional)
Site ID (optional)
To configure customer contact information, perform this task:
Command Purpose
Step 1 call-home
Example:
hostname(config)# call-home
Enters call home configuration mode.
Step 2 contact-email-addr email-address
Example:
ciscoasa(cfg-call-home)# contact-email-addr
username@example.com
Configures the mandatory customer contact e-mail
address (if you have not already done so). The
email-address should be the Cisco.com ID account
that is associated with the device.
Step 3 (Optional)
phone-number phone-number-string
Example:
ciscoasa(cfg-call-home)# phone-number 8005551122
Specifies a customer phone number.
Step 4 (Optional)
street-address street-address
Example:
ciscoasa(cfg-call-home)# street-address 1234 Any
Street, Any city, Any state, 12345
Specifies the customer address, which is a
free-format string that can be up to 255 characters
long.
80-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
This example shows the configuration of contact information:
hostname# configure terminal
hostname(config)# call-home
ciscoasa(cfg-call-home)# contact-email-addr username@example.com
ciscoasa(cfg-call-home)# phone-number 8005551122
ciscoasa(cfg-call-home)# street-address 1234 Any Street, Any city, Any state, 12345
ciscoasa(cfg-call-home)# contact-name contactname1234
ciscoasa(cfg-call-home)# customer-id customer1234
ciscoasa(cfg-call-home)# site-id site1234
ciscoasa(cfg-call-home)# contract-id contract1234
Step 5 (Optional)
contact-name contact name
Example:
ciscoasa(cfg-call-home)# contact-name
contactname1234
Specifies the customer name, which can be up to 128
characters long.
Step 6 (Optional)
customer-id customer-id-string
Example:
ciscoasa(cfg-call-home)# customer-id customer1234
Specifies the customer ID, which can be up to 64
characters long.
Step 7 (Optional)
site-id site-id-string
Example:
ciscoasa(cfg-call-home)# site-id site1234
Specifies a customer site ID.
Step 8 (Optional)
contract-id contract-id-string
Example:
ciscoasa(cfg-call-home)# contract-id contract1234
Specifies the customer contract identification, which
can be up to 128 characters long.
Command Purpose
80-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
Configuring the Mail Server
We recommend that you use HTTPS for message transport, as it is the most secure. However, you can
configure an e-mail destination for Smart Call Home and then configure the mail server to use the e-mail
message transport.
To configure the mail server, perform this task:
This example shows the configuration of a primary mail server (namedsmtp.example.com) and a
secondary mail server at IP address 10.10.1.1:
hostname# configure terminal
hostname(config)# call-home
ciscoasa(cfg-call-home)# mail-server smtp.example.com priority 1
ciscoasa(cfg-call-home)# mail-server 10.10.1.1 priority 2
ciscoasa(cfg-call-home)# exit
hostname(config)#
Configuring Call Home Traffic Rate Limiting
You can configure this optional setting to specify the number of messages that Smart Call Home sends
per minute.
To configure Smart Call Home traffic rate limiting, perform this task:
Command Purpose
Step 1 call-home
Example:
hostname(config)# call-home
Enters call home configuration mode.
Step 2 mail-server ip-address | name priority 1-100 all
Example:
ciscoasa(cfg-call-home)# mail-server 10.10.1.1
smtp.example.com priority 1
Specifies the SMTP mail server. Customers can
specify up to five mail servers. At least one mail
server is required for using e-mail transport for
Smart Call Home messages.
The lower the number, the higher the priority of the
mail server.
The ip-address option can be an IPv4 or IPv6 mail
server address.
Command Purpose
Step 1 call-home
Example:
hostname(config)# call-home
Enters call home configuration mode.
Step 2 rate-limit msg-count
Example:
ciscoasa(cfg-call-home)# rate-limit 5
Specifies the number of messages that Smart Call
Home can send per minute. The default value is 10
messages per minute.
80-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
This example shows how to configure Smart Call Home traffic rate limiting:
hostname# configure terminal
hostname(config)# call-home
ciscoasa(cfg-call-home)# rate-limit 5
Destination Profile Management
These sections describe destination profile management:
Configuring a Destination Profile, page 80-16
Activating and Deactivating a Destination Profile, page 80-17
Copying a Destination Profile, page 80-18
Renaming a Destination Profile, page 80-18
Configuring a Destination Profile
To configure a destination profile for e-mail or for HTTP, perform this task:
Step 1 call-home
Example:
hostname(config)# call-home
Enters call home configuration mode.
Step 2 profile profile-name
Example:
hostname(cfg-call-home)# profile newprofile
Enters the profile configuration mode for the
specified destination profile. If the specified
destination profile does not exist, it is created.
Step 3 destination {email address | http url} |
message-size-limit size | preferred-msg-format
{long-text | short-text | xml} transport-method
{email | http}}
Example:
hostname(cfg-call-home-profile)# destination address
email username@example.com
hostname(cfg-call-home-profile)# destination
preferred-msg-format long-text
Configures the destination, message size, message
format, and transport method for the smart
call-home message receiver. The default message
format is XML, and the default enabled transport
method is e-mail. The e-mail-address is the e-mail
address of the smart call-home receiver, which can
be up to 100 characters long. By default, the
maximum URL size is 5 MB.
Use the short-text format to send and read a message
on a mobile device, and use the long text format to
send and read a message on a computer.
If the message receiver is the Smart Call Home
back-end server, ensure that the
preferred-msg-format is XML, as the back-end
server can accept messages in XML format only.
80-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
Activating and Deactivating a Destination Profile
Smart Call Home destination profiles are automatically activated when you create them. If you do not
want to use a profile right away, you can deactivate the profile.
To activate or deactivate a destination profile, perform this task:
This example shows how to activate a destination profile:
hostname# configure terminal
hostname(config)# call-home
ciscoasa(cfg-call-home)# profile newprofile
ciscoasa(cfg-call-home-profile)# active
ciscoasa(cfg-call-home)# end
This example shows how to deactivate a destination profile:
hostname# configure terminal
hostname(config)# call-home
ciscoasa(cfg-call-home)# profile newprofile
ciscoasa(cfg-call-home-profile)# no active
ciscoasa(cfg-call-home)# end
Command Purpose
Step 1 call-home
Example:
hostname(config)# call-home
Enters call home configuration mode.
Step 2 profile profile-name
Example:
hostname(cfg-call-home)# profile newprofile
Enters the profile configuration mode.
Creates, edits, or deletes a profile, which can be up
to 20 characters long.
Step 3 active
Example:
ciscoasa(cfg-call-home-profile)# active
Enables or disables a profile. By default, a new
profile is enabled when it is created.
Step 4 no active
Example:
ciscoasa(cfg-call-home-profile)# no active
Disables the destination profile.
80-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Configuring Anonymous Reporting and Smart Call Home
Copying a Destination Profile
To create a new destination profile by copying an existing profile, perform this task:
This example shows how to copy an existing profile:
hostname# configure terminal
hostname(config)# call-home
ciscoasa(cfg-call-home)# profile newprofile
ciscoasa(cfg-call-home-profile)# copy profile profile1 profile2
Renaming a Destination Profile
To change the name of an existing profile, perform this task:
This example shows how to rename an existing profile:
hostname# configure terminal
hostname(config)# call-home
ciscoasa(cfg-call-home)# profile newprofile
Command Purpose
Step 1 call-home
Example:
hostname(config)# call-home
Enters call home configuration mode.
Step 2 profile profilename
Example:
ciscoasa(cfg-call-home)# profile newprofile
Specifies the profile to copy.
Step 3 copy profile src-profile-name dest-profile-name
Example:
ciscoasa(cfg-call-home)# copy profile profile1
profile2
Copies the content of an existing profile
(src-profile-name, which can be up to 23 characters
long) to a new profile (dest-profile-name, which can
be up to 23 characters long).
Command Purpose
Step 1 call-home
Example:
hostname(config)# call-home
Enters call home configuration mode.
Step 2 profile profilename
Example:
ciscoasa(cfg-call-home)# profile newprofile
Specifies the profile to rename.
Step 3 rename profile src-profile-name dest-profile-name
Example:
ciscoasa(cfg-call-home)# rename profile profile1
profile2
Changes the name of an existing profile, the
src-profile-name (an existing profile name can be up
to 23 characters long), and the dest-profile-name (a
new profile name can be up to 23 characters long).
80-19
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Monitoring Smart Call Home
ciscoasa(cfg-call-home-profile)# rename profile profile1 profile2
Monitoring Smart Call Home
To monitor the Smart Call Home feature,enter one of the following commands:
Configuration Example for Smart Call Home
The following example shows how to configure the Smart Call Home feature:
hostname (config)# service call-home
hostname (config)# call-home
hostname (cfg-call-home)# contact-email-addr customer@mail.server
hostname (cfg-call-home)# profile CiscoTAC-1
hostname (cfg-call-home-profile)# destination address http
https://example.cisco.com/its/service/example/services/ExampleService
hostname (cfg-call-home-profile)# destination address email callhome@example.com
hostname (cfg-call-home-profile)# destination transport-method http
hostname (cfg-call-home-profile)# subscribe-to-alert-group inventory periodic monthly
hostname (cfg-call-home-profile)# subscribe-to-alert-group configuration periodic monthly
hostname (cfg-call-home-profile)# subscribe-to-alert-group environment
hostname (cfg-call-home-profile)# subscribe-to-alert-group diagnostic
hostname (cfg-call-home-profile)# subscribe-to-alert-group telemetry periodic daily
Command Purpose
show call-home detail Shows the current Smart Call Home detail configuration.
show call-home mail-server status Shows the current mail server status.
show call-home profile {profile name | all} Shows the configuration of Smart Call Home profiles.
show call-home registered-module status [all] Shows the registered module status.
show call-home statistics Shows call-home detail status.
show call-home Shows the current Smart Call Home configuration.
show running-config call-home Shows the current Smart Call Home running configuration.
show smart-call-home alert-group Shows the current status of Smart Call Home alert groups.
80-20
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 80 Configuring Anonymous Reporting and Smart Call Home
Feature History for Anonymous Reporting and Smart Call Home
Feature History for Anonymous Reporting and Smart Call Home
Table 80-2 lists each feature change and the platform release in which it was implemented. ASDM is
backwards-compatible with multiple platform releases, so the specific ASDM release in which support
was added is not listed.
Table 80-2 Feature History for Anonymous Reporting and Smart Call Home
Feature Name
Platform
Releases Feature Information
Smart Call Home 8.2(2) The Smart Call Home feature offers proactive diagnostics
and real-time alerts on the ASA, and provides higher
network availability and increased operational efficiency.
We introduced or modified the following commands:
active (call home), call-home, call-home send
alert-group, call-home test, contact-email-addr,
customer-id (call home), destination (call home), profile,
rename profile, service call-home, show call-home, show
call-home detail, show smart-call-home alert-group,
show call-home profile, show call-home statistics, show
call-home mail-server status, show running-config
call-home, show call-home registered-module status all,
site-id, street-address, subscribe-to-alert-group all,
subscribe-to-alert-group configuration,
subscribe-to-alert-group diagnostic,
subscribe-to-alert-group environment,
subscribe-to-alert-group inventory,
subscribe-to-alert-group syslog.
Anonymous Reporting 8.2(5)/8.4(2) Customers can help to improve the ASA platform by
enabling Anonymous Reporting, which allows Cisco to
securely receive minimal error and health information from
a device.
We introduced the following commands: call-home
reporting anonymous, call-home test reporting
anonymous.
P A R T 1 8
System Administration
C H A P T E R
81-1
Cisco ASA 5500 Series Configuration Guide using the CLI
81
Managing Software and Configurations
This chapter describes how to manage the ASA software and configurations and includes the following
sections:
Managing the Flash File System, page 81-1
Downloading Software or Configuration Files to Flash Memory, page 81-2
Configuring the Application Image and ASDM Image to Boot, page 81-4
Configuring the File to Boot as the Startup Configuration, page 81-5
Deleting Files from a USB Drive on the ASA 5500-X Series, page 81-5
Performing Zero Downtime Upgrades for Failover Pairs, page 81-6
Backing Up Configuration Files or Other Files, page 81-8
Configuring Auto Update Support, page 81-16
Downgrading Your Software, page 81-19
Managing the Flash File System
This section includes the following topics:
Viewing Files in Flash Memory, page 81-1
Deleting Files from Flash Memory, page 81-2
Viewing Files in Flash Memory
You can view files in flash memory and see information about files as follows:
To view files in flash memory, enter the following command:
hostname# dir [disk0: | disk1:]
Enter disk0: for the internal flash memory. The disk1: keyword represents the external flash
memory. The internal flash memory is the default.
For example:
hostname# dir
Directory of disk0:/
500 -rw- 4958208 22:56:20 Nov 29 2004 cdisk.bin
81-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Downloading Software or Configuration Files to Flash Memory
2513 -rw- 4634 19:32:48 Sep 17 2004 first-backup
2788 -rw- 21601 20:51:46 Nov 23 2004 backup.cfg
2927 -rw- 8670632 20:42:48 Dec 08 2004 asdmfile.bin
To view extended information about a specific file, enter the following command:
hostname# show file information [path:/]filename
The default path is the root directory of the internal flash memory (disk0:/).
For example:
hostname# show file information cdisk.bin
disk0:/cdisk.bin:
type is image (XXX) []
file size is 4976640 bytes version 7.0(1)
The file size listed is for example only.
Deleting Files from Flash Memory
You can remove files from flash memory that you no longer need. To delete a file from flash memory,
enter the following command:
hostname# delete disk0: filename
By default, the file is deleted from the current working directory if you do not specify a path. You may use
wildcards when deleting files. You are prompted with the filename to delete, and then you must confirm the
deletion.
Downloading Software or Configuration Files to Flash Memory
You can download application images, ASDM images, configuration files, and other files to the internal
flash memory or, for the ASA, to the external flash memory from a TFTP, FTP, SMB, HTTP, or HTTPS
server.
Note For the IPS SSP software module, before you download the IPS software to disk0, make sure at least
50% of the flash memory is free. When you install IPS, IPS reserves 50% of the internal flash memory
for its file system.
Note You cannot have two files with the same name but with different letter case in the same directory in flash
memory. For example, if you attempt to download the file, Config.cfg, to a location that contains the file,
config.cfg, you receive the following error message:
%Error opening disk0:/Config.cfg (File exists).
This section includes the following topics:
Downloading a File to a Specific Location, page 81-3
Downloading a File to the Startup or Running Configuration, page 81-3
81-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Downloading Software or Configuration Files to Flash Memory
Downloading a File to a Specific Location
This section describes how to download the application image, ASDM software, a configuration file, or
any other file that needs to be downloaded to flash memory. To download a file to the running or startup
configuration, see the Downloading a File to the Startup or Running Configuration section on
page 81-3.
For information about installing the Cisco SSL VPN client, see the Cisco AnyConnect VPN Client
Administrator Guide. For information about installing Cisco Secure Desktop on the ASA, see the Cisco
Secure Desktop Configuration Guide for Cisco ASA 5500 Series Administrators.
To configure the ASA to use a specific application image or ASDM image if you have more than one
installed, or have installed them in external flash memory, see the Configuring the Application Image
and ASDM Image to Boot section on page 81-4.
To configure the ASA to use a specific configuration as the startup configuration, see the Configuring
the File to Boot as the Startup Configuration section on page 81-5.
For multiple context mode, you must be in the system execution space.
To download a file to flash memory, see the following commands for each download server type:
To copy from a TFTP server, enter the following command:
hostname# copy tftp://server[/path]/filename {disk0:/ | disk1:/}[path/]filename
To copy from an FTP server, enter the following command:
hostname# copy ftp://[user[:password]@]server[/path]/filename {disk0:/ |
disk1:/}[path/]filename
To copy from an HTTP or HTTPS server, enter the following command:
hostname# copy http[s]://[user[:password]@]server[:port][/path]/filename {disk0:/ |
disk1:/}[path/]filename
To copy from an SMB server, enter the following command:
hostname# copy smb://[user[:password]@]server[/path]/filename {disk0:/ |
disk1:/}[path/]filename
To use secure copy, first enable secure shell (SSH), and then enter the following command:
hostname# ssh scopy enable
From a Linux client, enter the following command:
scp -v -pw password filename username@asa_address
The -v is for verbose, and if -pw is not specified, you will be prompted for a password.
Downloading a File to the Startup or Running Configuration
You can download a text file to the running or startup configuration from a TFTP, FTP, SMB, or HTTP(S)
server, or from the flash memory.
To copy a file to the startup configuration or running configuration, enter one of the following commands
for the appropriate download server:
81-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Configuring the Application Image and ASDM Image to Boot
Note When you copy a configuration to the running configuration, you merge the two configurations. A merge
adds any new commands from the new configuration to the running configuration. If the configurations
are the same, no changes occur. If commands conflict or if commands affect the running of the context,
then the effect of the merge depends on the command. You might get errors, or you might have
unexpected results.
To copy from a TFTP server, enter the following command:
hostname# copy tftp://server[/path]/filename {startup-config | running-config}
To copy from an FTP server, enter the following command:
hostname# copy ftp://[user[:password]@]server[/path]/filename {startup-config |
running-config}
To copy from an HTTP or HTTPS server, enter the following command:
hostname# copy http[s]://[user[:password]@]server[:port][/path]/filename
{startup-config | running-config}
To copy from an SMB server, enter the following command:
hostname# copy smb://[user[:password]@]server[/path]/filename {startup-config |
running-config}
To copy from flash memory, enter the following command:
hostname# copy {disk0:/ | disk1:/}[path/]filename {startup-config | running-config}
For example, to copy the configuration from a TFTP server, enter the following command:
hostname# copy tftp://209.165.200.226/configs/startup.cfg startup-config
To copy the configuration from an FTP server, enter the following command:
hostname# copy ftp://admin:letmein@209.165.200.227/configs/startup.cfg startup-config
To copy the configuration from an HTTP server, enter the following command:
hostname# copy http://209.165.200.228/configs/startup.cfg startup-config
Configuring the Application Image and ASDM Image to Boot
By default, the ASA boots the first application image that it finds in internal flash memory. It also boots
the first ASDM image it finds in internal flash memory, or if one does not exist in this location, then in
external flash memory. If you have more than one image, you should specify the image that you want to
boot. For the ASDM image, if you do not specify the image to boot, even if you have only one image
installed, then the ASA inserts the asdm image command into the running configuration. To avoid
problems with Auto Update (if configured), and to avoid the image search at each startup, you should
specify the ASDM image that you want to boot in the startup configuration.
To configure the application image to boot, enter the following command:
hostname(config)# boot system url
where url can be one of the following:
{disk0:/ | disk1:/}[path/]filename
81-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Configuring the File to Boot as the Startup Configuration
tftp://[user[:password]@]server[:port]/[path/]filename
Note The TFTP option is only supported for the ASA.
You can enter up to four boot system command entries to specify different images to boot from in order;
the ASA boots the first image it finds. Only one boot system tftp command can be configured, and it
must be the first one configured.
Note If the ASA is stuck in a cycle of constant booting, you can reboot the ASA into ROMMON mode.
For more information about the ROMMON mode, see the Using the ROM Monitor to Load a
Software Image section on page 82-11.
To configure the ASDM image to boot, enter the following command:
hostname(config)# asdm image {disk0:/ | disk1:/}[path/]filename
Configuring the File to Boot as the Startup Configuration
By default, the ASA boots from a startup configuration that is a hidden file. You can alternatively set any
configuration to be the startup configuration by entering the following command:
hostname(config)# boot config {disk0:/ | disk1:/}[path/]filename
Deleting Files from a USB Drive on the ASA 5500-X Series
When you delete a file from a USB drive (accessed as disk1:, for example), then the USB is moved to
the other slot (from bottom to top, or top to bottom), and the file reappears. With this type of online
insertion removal, to make sure that the file is actually deleted and no longer appears when you enter the
show disk1: command, enter the following command:
hostname# eject disk1:
81-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Performing Zero Downtime Upgrades for Failover Pairs
Performing Zero Downtime Upgrades for Failover Pairs
The two units in a failover configuration should have the same major (first number) and minor (second
number) software version. However, you do not need to maintain version parity on the units during the
upgrade process; you can have different versions on the software running on each unit and still maintain
failover support. To ensure long-term compatibility and stability, we recommend upgrading both units
to the same version as soon as possible.
Table 81-1 shows the supported scenarios for performing zero-downtime upgrades on a failover pair.
For more details about upgrading the software on a failover pair, see the following topics:
Upgrading an Active/Standby Failover Configuration, page 81-6
Upgrading an Active/Active Failover Configuration, page 81-7
Upgrading an Active/Standby Failover Configuration
To upgrade two units in an Active/Standby failover configuration, perform the following steps:
Step 1 Download the new software to both units, and specify the new image to load with the boot system
command (see the Configuring the Application Image and ASDM Image to Boot section on
page 81-4).
Step 2 Reload the standby unit to boot the new image by entering the following command on the active unit:
active# failover reload-standby
Step 3 When the standby unit has finished reloading, and is in the Standby Ready state, force the active unit to
fail over to the standby unit by entering the following command on the active unit.
Table 81-1 Zero-Downtime Upgrade Support
Type of Upgrade Support
Maintenance Release You can upgrade from any maintenance release to any other
maintenance release within a minor release.
For example, you can upgrade from 7.0(1) to 7.0(4) without first
installing the maintenance releases in between.
Minor Release You can upgrade from a minor release to the next minor release. You
cannot skip a minor release.
For example, you can upgrade from 7.0(1) to 7.1(1). Upgrading from
7.0(1) directly to 7.2(1) is not supported for zero-downtime upgrades;
you must first upgrade to 7.1(1).
Major Release You can upgrade from the last minor release of the previous version to
the next major release.
For example, you can upgrade from 7.2(1) to 8.0(1), assuming that
7.2(1) is the last minor version in the 7.x release series.
Note Zero downtime upgrades are possible, even when feature
configuration is migrated, for example, from 8.2.x to 8.3.x.
81-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Performing Zero Downtime Upgrades for Failover Pairs
Note Use the show failover command to verify that the standby unit is in the Standby Ready state.
active# no failover active
Step 4 Reload the former active unit (now the new standby unit) by entering the following command:
newstandby# reload
Step 5 When the new standby unit has finished reloading and is in the Standby Ready state, return the original
active unit to active status by entering the following command:
newstandby# failover active
Upgrading an Active/Active Failover Configuration
To upgrade two units in an Active/Active failover configuration, perform the following steps:
Step 1 Download the new software to both units, and specify the new image to load with the boot system
command (see the Configuring the Application Image and ASDM Image to Boot section on
page 81-4).
Step 2 Make both failover groups active on the primary unit by entering the following command in the system
execution space of the primary unit:
primary# failover active
Step 3 Reload the secondary unit to boot the new image by entering the following command in the system
execution space of the primary unit:
primary# failover reload-standby
Step 4 When the secondary unit has finished reloading, and both failover groups are in the Standby Ready state
on that unit, make both failover groups active on the secondary unit by using the following command in
the system execution space of the primary unit:
Note Use the show failover command to verify that both failover groups are in the Standby Ready
state on the secondary unit.
primary# no failover active
Step 5 Make sure that both failover groups are in the Standby Ready state on the primary unit, and then reload
the primary unit using the following command:
primary# reload
Step 6 If the failover groups are configured with the preempt command, they automatically become active on
their designated unit after the preempt delay has passed. If the failover groups are not configured with
the preempt command, you can return them to active status on their designated units using the failover
active group command.
81-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Backing Up Configuration Files or Other Files
Backing Up Configuration Files or Other Files
This section includes the following topics:
Backing up the Single Mode Configuration or Multiple Mode System Configuration, page 81-8
Backing Up a Context Configuration or Other File in Flash Memory, page 81-8
Backing Up a Context Configuration within a Context, page 81-9
Copying the Configuration from the Terminal Display, page 81-9
Backing Up Additional Files Using the Export and Import Commands, page 81-9
Using a Script to Back Up and Restore Files, page 81-10
Backing up the Single Mode Configuration or Multiple Mode System
Configuration
In single context mode or from the system configuration in multiple mode, you can copy the startup
configuration or running configuration to an external server or to the local flash memory as follows:
To copy to a TFTP server, enter the following command:
hostname# copy {startup-config | running-config} tftp://server[/path]/filename
To copy to a FTP server, enter the following command:
hostname# copy {startup-config | running-config}
ftp://[user[:password]@]server[/path]/filename
To copy to local flash memory, enter the following command:
hostname# copy {startup-config | running-config} {flash:/ | disk0:/ |
disk1:/}[path/]filename
Note Be sure that the destination directory exists. If it does not exist, first create the directory using
the mkdir command.
Backing Up a Context Configuration or Other File in Flash Memory
Copy context configurations or other files that are on the local flash memory by entering one of the
following commands in the system execution space:
To copy to a TFTP server, enter the following command:
hostname# copy disk{0 | 1}:/[path/]filename tftp://server[/path]/filename
To copy to a FTP server, enter the following command:
hostname# copy disk{0 | 1}:/[path/]filename
ftp://[user[:password]@]server[/path]/filename
To copy to an SMB file-system, enter the following command:
hostname# copy disk{0 | 1}:/[path/]filename
smb://[user[:password]@]server[/path]/filename
81-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Backing Up Configuration Files or Other Files
To copy from the ASA using HTTPS, enter the following URL in your browser:
https://ASA_IP/disk{0 | 1}/filename
To copy to local flash memory, enter the following command:
hostname# copy disk{0 | 1}:/[path/]filename disk{0 | 1}:/[path/]newfilename
Note Be sure that the destination directory exists. If it does not exist, first create the directory using
the mkdir command.
Backing Up a Context Configuration within a Context
In multiple context mode, from within a context, you can perform the following backups:
To copy the running configuration to the startup configuration server (connected to the
admin context), enter the following command:
hostname/contexta# copy running-config startup-config
To copy the running configuration to a TFTP server connected to the context network, enter the
following command:
hostname/contexta# copy running-config tftp:/server[/path]/filename
Copying the Configuration from the Terminal Display
To print the configuration to the terminal, enter the following command:
hostname# show running-config
Copy the output from this command, and then paste the configuration into a text file.
Backing Up Additional Files Using the Export and Import Commands
Additional files essential to your configuration might include the following:
Files that you import using the import webvpn command. Currently, these files include
customizations, URL lists, web content, plug-ins, and language translations.
DAP policies (dap.xml).
CSD configurations (data.xml).
Digital keys and certificates.
Local CA user database and certificate status files.
The CLI lets you back up and restore individual elements of your configuration using the export and
import commands.
To back up these files, for example, those files that you imported with the import webvpn command or
certificates, perform the following steps:
Step 1 Run the applicable show command(s) as follows:
81-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Backing Up Configuration Files or Other Files
hostname # show import webvpn plug-in
ica
rdp
ssh, telnet
vnc
Step 2 Run the export command for the file that you want to back up (in this example, the rdp file):
hostname # export webvpn plug-in protocol rdp tftp://tftpserver/backupfilename
Using a Script to Back Up and Restore Files
You can use a script to back up and restore the configuration files on your ASA, including all extensions
that you import via the import webvpn CLI, the CSD configuration XML files, and the DAP
configuration XML file. For security reasons, we do not recommend that you perform automated
backups of digital keys and certificates or the local CA key.
This section provides instructions for doing so and includes a sample script that you can use as is or
modify as your environment requires. The sample script is specific to a Linux system. To use it for a
Microsoft Windows system, you need to modify it using the logic of the sample.
Note The existing CLI lets you back up and restore individual files using the copy, export, and import
commands. It does not, however, have a facility that lets you back up all ASA configuration files in one
operation. Running the script facilitates the use of multiple CLIs.
This section includes the following topics:
Prerequisites, page 81-10
Running the Script, page 81-10
Sample Script, page 81-11
Prerequisites
To use a script to back up and restore an ASA configuration, first perform the following tasks:
Install Perl with an Expect module.
Install an SSH client that can reach the ASA.
Install a TFTP server to send files from the ASA to the backup site.
Another option is to use a commercially available tool. You can put the logic of this script into such a
tool.
Running the Script
To run a backup-and-restore script, perform the following steps:
Step 1 Download or cut-and-paste the script file to any location on your system.
Step 2 At the command line, enter Perl scriptname, where scriptname is the name of the script file.
Step 3 Press Enter.
81-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Backing Up Configuration Files or Other Files
Step 4 The system prompts you for values for each option. Alternatively, you can enter values for the options
when you enter the Perl scriptname command before you press Enter. Either way, the script requires
that you enter a value for each option.
Step 5 The script starts running, printing out the commands that it issues, which provides you with a record of
the CLIs. You can use these CLIs for a later restore, which is particularly useful if you want to restore
only one or two files.
Sample Script
#!/usr/bin/perl
#Function: Backup/restore configuration/extensions to/from a TFTP server.
#Description: The objective of this script is to show how to back up
configurations/extensions before the backup/restore command is developed.
# It currently backs up the running configuration, all extensions imported via import
webvpn command, the CSD configuration XML file, and the DAP configuration XML file.
#Requirements: Perl with Expect, SSH to the ASA, and a TFTP server.
#Usage: backupasa -option option_value
# -h: ASA hostname or IP address
# -u: User name to log in via SSH
# -w: Password to log in via SSH
# -e: The Enable password on the security appliance
# -p: Global configuration mode prompt
# -s: Host name or IP address of the TFTP server to store the configurations
# -r: Restore with an argument that specifies the file name. This file is produced
during backup.
#If you don't enter an option, the script will prompt for it prior to backup.
#
#Make sure that you can SSH to the ASA.
use Expect;
use Getopt::Std;
#global variables
%options=();
$restore = 0; #does backup by default
$restore_file = ;
$asa = ;
$storage = ;
$user = ;
$password = ;
$enable = ;
$prompt = ;
$date = `date +%F;
chop($date);
my $exp = new Expect();
getopts(h:u:p:w:e:s:r:,\%options);
do process_options();
do login($exp);
do enable($exp);
if ($restore) {
do restore($exp,$restore_file);
}
else {
$restore_file = $prompt-restore-$date.cli;
open(OUT,>$restore_file) or die Can't open $restore_file\n;
do running_config($exp);
do lang_trans($exp);
81-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Backing Up Configuration Files or Other Files
do customization($exp);
do plugin($exp);
do url_list($exp);
do webcontent($exp);
do dap($exp);
do csd($exp);
close(OUT);
}
do finish($exp);
sub enable {
$obj = shift;
$obj->send(enable\n);
unless ($obj->expect(15, Password:)) {
print timed out waiting for Password:\n;
}
$obj->send($enable\n);
unless ($obj->expect(15, $prompt#)) {
print timed out waiting for $prompt#\n;
}
}
sub lang_trans {
$obj = shift;
$obj->clear_accum();
$obj->send(show import webvpn translation-table\n);
$obj->expect(15, $prompt# );
$output = $obj->before();
@items = split(/\n+/, $output);
for (@items) {
s/^\s+//;
s/\s+$//;
next if /show import/ or /Translation Tables/;
next unless (/^.+\s+.+$/);
($lang, $transtable) = split(/\s+/,$_);
$cli = export webvpn translation-table $transtable language $lang
$storage/$prompt-$date-$transtable-$lang.po;
$ocli = $cli;
$ocli =~ s/^export/import/;
print $cli\n;
print OUT $ocli\n;
$obj->send($cli\n);
$obj->expect(15, $prompt# );
}
}
sub running_config {
$obj = shift;
$obj->clear_accum();
$cli =copy /noconfirm running-config $storage/$prompt-$date.cfg;
print $cli\n;
$obj->send($cli\n);
$obj->expect(15, $prompt# );
}
sub customization {
$obj = shift;
$obj->clear_accum();
$obj->send(show import webvpn customization\n);
$obj->expect(15, $prompt# );
$output = $obj->before();
@items = split(/\n+/, $output);
81-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Backing Up Configuration Files or Other Files
for (@items) {
chop;
next if /^Template/ or /show import/ or /^\s*$/;
$cli = export webvpn customization $_ $storage/$prompt-$date-cust-$_.xml;
$ocli = $cli;
$ocli =~ s/^export/import/;
print $cli\n;
print OUT $ocli\n;
$obj->send($cli\n");
$obj->expect(15, $prompt# );
}
}
sub plugin {
$obj = shift;
$obj->clear_accum();
$obj->send(show import webvpn plug-in\n);
$obj->expect(15, $prompt# );
$output = $obj->before();
@items = split(/\n+/, $output);
for (@items) {
chop;
next if /^Template/ or /show import/ or /^\s*$/;
$cli = export webvpn plug-in protocol $_ $storage/$prompt-$date-plugin-$_.jar;
$ocli = $cli;
$ocli =~ s/^export/import/;
print $cli\n;
print OUT $ocli\n;
$obj->send($cli\n);
$obj->expect(15, $prompt# );
}
}
sub url_list {
$obj = shift;
$obj->clear_accum();
$obj->send(show import webvpn url-list\n);
$obj->expect(15, $prompt# );
$output = $obj->before();
@items = split(/\n+/, $output);
for (@items) {
chop;
next if /^Template/ or /show import/ or /^\s*$/ or /No bookmarks/;
$cli=export webvpn url-list $_ $storage/$prompt-$date-urllist-$_.xml;
$ocli = $cli;
$ocli =~ s/^export/import/;
print $cli\n;
print OUT $ocli\n;
$obj->send($cli\n);
$obj->expect(15, $prompt# );
}
}
sub dap {
$obj = shift;
$obj->clear_accum();
$obj->send(dir dap.xml\n);
$obj->expect(15, $prompt# );
$output = $obj->before();
return 0 if($output =~ /Error/);
81-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Backing Up Configuration Files or Other Files
$cli=copy /noconfirm dap.xml $storage/$prompt-$date-dap.xml;
$ocli=copy /noconfirm $storage/$prompt-$date-dap.xml disk0:/dap.xml;
print $cli\n;
print OUT $ocli\n;
$obj->send($cli\n);
$obj->expect(15, $prompt# );
}
sub csd {
$obj = shift;
$obj->clear_accum();
$obj->send(dir sdesktop\n);
$obj->expect(15, $prompt# );
$output = $obj->before();
return 0 if($output =~ /Error/);
$cli=copy /noconfirm sdesktop/data.xml $storage/$prompt-$date-data.xml;
$ocli=copy /noconfirm $storage/$prompt-$date-data.xml disk0:/sdesktop/data.xml;
print $cli\n;
print OUT $ocli\n;
$obj->send($cli\n);
$obj->expect(15, $prompt# );
}
sub webcontent {
$obj = shift;
$obj->clear_accum();
$obj->send(show import webvpn webcontent\n);
$obj->expect(15, $prompt# );
$output = $obj->before();
@items = split(/\n+/, $output);
for (@items) {
s/^\s+//;
s/\s+$//;
next if /show import/ or /No custom/;
next unless (/^.+\s+.+$/);
($url, $type) = split(/\s+/,$_);
$turl = $url;
$turl =~ s/\/\+//;
$turl =~ s/\+\//-/;
$cli = export webvpn webcontent $url $storage/$prompt-$date-$turl;
$ocli = $cli;
$ocli =~ s/^export/import/;
print $cli\n;
print OUT $ocli\n;
$obj->send($cli\n);
$obj->expect(15, $prompt# );
}
}
sub login {
$obj = shift;
$obj->raw_pty(1);
$obj->log_stdout(0); #turn off console logging.
$obj->spawn(/usr/bin/ssh $user\@$asa) or die can't spawn ssh\n;
unless ($obj->expect(15, password: )) {
die timeout waiting for password:\n;
}
$obj->send($password\n);
81-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Backing Up Configuration Files or Other Files
unless ($obj->expect(15, $prompt> )) {
die timeout waiting for $prompt>\n;
}
}
sub finish {
$obj = shift;
$obj->hard_close();
print \n\n;
}
sub restore {
$obj = shift;
my $file = shift;
my $output;
open(IN,$file) or die can't open $file\n;
while (<IN>) {
$obj->send($_);
$obj->expect(15, $prompt# );
$output = $obj->before();
print $output\n;
}
close(IN);
}
sub process_options {
if (defined($options{s})) {
$tstr= $options{s};
$storage = tftp://$tstr;
}
else {
print Enter TFTP host name or IP address:;
chop($tstr=<>);
$storage = tftp://$tstr;
}
if (defined($options{h})) {
$asa = $options{h};
}
else {
print Enter ASA host name or IP address:;
chop($asa=<>);
}
if (defined ($options{u})) {
$user= $options{u};
}
else {
print Enter user name:;
chop($user=<>);
}
if (defined ($options{w})) {
$password= $options{w};
}
else {
print Enter password:;
chop($password=<>);
}
if (defined ($options{p})) {
$prompt= $options{p};
}
else {
print Enter ASA prompt:;
81-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Configuring Auto Update Support
chop($prompt=<>);
}
if (defined ($options{e})) {
$enable = $options{e};
}
else {
print Enter enable password:;
chop($enable=<>);
}
if (defined ($options{r})) {
$restore = 1;
$restore_file = $options{r};
}
}
Configuring Auto Update Support
Auto Update is a protocol specification that allows an Auto Update Server to download configurations
and software images to many ASAs and can provide basic monitoring of the ASAs from a central
location.
The ASA can be configured as either a client or a server. As an Auto Update client, it periodically polls
the Auto Update Server for updates to software images and configuration files. As an Auto Update
Server, it issues updates for ASAs configured as Auto Update clients.
Note Auto Update is supported in single context mode only.
This section includes the following topics:
Configuring Communication with an Auto Update Server, page 81-16
Configuring Client Updates as an Auto Update Server, page 81-18
Viewing Auto Update Status, page 81-19
Configuring Communication with an Auto Update Server
To configure the ASA as an Auto Update client, perform the following steps:
Step 1 To specify the URL of the Auto Update Server, enter the following command:
hostname(config)# auto-update server url [source interface] [verify-certificate]
where url has the following syntax:
http[s]://[user:password@]server_ip[:port]/pathname
SSL is used when https is specified. The user and password arguments of the URL are used for basic
authentication when logging in to the server. If you use the write terminal, show configuration or show
tech-support commands to view the configuration, the user and password are replaced with ********.
The default port is 80 for HTTP and 443 for HTTPS.
81-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Configuring Auto Update Support
The source interface keyword and argument specify which interface to use when sending requests to the
Auto Update Server. If you specify the same interface specified by the management-access command,
the Auto Update requests travel over the same IPsec VPN tunnel used for management access.
The verify-certificate keyword verifies the certificate returned by the Auto Update Server.
Step 2 (Optional) To identify the device ID to send when communicating with the Auto Update Server, enter
the following command:
hostname(config)# auto-update device-id {hardware-serial | hostname | ipaddress [if-name]
| mac-address [if-name] | string text}
The identifier used is determined by specifying one of the following parameters:
The hardware-serial argument specifies the ASA serial number.
The hostname argument specifies the ASA hostname.
The ipaddress keyword specifies the IP address of the specified interface. If the interface name is
not specified, it uses the IP address of the interface used to communicate with the Auto Update
Server.
The mac-address keyword specifies the MAC address of the specified interface. If the interface
name is not specified, it uses the MAC address of the interface used to communicate with the Auto
Update Server.
The string keyword specifies the specified text identifier, which cannot include white space or the
characters , , , >, & and ?.
Step 3 (Optional) To specify how often to poll the Auto Update Server for configuration or image updates, enter
the following command:
hostname(config)# auto-update poll-period poll-period [retry-count [retry-period]]
The poll-period argument specifies how often (in minutes) to check for an update. The default is 720
minutes (12 hours).
The retry-count argument specifies how many times to try reconnecting to the server if the first attempt
fails. The default is zero.
The retry-period argument specifies how long to wait (in minutes) between retries. The default is five
minutes.
Step 4 (Optional) To schedule a specific time for the ASA to poll the Auto Update Server, enter the following
command:
hostname(config)# auto-update poll-at days-of-the-week time [randomize minutes]
[retry_count [retry_period]]
The days-of-the-week argument is any single day or combination of days: Monday, Tuesday, Wednesday,
Thursday, Friday, Saturday, and Sunday. Other possible values are daily (Monday through Sunday),
weekdays (Monday through Friday), and weekends (Saturday and Sunday).
The time argument specifies the time in the format HH:MM at which to start the poll. For example, 8:00
is 8:00 a.m. and 20:00 is 8:00 p.m.
The randomize minutes keyword and argument specify the period to randomize the poll time following
the specified start time. The range is from 1 to 1439 minutes.
The retry_count argument specifies how many times to try reconnecting to the Auto Update Server if the
first attempt fails. The default is zero.
The retry_period argument specifies how long to wait between connection attempts. The default is five
minutes. The range is from 1 to 35791 minutes.
81-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Configuring Auto Update Support
Step 5 (Optional) If the Auto Update Server has not been contacted for a certain period of time, entering the
following command causes it to stop passing traffic:
hostname(config)# auto-update timeout period
The period argument specifies the timeout period in minutes between 1 and 35791. The default is to
never time out (zero minutes). To restore the default, enter the no form of this command.
Use the auto-update timeout command to be sure that the ASA has the most recent image and
configuration. This condition is reported with system log message 201008.
In the following example, an ASA is configured to poll an Auto Update Server with the IP address
209.165.200.224, at port number 1742, from the outside interface, with certificate verification.
The ASA is also configured to use the hostname as the device ID and to poll an Auto Update Server every
Friday and Saturday night at a random time between 10:00 p.m. and 11:00 p.m. On a failed polling
attempt, the ASA will try to reconnect to the Auto Update Server ten times, and will wait three minutes
between attempts at reconnecting, as shown in the following example:
hostname(config)# auto-update server
https://jcrichton:farscape@209.165.200.224:1742/management source outside
verify-certificate
hostname (config)# auto-update device-id hostname
hostname (config)# auto-update poll-at Friday Saturday 22:00 randomize 60 2 10
Configuring Client Updates as an Auto Update Server
Entering the client-update command enables updates for ASAs configured as Auto Update clients and
lets you specify the type of software component (ASDM or boot image), the type or family of ASA,
revision numbers to which the update applies, and a URL or IP address from which to obtain the update.
To configure the ASA as an Auto Update Server, perform the following steps:
Step 1 To enable client update, enter the following command:
hostname(config)# client-update enable
Step 2 Configure the following parameters for the client-update command that you want to apply to the ASAs:
client-update {component {asdm | image} | device-id dev_string |
family family_name | type type} url url-string rev-nums rev-nums}
The component {asdm | image} parameter specifies the software component, either ASDM or the boot
image of the ASA.
The device-id dev_string parameter specifies a unique string that the Auto Update client uses to identify
itself. The maximum length is 63 characters.
The family family_name parameter specifies the family name that the Auto Update client uses to identify
itself. It can be asa, pix, or a text string with a maximum length of seven characters.
The rev-nums rev-nums parameter specifies the software or firmware images for this client. Enter up to
four, in any order, separated by commas.
The type type parameter specifies the type of clients to notify of a client update. Because this command
is also used to update Windows clients, the list of clients includes several Windows operating systems.
The ASAs in the list may include the following:
asa5505: Cisco 5505 ASA
81-19
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Downgrading Your Software
asa5510: Cisco 5510 ASA
asa5520: Cisco 5520 ASA
asa5540: Cisco 5540 ASA
The url url-string parameter specifies the URL for the software/firmware image. This URL must point
to a file appropriate for this client. For all Auto Update clients, you must use the protocol http:// or
https:// as the prefix for the URL.
Configure the parameters for the client update that you want to apply to all ASAs of a particular type.
That is, specify the type of ASA and the URL or IP address from which to get the updated image. In
addition, you must specify a revision number. If the revision number of the remote ASA matches one of
the specified revision numbers, there is no need to update the client, and the update is ignored.
To configure a client update for Cisco 5520 ASAs, enter the following command:
hostname(config)# client-update type asa5520 component asdm url
http://192.168.1.114/aus/asdm601.bin rev-nums 8.0(1)
Viewing Auto Update Status
To view the Auto Update status, enter the following command:
hostname(config)# show auto-update
The following is sample output from the show auto-update command:
hostname(config)# show auto-update
Server: https://********@209.165.200.224:1742/management.cgi?1276
Certificate will be verified
Poll period: 720 minutes, retry count: 2, retry period: 5 minutes
Timeout: none
Device ID: host name [corporate]
Next poll in 4.93 minutes
Last poll: 11:36:46 PST Tue Nov 13 2004
Last PDM update: 23:36:46 PST Tue Nov 12 2004
Downgrading Your Software
When you upgrade to Version 8.3, your configuration is migrated. The old configuration is automatically
stored in flash memory. For example, when you upgrade from Version 8.2(1) to 8.3(1), the old 8.2(1)
configuration is stored in flash memory in a file called 8_2_1_0_startup_cfg.sav.
Note You must manually restore the old configuration before downgrading.
This section describes how to downgrade and includes the following topics:
Information About Activation Key Compatibility, page 81-20
Performing the Downgrade, page 81-20
81-20
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Downgrading Your Software
Information About Activation Key Compatibility
Your activation key remains compatible if you upgrade to the latest version from any previous version.
However, you might have issues if you want to maintain downgrade capability:
Downgrading to Version 8.1 or earlier versionsAfter you upgrade, if you activate additional
feature licenses that were introduced before 8.2, the activation key continues to be compatible with
earlier versions if you downgrade. However if you activate feature licenses that were introduced in
Version 8.2 or later versions, the activation key is not backward compatible. If you have an
incompatible license key, see the following guidelines:
If you previously entered an activation key in an earlier version, the ASA uses that key (without
any of the new licenses you activated in Version 8.2 or later versions).
If you have a new system and do not have an earlier activation key, you need to request a new
activation key compatible with the earlier version.
Downgrading to Version 8.2 or earlier versionsVersion 8.3 introduced more robust time-based key
usage as well as failover license changes:
If you have more than one time-based activation key active, when you downgrade, only the most
recently activated time-based key can be active. Any other keys are made inactive.
If you have mismatched licenses on a failover pair, downgrading will disable failover. Even if
the keys are matching, the license used will no longer be a combined license.
Performing the Downgrade
To downgrade from Version 8.3, perform the following steps:
Detailed Steps
Step 1 Enter the following command:
hostname(config)# downgrade [/noconfirm] old_image_url old_config_url [activation-key
old_key]
Where the /noconfirm option downgrades without prompting. The image_url is the path to the old image
on disk0, disk1, tftp, ftp, or smb. The old_config_url is the path to the saved, premigration configuration
(by default, t;his configuration was saved on disk0). If you need to revert to a pre-8.3 activation key, you
can enter the old activation key.
This command is a shortcut for completing the following functions:
1. Clearing the boot image configuration (clear configure boot).
2. Setting the boot image to be the old image (boot system).
3. (Optional) Entering a new activation key (activation-key).
4. Saving the running configuration to startup (write memory). This action sets the BOOT
environment variable to the old image, so when you reload, the old image is loaded.
5. Copying the old configuration to the startup configuration (copy old_config_url startup-config).
6. Reloading (reload).
For example:
hostname(config)# downgrade /noconfirm disk0:/asa821-k8.bin disk0:/8_2_1_0_startup_cfg.sav
81-21
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Downgrading Your Software
81-22
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 81 Managing Software and Configurations
Downgrading Your Software
C H A P T E R
82-1
Cisco ASA 5500 Series Configuration Guide using the CLI
82
Troubleshooting
This chapter describes how to troubleshoot the ASA and includes the following sections:
Testing Your Configuration, page 82-1
Reloading the ASA, page 82-8
Performing Password Recovery, page 82-8
Using the ROM Monitor to Load a Software Image, page 82-11
Erasing the Flash File System, page 82-12
Other Troubleshooting Tools, page 82-13
Common Problems, page 82-14
Testing Your Configuration
This section describes how to test connectivity for the single mode ASA or for each security context,
how to ping the ASA interfaces, and how to allow hosts on one interface to ping through to hosts on
another interface.
We recommend that you only enable pinging and debugging messages during troubleshooting. When
you are done testing the ASA, follow the steps in the Disabling the Test Configuration section on
page 82-7.
This section includes the following topics:
Enabling ICMP Debugging Messages and Syslog Messages, page 82-2
Pinging ASA Interfaces, page 82-3
Passing Traffic Through the ASA, page 82-5
Disabling the Test Configuration, page 82-7
Determining Packet Routing with Traceroute, page 82-7
Tracing Packets with Packet Tracer, page 82-7
Handling TCP Packet Loss, page 82-8
82-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Testing Your Configuration
Enabling ICMP Debugging Messages and Syslog Messages
Debugging messages and syslog messages can help you troubleshoot why your pings are not successful.
The ASA only shows ICMP debugging messages for pings to the ASA interfaces, and not for pings
through the ASA to other hosts. To enable debugging and syslog messages, perform the following steps:
To enable ICMP inspection to the default global policy, perform the following steps:
Command Purpose
Step 1 debug icmp trace
Example:
hostname(config)# debug icmp trace
Shows ICMP packet information for pings to the ASA interfaces.
Step 2 logging monitor debug
Example:
hostname(config)# logging monitor debug
Sets syslog messages to be sent to Telnet or SSH sessions.
Note You can alternately use the logging buffer debug
command to send log messages to a buffer, and then view
them later using the show logging command.
Step 3 terminal monitor
Example:
hostname(config)# terminal monitor
Sends the syslog messages to a Telnet or SSH session.
Step 4 logging on
Example:
hostname(config)# logging on
Enables syslog message generation.
Command Purpose
Step 1 policy-map name
Example:
hostname(config)# policy-map global_policy
Configures the policy map and attach the action to the class of
traffic.
Step 2 class classmap_name
Example:
hostname(config-pmap)# class
inspection_default
Assigns a class map to the policy map so that you can assign
actions to the class map traffic.
Step 3 inspect icmp
Example:
hostname(config)# inspect icmp
Enables ICMP inspection.
82-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Testing Your Configuration
Examples
The following example shows a successful ping from an external host (209.165.201.2) to the ASA
outside interface (209.165.201.1):
hostname(config)# debug icmp trace
Inbound ICMP echo reply (len 32 id 1 seq 256) 209.165.201.1 > 209.165.201.2
Outbound ICMP echo request (len 32 id 1 seq 512) 209.165.201.2 > 209.165.201.1
Inbound ICMP echo reply (len 32 id 1 seq 512) 209.165.201.1 > 209.165.201.2
Outbound ICMP echo request (len 32 id 1 seq 768) 209.165.201.2 > 209.165.201.1
Inbound ICMP echo reply (len 32 id 1 seq 768) 209.165.201.1 > 209.165.201.2
Outbound ICMP echo request (len 32 id 1 seq 1024) 209.165.201.2 > 209.165.201.1
Inbound ICMP echo reply (len 32 id 1 seq 1024) 209.165.201.1 > 209.165.201.2
The output shows the ICMP packet length (32 bytes), the ICMP packet identifier (1), and the ICMP
sequence number (the ICMP sequence number starts at 0, and is incremented each time that a request is
sent).
Pinging ASA Interfaces
To test whether the ASA interfaces are up and running and that the ASA and connected routers are
operating correctly, you can ping the ASA interfaces. To ping the ASA interfaces, perform the following
steps:
Step 1 Draw a diagram of your single-mode ASA or security context that shows the interface names, security
levels, and IP addresses.
Note Although this procedure uses IP addresses, the ping command also supports DNS names and
names that are assigned to a local IP address with the name command.
The diagram should also include any directly connected routers and a host on the other side of the router
from which you will ping the ASA. You will use this information in this procedure and in the procedure
in the Passing Traffic Through the ASA section on page 82-5. (See Figure 82-1.)
82-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Testing Your Configuration
Figure 82-1 Network Diagram with Interfaces, Routers, and Hosts
Step 2 Ping each ASA interface from the directly connected routers. For transparent mode, ping the
management IP address. This test ensures that the ASA interfaces are active and that the interface
configuration is correct.
A ping might fail if the ASA interface is not active, the interface configuration is incorrect, or if a switch
between the ASA and a router is down (see Figure 82-2). In this case, no debug messages or syslog
messages appear, because the packet never reaches the ASA.
Figure 82-2 Ping Failure at the ASA Interface
If the ping reaches the ASA, and it responds, debugging messages similar to the following appear:
ICMP echo reply (len 32 id 1 seq 256) 209.165.201.1 > 209.165.201.2
ICMP echo request (len 32 id 1 seq 512) 209.165.201.2 > 209.165.201.1
If the ping reply does not return to the router, then a switch loop or redundant IP addresses may exist
(see Figure 82-3).
Routed Security
Appliance
10.1.1.56 10.1.3.6 209.265.200.230
10.1.2.90 10.1.4.67 10.1.0.34
209.165.201.24
10.1.1.5
Transp. Security
Appliance 10.1.0.3
Host
Host
10.1.1.2
192.168.1.2
209.265.200.226
209.165.201.2
10.1.3.2
192.168.3.2
192.168.2.2
10.1.2.2
192.168.0.2
10.1.0.2
192.168.4.2
10.1.4.2
dmz1
192.1
68.1.
outside
209.165.201.1
security0
inside
192.168.0.1
security100
209.165.201.1
10.1.0.1
10.1.0.2
10.1.1.1
outside
security0
inside
security100
dmz2
192.168.2.1
security40
dmz3
192.1
68.3.
dmz4
192.168.4.1
security80
1
2
6
6
9
2
Host Host
Host
Host
Host
Host
Router Router Router
Router Router Router
Router
Router
Ping
Security
Appliance
Router
1
2
6
6
9
5
82-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Testing Your Configuration
Figure 82-3 Ping Failure Because of IP Addressing Problems
Step 3 Ping each ASA interface from a remote host. For transparent mode, ping the management IP address.
This test checks whether the directly connected router can route the packet between the host and the
ASA, and whether the ASA can correctly route the packet back to the host.
A ping might fail if the ASA does not have a return route to the host through the intermediate router (see
Figure 82-4). In this case, the debugging messages show that the ping was successful, but syslog
message 110001 appears, indicating a routing failure.
Figure 82-4 Ping Failure Because the Security Appliance has No Return Route
Passing Traffic Through the ASA
After you successfully ping the ASA interfaces, make sure that traffic can pass successfully through the
ASA. For routed mode, this test shows that NAT is operating correctly, if configured. For transparent
mode, which does not use NAT, this test confirms that the ASA is operating correctly. If the ping fails in
transparent mode, contact the Cisco TAC.
To ping between hosts on different interfaces, perform the following steps:
192.168.1.1 192.168.1.2
192.168.1.2
Ping
Router
Security
Appliance
Host
1
2
6
6
9
6
Ping
Router
Host
?
Security
Appliance 1
2
6
6
9
3
Command Purpose
Step 1 access-list ICMPACL extended permit icmp
any any
Example:
hostname(config)# access-list ICMPACL
extended permit icmp any any
Adds an access list to allow ICMP traffic from any source host.
Note By default, when hosts access a lower security interface,
all traffic is allowed through. However, to access a higher
security interface, you need the preceding access list.
Step 2 access-group ICMPACL in interface
interface_name
Example:
hostname(config)# access-group ICMPACL in
interface inside
Assigns the access list to each source interface. Repeat this
command for each source interface.
82-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Testing Your Configuration
Figure 82-5 Ping Failure Because the ASA is Not Translating Addresses
Step 3 class-map ICMP-CLASS
match access-list ICMPACL
policy-map ICMP-POLICY
class ICMP-CLASS
inspect icmp
service-policy ICMP-POLICY global
Example:
hostname(config)# class-map ICMP-CLASS
hostname(config-cmap)# match access-list
ICMPACL
hostname(config)# policy-map ICMP-POLICY
hostname(config-pmap)# class ICMP-CLASS
hostname(config-pmap)# inspect icmp
hostname(config)# service-policy
ICMP-POLICY global
Enables the ICMP inspection engine and ensures that ICMP
responses may return to the source host.
For a host to access a lower security interface, you must enable
ICMP inspection. However, to access a higher security interface,
you must enable ICMP inspection and the preceding access list.
Note Alternatively, you can also apply the ICMP access list to
the destination interface to allow ICMP traffic back
through the ASA.
Step 4 logging on
Example:
hostname(config)# logging on
Enables syslog message generation.
If the ping succeeds, a syslog message appears to confirm the
address translation for routed mode (305009 or 305011) and that
an ICMP connection was established (302020). You can also enter
either the show xlate or show conns command to view this
information.
If the ping fails for transparent mode, contact Cisco TAC.
For routed mode, the ping might fail because NAT is not
configured correctly (see Figure 82-5). In this case, a syslog
message appears, showing that the NAT failed (305005 or
305006). If the ping is from an outside host to an inside host, and
you do not have a static translation, the following syslog message
appears:
%ASA-3-106010: deny inbound icmp.
Note The ASA only shows ICMP debugging messages for
pings to the ASA interfaces, and not for pings through the
ASA to other hosts.
Ping
Router
Router Host Host
Security
Appliance
1
2
6
6
9
4
82-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Testing Your Configuration
Disabling the Test Configuration
After you complete your testing, disable the test configuration that allows ICMP to and through the ASA
and that prints debugging messages. If you leave this configuration in place, it can pose a serious security
risk. Debugging messages also slow the ASA performance.
To disable the test configuration, perform the following steps:
Determining Packet Routing with Traceroute
You can trace the route of a packet using the traceroute feature, which is accessed with the traceroute
command. A traceroute works by sending UDP packets to a destination on an invalid port. Because the
port is not valid, the routers along the way to the destination respond with an ICMP Time Exceeded
Message, and report that error to the ASA.
Tracing Packets with Packet Tracer
The packet tracer tool provides packet tracing for packet sniffing and network fault isolation, as well as
detailed information about the packets and how they are processed by the ASA. If a configuration
command did not cause the packet to drop, the packet tracer tool provides information about the cause
in an easily readable manner.
In addition, you can trace the lifespan of a packet through the ASA to see whether the packet is operating
correctly with the packet tracer tool. This tool enables you to do the following:
Command Purpose
Step 1 no debug icmp trace
Example:
hostname (config)# no debug
icmp trace
Disables ICMP debugging messages.
Step 2 no logging on
Example:
hostname (config)# no
logging on
Disables logging.
Step 3 no access-list ICMPACL
Example:
hostname (config)# no
access-list ICMPACL
Removes the ICMPACL access list, and deletes the related access-group
commands.
Step 4 no service-policy
ICMP-POLICY
Example:
hostname (config)# no
service-policy ICMP-POLICY
(Optional) Disables the ICMP inspection engine.
82-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Reloading the ASA
Debug all packet drops in a production network.
Verify the configuration is working as intended.
Show all rules applicable to a packet, along with the CLI commands that caused the rule addition.
Show a time line of packet changes in a data path.
Inject tracer packets into the data path.
Search for an IPv4 or IPv6 address based on the user identity and the FQDN.
To trace packets, enter the following command:
Handling TCP Packet Loss
To troubleshoot TCP packet loss, see the Customizing the TCP Normalizer with a TCP Map section
on page 53-6 for more information.
Reloading the ASA
To reload the ASA, enter the following command:
Performing Password Recovery
This section describes how to recover passwords if you have forgotten them or you are locked out
because of AAA settings, and how to disable password recovery for extra security. This section includes
the following topics:
Recovering Passwords for the ASA, page 82-9
Command Purpose
packet-tracer input [ifc_name] [icmp [sip | user
username | fqdn fqdn-string] type code ident [dip |
fqdn fqdn-string]] | [tcp [sip | user username |
fqdn fqdn-string] sport [dip | fqdn fqdn-string]
dport] | [udp [sip | user username | fqdn fqdn-
string] sport [dip | fqdn fqdn-string] dport] |
[rawip [sip | user username | fqdn fqdn-string] [dip
| fqdn fqdn-string]] [detailed] [xml]
Example:
hostname# packet-tracer input inside tcp 10.2.25.3
www 209.165.202.158 aol detailed
Provides detailed information about the packets and how they
are processed by the ASA. The example shows how to enable
packet tracing from inside host 10.2.25.3 to external host
209.165.202.158, including detailed information.
Command Purpose
reload
Example:
hostname (config)# reload
Restarts the ASA.
Note In multiple mode, you can only reload from the system execution
space.
82-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Performing Password Recovery
Disabling Password Recovery, page 82-10
Resetting the Password on the SSM Hardware Module, page 82-11
Recovering Passwords for the ASA
To recover passwords for the ASA, perform the following steps:
Step 1 Connect to the ASA console port according to the instructions in Accessing the Appliance
Command-Line Interface section on page 2-1.
Step 2 Power off the ASA, and then power it on.
Step 3 After startup, press the Escape key when you are prompted to enter ROMMON mode.
Step 4 To update the configuration register value, enter the following command:
rommon #1> confreg 0x41
Update Config Register (0x41) in NVRAM...
Step 5 To set the ASA to ignore the startup configuration, enter the following command:
rommon #1> confreg
The ASA displays the current configuration register value, and asks whether you want to change it:
Current Configuration Register: 0x00000041
Configuration Summary:
boot default image from Flash
ignore system configuration
Do you wish to change this configuration? y/n [n]: y
Step 6 Record the current configuration register value, so you can restore it later.
Step 7 At the prompt, enter Y to change the value.
The ASA prompts you for new values.
Step 8 Accept the default values for all settings. At the prompt, enter Y.
Step 9 Reload the ASA by entering the following command:
rommon #2> boot
Launching BootLoader...
Boot configuration file contains 1 entry.
Loading disk0:/asa800-226-k8.bin... Booting...Loading...
The ASA loads the default configuration instead of the startup configuration.
Step 10 Access the privileged EXEC mode by entering the following command:
hostname# enable
Step 11 When prompted for the password, press Enter.
The password is blank.
Step 12 Load the startup configuration by entering the following command:
hostname# copy startup-config running-config
Step 13 Access the global configuration mode by entering the following command:
hostname# configure terminal
82-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Performing Password Recovery
Step 14 Change the passwords, as required, in the default configuration by entering the following commands:
hostname(config)# password password
hostname(config)# enable password password
hostname(config)# username name password password
Step 15 Load the default configuration by entering the following command:
hostname(config)# no config-register
The default configuration register value is 0x1. For more information about the configuration register,
see the command reference.
Step 16 Save the new passwords to the startup configuration by entering the following command:
hostname(config)# copy running-config startup-config
Disabling Password Recovery
To disable password recovery to ensure that unauthorized users cannot use the password recovery
mechanism to compromise the ASA, enter the following command:
On the ASA, the no service password-recovery command prevents you from entering ROMMON mode
with the configuration intact. When you enter ROMMON mode, the ASA prompts you to erase all Flash
file systems. You cannot enter ROMMON mode without first performing this erasure. If you choose not
to erase the Flash file system, the ASA reloads. Because password recovery depends on using ROMMON
mode and maintaining the existing configuration, this erasure prevents you from recovering a password.
However, disabling password recovery prevents unauthorized users from viewing the configuration or
inserting different passwords. In this case, to restore the system to an operating state, load a new image
and a backup configuration file, if available.
The service password-recovery command appears in the configuration file for information only. When
you enter the command at the CLI prompt, the setting is saved in NVRAM. The only way to change the
setting is to enter the command at the CLI prompt. Loading a new configuration with a different version
of the command does not change the setting. If you disable password recovery when the ASA is
configured to ignore the startup configuration at startup (in preparation for password recovery), then the
ASA changes the setting to load the startup configuration as usual. If you use failover, and the standby
unit is configured to ignore the startup configuration, then the same change is made to the configuration
register when the no service password recovery command replicates to the standby unit.
Command Purpose
no service password-recovery
Example:
hostname (config)# no service
password-recovery
Disables password recovery.
82-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Using the ROM Monitor to Load a Software Image
Resetting the Password on the SSM Hardware Module
To reset the password to the default of cisco on the SSM hardware module, enter the following
command:
Note Make sure that the SSM hardware module is in the Up state and supports password reset.
Using the ROM Monitor to Load a Software Image
To load a software image to an ASA from the ROM monitor mode using TFTP, perform the following
steps:
Step 1 Connect to the ASA console port according to the instructions in the Accessing the Appliance
Command-Line Interface section on page 2-1.
Step 2 Power off the ASA, then power it on.
Step 3 During startup, press the Escape key when you are prompted to enter ROMMON mode.
Step 4 In ROMMOM mode, define the interface settings to the ASA, including the IP address, TFTP server
address, gateway address, software image file, and port, as follows:
rommon #1> ADDRESS=10.132.44.177
rommon #2> SERVER=10.129.0.30
rommon #3> GATEWAY=10.132.44.1
rommon #4> IMAGE=f1/asa840-232-k8.bin
rommon #5> PORT=Ethernet0/0
Ethernet0/0
Link is UP
MAC Address: 0012.d949.15b8
Note Be sure that the connection to the network already exists.
Step 5 To validate your settings, enter the set command.
rommon #6> set
ROMMON Variable Settings:
Command Purpose
hw-module module 1
password-reset
Reset the password on
module in slot 1? [confirm]
y
hostname# y
Where 1 is the specified slot number on the SSM hardware module.
Note On the AIP SSM, entering this command reboots the hardware module. The module
is offline until the rebooting is finished. Enter the show module command to
monitor the module status. The AIP SSM supports this command in version 6.0 and
later.
On the CSC SSM, entering this command resets web services on the hardware
module after the password has been reset. You may lose connection to ASDM or be
logged out of the hardware module. The CSC SSM supports this command in the
most recent version of 6.3, dated January 2010, and later releases.
82-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Erasing the Flash File System
ADDRESS=10.132.44.177
SERVER=10.129.0.30
GATEWAY=10.132.44.1
PORT=Ethernet0/0
VLAN=untagged
IMAGE=f1/asa840-232-k8.bin
CONFIG=
LINKTIMEOUT=20
PKTTIMEOUT=4
RETRY=20
Step 6 Ping the TFTP server by entering the ping server command.
rommon #7> ping server
Sending 20, 100-byte ICMP Echoes to server 10.129.0.30, timeout is 4 seconds:
Success rate is 100 percent (20/20)
Step 7 Load the software image by entering the tftp command.
rommon #8> tftp
ROMMON Variable Settings:
ADDRESS=10.132.44.177
SERVER=10.129.0.30
GATEWAY=10.132.44.1
PORT=Ethernet0/0
VLAN=untagged
IMAGE=f1/asa840-232-k8.bin
CONFIG=
LINKTIMEOUT=20
PKTTIMEOUT=4
RETRY=20
tftp f1/asa840-232-k8.bin@10.129.0.30 via 10.132.44.1
Received 14450688 bytes
Launching TFTP Image...
Cisco ASA Security Appliance admin loader (3.0) #0: Mon Mar 5 16:00:07 MST 2011
Loading...
After the software image is successfully loaded, the ASA automatically exits ROMMON mode.
Step 8 To verify that the correct software image has been loaded into the ASA, check the version by entering
the following command:
hostname# show version
Erasing the Flash File System
To erase the flash file system, perform the following steps:
Step 1 Connect to the ASA console port according to the instructions in Accessing the Appliance
Command-Line Interface section on page 2-1.
Step 2 Power off the ASA, then power it on.
Step 3 During startup, press the Escape key when you are prompted to enter ROMMON mode.
82-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Other Troubleshooting Tools
Step 4 Enter the erase command, which overwrites all files and erases the file system, including hidden system
files.
rommon #1> erase [disk0: | disk1: | flash:]
Other Troubleshooting Tools
The ASA provides other troubleshooting tools that you can use. This section includes the following
topics:
Viewing Debugging Messages, page 82-13
Capturing Packets, page 82-14
Viewing the Crash Dump, page 82-14
Coredump, page 82-14
Monitoring Per-Process CPU Usage, page 82-14
Viewing Debugging Messages
Because debugging output is assigned high priority in the CPU process, it can render the system
unusable. For this reason, use debug commands only to troubleshoot specific problems or during
troubleshooting sessions with Cisco TAC. Moreover, it is best to use debug commands during periods
82-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Common Problems
of less network traffic and fewer users. Debugging during these periods decreases the likelihood that
increased debug command processing overhead will affect system use. To enable debugging messages,
see the debug commands in the command reference.
Capturing Packets
Capturing packets is sometimes useful when troubleshooting connectivity problems or monitoring
suspicious activity. We recommend that you contact the Cisco TAC if you want to use the packet capture
feature. See the capture command in the command reference.
Viewing the Crash Dump
If the ASA crashes, you can view the crash dump information. We recommend contacting Cisco TAC if
you want to interpret the crash dump. See the show crashdump command in the command reference.
Coredump
A coredump is a snapshot of the running program when the program has terminated abnormally, or
crashed. Coredumps are used to diagnose or debug errors and save a crash for future off-site analysis.
Cisco TAC may request that users enable the coredump feature to troubleshoot application or system
crashes on the ASA. See the coredump command in the command reference.
Monitoring Per-Process CPU Usage
You can monitor the processes that run on the CPU. You can obtain information about the percentage of
CPU that is used by a certain process. CPU usage statistics are sorted in descending order to display the
highest consumer at the top. Also included is information about the load on the CPU per process, at 5
seconds, 1 minute, and 5 minutes before the log time. This information is updated automatically every
5 seconds to provide real-time statistics.You can use the show process cpu-usage sorted command to
find a breakdown of the process-related load-to-CPU that is consumed by any configured contexts.
Common Problems
This section describes common problems with the ASA, and how you might resolve them.
Symptom The context configuration was not saved, and was lost when you reloaded.
Possible Cause You did not save each context within the context execution space. If you are
configuring contexts at the command line, you did not save the current context before you changed
to the next context.
Recommended Action Save each context within the context execution space using the copy start run
command. Load the startup configuration as your active configuration. Then change the password
and then enter the copy run start command. You cannot save contexts from the system execution
space.
82-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Common Problems
Symptom You cannot make a Telnet or SSH connection to the ASA interface.
Possible Cause You did not enable Telnet or SSH to the ASA.
Recommended Action Enable Telnet or SSH to the ASA according to the instructions in the
Configuring ASA Access for ASDM, Telnet, or SSH section on page 37-1.
Symptom You cannot ping the ASA interface.
Possible Cause You disabled ICMP to the ASA.
Recommended Action Enable ICMP to the ASA for your IP address using the icmp command.
Symptom You cannot ping through the ASA, although the access list allows it.
Possible Cause You did not enable the ICMP inspection engine or apply access lists on both the
ingress and egress interfaces.
Recommended Action Because ICMP is a connectionless protocol, the ASA does not automatically
allow returning traffic through. In addition to an access list on the ingress interface, you either need
to apply an access list to the egress interface to allow replying traffic, or enable the ICMP inspection
engine, which treats ICMP connections as stateful connections.
Symptom Traffic does not pass between two interfaces on the same security level.
Possible Cause You did not enable the feature that allows traffic to pass between interfaces at the
same security level.
Recommended Action Enable this feature according to the instructions in the Allowing Same
Security Level Communication section on page 8-15.
Symptom IPsec tunnels do not duplicate during a failover to the standby device.
Possible Cause The switch port that the ASA is plugged into is set to 10/100 instead of 1000.
Recommended Action Set the switch port that the ASA is plugged into to 1000.
82-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Chapter 82 Troubleshooting
Common Problems
P A R T 1 9
Reference
A-1
Cisco ASA 5500 Series Configuration Guide using the CLI
A P P E N D I X A
Using the Command-Line Interface
This appendix describes how to use the CLI on the ASA and includes the following sections:
Firewall Mode and Security Context Mode, page A-1
Command Modes and Prompts, page A-2
Syntax Formatting, page A-3
Abbreviating Commands, page A-3
Command-Line Editing, page A-3
Command Completion, page A-4
Command Help, page A-4
Filtering show Command Output, page A-4
Command Output Paging, page A-5
Adding Comments, page A-5
Text Configuration Files, page A-5
Supported Character Sets, page A-8
Note The CLI uses similar syntax and other conventions to the Cisco IOS CLI, but the ASA operating system
is not a version of Cisco IOS software. Do not assume that a Cisco IOS CLI command works with or has
the same function on the ASA.
Firewall Mode and Security Context Mode
The ASA runs in a combination of the following modes:
Transparent firewall or routed firewall mode
The firewall mode determines if the ASA runs as a Layer 2 or Layer 3 firewall.
Multiple context or single context mode
The security context mode determines if the ASA runs as a single device or as multiple security
contexts, which act like virtual devices.
Some commands are only available in certain modes.
A-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix A Using the Command-Line Interface
Command Modes and Prompts
Command Modes and Prompts
The ASA CLI includes command modes. Some commands can only be entered in certain modes. For
example, to enter commands that show sensitive information, you need to enter a password and enter a
more privileged mode. Then, to ensure that configuration changes are not entered accidentally, you have
to enter a configuration mode. All lower commands can be entered in higher modes, for example, you
can enter a privileged EXEC command in global configuration mode.
Note The various types of prompts are all default prompts and when configured, they can be different.
When you are in the system configuration or in single context mode, the prompt begins with the
hostname:
hostname
When printing the prompt string, the prompt configuration is parsed and the configured keyword
values are printed in the order in which you have set the prompt command. The keyword arguments
can be any of the following and in any order: hostname, domain, context, priority, state.
asa(config)# prompt hostname context priority state
When you are within a context, the prompt begins with the hostname followed by the context name:
hostname/context
The prompt changes depending on the access mode:
User EXEC mode
User EXEC mode lets you see minimum ASA settings. The user EXEC mode prompt appears as
follows when you first access the ASA:
hostname>
hostname/context>
Privileged EXEC mode
Privileged EXEC mode lets you see all current settings up to your privilege level. Any user EXEC
mode command will work in privileged EXEC mode. Enter the enable command in user EXEC
mode, which requires a password, to start privileged EXEC mode. The prompt includes the number
sign (#):
hostname#
hostname/context#
Global configuration mode
Global configuration mode lets you change the ASA configuration. All user EXEC, privileged
EXEC, and global configuration commands are available in this mode. Enter the configure terminal
command in privileged EXEC mode to start global configuration mode. The prompt changes to the
following:
hostname(config)#
hostname/context(config)#
Command-specific configuration modes
A-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix A Using the Command-Line Interface
Syntax Formatting
From global configuration mode, some commands enter a command-specific configuration mode.
All user EXEC, privileged EXEC, global configuration, and command-specific configuration
commands are available in this mode. For example, the interface command enters interface
configuration mode. The prompt changes to the following:
hostname(config-if)#
hostname/context(config-if)#
Syntax Formatting
Command syntax descriptions use the conventions listed in Table A-1.
Abbreviating Commands
You can abbreviate most commands down to the fewest unique characters for a command; for example,
you can enter wr t to view the configuration instead of entering the full command write terminal, or
you can enter en to start privileged mode and conf t to start configuration mode. In addition, you can
enter 0 to represent 0.0.0.0.
Command-Line Editing
The ASA uses the same command-line editing conventions as Cisco IOS software. You can view all
previously entered commands with the show history command or individually with the up arrow or ^p
command. Once you have examined a previously entered command, you can move forward in the list
with the down arrow or ^n command. When you reach a command you wish to reuse, you can edit it or
press the Enter key to start it. You can also delete the word to the left of the cursor with ^w, or erase the
line with ^u.
The ASA permits up to 512 characters in a command; additional characters are ignored.
Table A-1 Syntax Conventions
Convention Description
bold Bold text indicates commands and keywords that you enter literally as shown.
italics Italic text indicates arguments for which you supply values.
[x] Square brackets enclose an optional element (keyword or argument).
| A vertical bar indicates a choice within an optional or required set of keywords or
arguments.
[x | y] Square brackets enclosing keywords or arguments separated by a vertical bar indicate
an optional choice.
{x | y} Braces enclosing keywords or arguments separated by a vertical bar indicate a required
choice.
[x {y | z}] Nested sets of square brackets or braces indicate optional or required choices within
optional or required elements. Braces and a vertical bar within square brackets indicate
a required choice within an optional element.
A-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix A Using the Command-Line Interface
Command Completion
Command Completion
To complete a command or keyword after entering a partial string, press the Tab key. The ASA only
completes the command or keyword if the partial string matches only one command or keyword. For
example, if you enter s and press the Tab key, the ASA does not complete the command because it
matches more than one command. However, if you enter dis, the Tab key completes the disable
command.
Command Help
Help information is available from the command line by entering the following commands:
help command_name
Shows help for the specific command.
command_name ?
Shows a list of arguments available.
string? (no space)
Lists the possible commands that start with the string.
? and +?
Lists all commands available. If you enter ?, the ASA shows only commands available for the
current mode. To show all commands available, including those for lower modes, enter +?.
Note If you want to include a question mark (?) in a command string, you must press Ctrl-V before typing the
question mark so that you do not inadvertently invoke CLI help.
Filtering show Command Output
You can use the vertical bar (|) with any show command and include a filter option and filtering
expression. The filtering is performed by matching each output line with a regular expression, similar to
Cisco IOS software. By selecting different filter options you can include or exclude all output that
matches the expression. You can also display all output beginning with the line that matches the
expression.
The syntax for using filtering options with the show command is as follows:
hostname# show command | {include | exclude | begin | grep [-v]} regexp
In this command string, the first vertical bar (|) is the operator and must be included in the command.
This operator directs the output of the show command to the filter. In the syntax diagram, the other
vertical bars (|) indicate alternative options and are not part of the command.
The include option includes all output lines that match the regular expression. The grep option without
-v has the same effect. The exclude option excludes all output lines that match the regular expression.
The grep option with -v has the same effect. The begin option shows all the output lines starting with
the line that matches the regular expression.
A-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix A Using the Command-Line Interface
Command Output Paging
Replace regexp with any Cisco IOS regular expression. The regular expression is not enclosed in quotes or
double-quotes, so be careful with trailing white spaces, which will be taken as part of the regular
expression.
When creating regular expressions, you can use any letter or number that you want to match. In addition,
certain keyboard characters called metacharacters have special meaning when used in regular
expressions.
Use Ctrl+V to escape all of the special characters in the CLI, such as a question mark (?) or a tab. For
example, type d[Ctrl+V]?g to enter d?g in the configuration.
For a list of metacharacters, see Table 13-2 on page 13-13.
Command Output Paging
For commands such as help or ?, show, show xlate, or other commands that provide long listings, you
can determine if the information displays a screen and pauses, or lets the command run to completion.
The pager command lets you choose the number of lines to display before the More prompt appears.
When paging is enabled, the following prompt appears:
<--- More --->
The More prompt uses syntax similar to the UNIX more command:
To view another screen, press the Space bar.
To view the next line, press the Enter key.
To return to the command line, press the q key.
Adding Comments
You can precede a line with a colon ( : ) to create a comment. However, the comment only appears in the
command history buffer and not in the configuration. Therefore, you can view the comment with the
show history command or by pressing an arrow key to retrieve a previous command, but because the
comment is not in the configuration, the write terminal command does not display it.
Text Configuration Files
This section describes how to format a text configuration file that you can download to the ASA, and
includes the following topics:
How Commands Correspond with Lines in the Text File, page A-6
Command-Specific Configuration Mode Commands, page A-6
Automatic Text Entries, page A-7
Line Order, page A-7
Commands Not Included in the Text Configuration, page A-7
Passwords, page A-7
Multiple Security Context Files, page A-7
A-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix A Using the Command-Line Interface
Text Configuration Files
How Commands Correspond with Lines in the Text File
The text configuration file includes lines that correspond with the commands described in this guide.
In examples, commands are preceded by a CLI prompt. The prompt in the following example is
hostname(config)#:
hostname(config)# context a
In the text configuration file you are not prompted to enter commands, so the prompt is omitted:
context a
Command-Specific Configuration Mode Commands
Command-specific configuration mode commands appear indented under the main command when
entered at the command line. Your text file lines do not need to be indented, as long as the commands
appear directly following the main command. For example, the following unindented text is read the
same as indented text:
interface gigabitethernet0/0
nameif inside
interface gigabitethernet0/1
nameif outside
A-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix A Using the Command-Line Interface
Text Configuration Files
Automatic Text Entries
When you download a configuration to the ASA, it inserts some lines automatically. For example, the
ASA inserts lines for default settings or for the time the configuration was modified. You do not need to
enter these automatic entries when you create your text file.
Line Order
For the most part, commands can be in any order in the file. However, some lines, such as ACEs, are
processed in the order they appear, and the order can affect the function of the access list. Other
commands might also have order requirements. For example, you must enter the nameif command for
an interface first because many subsequent commands use the name of the interface. Also, commands in
a command-specific configuration mode must directly follow the main command.
Commands Not Included in the Text Configuration
Some commands do not insert lines in the configuration. For example, a runtime command such as
show running-config does not have a corresponding line in the text file.
Passwords
The login, enable, and user passwords are automatically encrypted before they are stored in the
configuration. For example, the encrypted form of the password cisco might look like
jMorNbK0514fadBh. You can copy the configuration passwords to another ASA in its encrypted form,
but you cannot unencrypt the passwords yourself.
If you enter an unencrypted password in a text file, the ASA does not automatically encrypt it when you
copy the configuration to the ASA. The ASA only encrypts it when you save the running configuration
from the command line using the copy running-config startup-config or write memory command.
Multiple Security Context Files
For multiple security contexts, the entire configuration consists of the following multiple parts:
The security context configurations
The system configuration, which identifies basic settings for the ASA, including a list of contexts
The admin context, which provides network interfaces for the system configuration
The system configuration does not include any interfaces or network settings for itself. Rather, when
the system needs to access network resources (such as downloading the contexts from the server), it
uses a context that is designated as the admin context.
Each context is similar to a single context mode configuration. The system configuration differs from a
context configuration in that the system configuration includes system-only commands (such as a list of
all contexts) while other typical commands are not present (such as many interface parameters).
A-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix A Using the Command-Line Interface
Supported Character Sets
Supported Character Sets
The ASA CLI currently supports UTF-8 encoding only. UTF-8 is the particular encoding scheme for
Unicode symbols, and has been designed to be compatible with an ASCII subset of symbols. ASCII
characters are represented in UTF-8 as one-byte characters. All other characters are represented in
UTF-8 as multibyte symbols.
The ASCII printable characters (0x20 to 0x7e) are fully supported. The printable ASCII characters are
the same as ISO 8859-1. UTF-8 is a superset of ISO 8859-1, so the first 256 characters (0-255) are the
same as ISO 8859-1. The ASA CLI supports up to 255 characters (multibyte characters) of ISO 8859-1.
B-1
Cisco ASA 5500 Series Configuration Guide using the CLI
A P P E N D I X B
Addresses, Protocols, and Ports
This appendix provides a quick reference for IP addresses, protocols, and applications. This appendix
includes the following sections:
IPv4 Addresses and Subnet Masks, page B-1
IPv6 Addresses, page B-5
Protocols and Applications, page B-11
TCP and UDP Ports, page B-11
Local Ports and Protocols, page B-14
ICMP Types, page B-15
IPv4 Addresses and Subnet Masks
This section describes how to use IPv4 addresses in the ASA. An IPv4 address is a 32-bit number written
in dotted-decimal notation: four 8-bit fields (octets) converted from binary to decimal numbers,
separated by dots. The first part of an IP address identifies the network on which the host resides, while
the second part identifies the particular host on the given network. The network number field is called
the network prefix. All hosts on a given network share the same network prefix but must have a unique
host number. In classful IP, the class of the address determines the boundary between the network prefix
and the host number.
This section includes the following topics:
Classes, page B-1
Private Networks, page B-2
Subnet Masks, page B-2
Classes
IP host addresses are divided into three different address classes: Class A, Class B, and Class C. Each
class fixes the boundary between the network prefix and the host number at a different point within the
32-bit address. Class D addresses are reserved for multicast IP.
Class A addresses (1.xxx.xxx.xxx through 126.xxx.xxx.xxx) use only the first octet as the network
prefix.
B-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
IPv4 Addresses and Subnet Masks
Class B addresses (128.0.xxx.xxx through 191.255.xxx.xxx) use the first two octets as the network
prefix.
Class C addresses (192.0.0.xxx through 223.255.255.xxx) use the first three octets as the network
prefix.
Because Class A addresses have 16,777,214 host addresses, and Class B addresses 65,534 hosts, you can
use subnet masking to break these huge networks into smaller subnets.
Private Networks
If you need large numbers of addresses on your network, and they do not need to be routed on the
Internet, you can use private IP addresses that the Internet Assigned Numbers Authority (IANA)
recommends (see RFC 1918). The following address ranges are designated as private networks that
should not be advertised:
10.0.0.0 through 10.255.255.255
172.16.0.0 through 172.31.255.255
192.168.0.0 through 192.168.255.255
Subnet Masks
A subnet mask lets you convert a single Class A, B, or C network into multiple networks. With a subnet
mask, you can create an extended network prefix that adds bits from the host number to the network
prefix. For example, a Class C network prefix always consists of the first three octets of the IP address.
But a Class C extended network prefix uses part of the fourth octet as well.
Subnet masking is easy to understand if you use binary notation instead of dotted decimal. The bits in
the subnet mask have a one-to-one correspondence with the Internet address:
The bits are set to 1 if the corresponding bit in the IP address is part of the extended network prefix.
The bits are set to 0 if the bit is part of the host number.
Example 1: If you have the Class B address 129.10.0.0 and you want to use the entire third octet as part
of the extended network prefix instead of the host number, then you must specify a subnet mask of
11111111.11111111.11111111.00000000. This subnet mask converts the Class B address into the
equivalent of a Class C address, where the host number consists of the last octet only.
Example 2: If you want to use only part of the third octet for the extended network prefix, then you must
specify a subnet mask like 11111111.11111111.11111000.00000000, which uses only 5 bits of the third
octet for the extended network prefix.
You can write a subnet mask as a dotted-decimal mask or as a /bits (slash bits) mask. In Example 1,
for a dotted-decimal mask, you convert each binary octet into a decimal number: 255.255.255.0. For a
/bits mask, you add the number of 1s: /24. In Example 2, the decimal number is 255.255.248.0 and the
/bits is /21.
You can also supernet multiple Class C networks into a larger network by using part of the third octet
for the extended network prefix. For example, 192.168.0.0/20.
This section includes the following topics:
Determining the Subnet Mask, page B-3
Determining the Address to Use with the Subnet Mask, page B-3
B-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
IPv4 Addresses and Subnet Masks
Determining the Subnet Mask
To determine the subnet mask based on how many hosts you want, see Table B-1.
Determining the Address to Use with the Subnet Mask
The following sections describe how to determine the network address to use with a subnet mask for a
Class C-size and a Class B-size network. This section includes the following topics:
Class C-Size Network Address, page B-3
Class B-Size Network Address, page B-4
Class C-Size Network Address
For a network between 2 and 254 hosts, the fourth octet falls on a multiple of the number of host
addresses, starting with 0. For example, Table B-2 shows the 8-host subnets (/29) of 192.168.0.x.
Table B-1 Hosts, Bits, and Dotted-Decimal Masks
Hosts
1
1. The first and last number of a subnet are reserved, except for /32, which identifies a single host.
/Bits Mask Dotted-Decimal Mask
16,777,216 /8 255.0.0.0 Class A Network
65,536 /16 255.255.0.0 Class B Network
32,768 /17 255.255.128.0
16,384 /18 255.255.192.0
8192 /19 255.255.224.0
4096 /20 255.255.240.0
2048 /21 255.255.248.0
1024 /22 255.255.252.0
512 /23 255.255.254.0
256 /24 255.255.255.0 Class C Network
128 /25 255.255.255.128
64 /26 255.255.255.192
32 /27 255.255.255.224
16 /28 255.255.255.240
8 /29 255.255.255.248
4 /30 255.255.255.252
Do not use /31 255.255.255.254
1 /32 255.255.255.255 Single Host Address
Table B-2 Class C-Size Network Address
Subnet with Mask /29 (255.255.255.248) Address Range
1
192.168.0.0 192.168.0.0 to 192.168.0.7
192.168.0.8 192.168.0.8 to 192.168.0.15
B-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
IPv4 Addresses and Subnet Masks
Class B-Size Network Address
To determine the network address to use with the subnet mask for a network with between 254 and
65,534 hosts, you need to determine the value of the third octet for each possible extended network
prefix. For example, you might want to subnet an address like 10.1.x.0, where the first two octets are
fixed because they are used in the extended network prefix, and the fourth octet is 0 because all bits are
used for the host number.
To determine the value of the third octet, follow these steps:
Step 1 Calculate how many subnets you can make from the network by dividing 65,536 (the total number of
addresses using the third and fourth octet) by the number of host addresses you want.
For example, 65,536 divided by 4096 hosts equals 16.
Therefore, there are 16 subnets of 4096 addresses each in a Class B-size network.
Step 2 Determine the multiple of the third octet value by dividing 256 (the number of values for the third octet)
by the number of subnets:
In this example, 256/16 = 16.
The third octet falls on a multiple of 16, starting with 0.
Therefore, Table B-3 shows the 16 subnets of the network 10.1.
192.168.0.16 192.168.0.16 to 192.168.0.31
192.168.0.248 192.168.0.248 to 192.168.0.255
1. The first and last address of a subnet are reserved. In the first subnet example, you cannot use 192.168.0.0 or 192.168.0.7.
Table B-2 Class C-Size Network Address (continued)
Subnet with Mask /29 (255.255.255.248) Address Range
1
Table B-3 Subnets of Network
Subnet with Mask /20 (255.255.240.0) Address Range
1
1. The first and last address of a subnet are reserved. In the first subnet example, you cannot use
10.1.0.0 or 10.1.15.255.
10.1.0.0 10.1.0.0 to 10.1.15.255
10.1.16.0 10.1.16.0 to 10.1.31.255
10.1.32.0 10.1.32.0 to 10.1.47.255
10.1.240.0 10.1.240.0 to 10.1.255.255
B-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
IPv6 Addresses
IPv6 Addresses
IPv6 is the next generation of the Internet Protocol after IPv4. It provides an expanded address space, a
simplified header format, improved support for extensions and options, flow labeling capability, and
authentication and privacy capabilities. IPv6 is described in RFC 2460. The IPv6 addressing architecture
is described in RFC 3513.
This section describes the IPv6 address format and architecture and includes the following topics:
IPv6 Address Format, page B-5
IPv6 Address Types, page B-6
IPv6 Address Prefixes, page B-10
Note This section describes the IPv6 address format, the types, and prefixes. For information about
configuring the ASA to use IPv6, see the Configuring IPv6 Addressing section on page 8-11
IPv6 Address Format
IPv6 addresses are represented as a series of eight 16-bit hexadecimal fields separated by colons (:) in
the format: x:x:x:x:x:x:x:x. The following are two examples of IPv6 addresses:
2001:0DB8:7654:3210:FEDC:BA98:7654:3210
2001:0DB8:0000:0000:0008:0800:200C:417A
Note The hexadecimal letters in IPv6 addresses are not case-sensitive.
You do not need to include the leading zeros in an individual field of the address, but each field must
contain at least one digit. So the example address 2001:0DB8:0000:0000:0008:0800:200C:417A can be
shortened to 2001:0DB8:0:0:8:800:200C:417A by removing the leading zeros from the third through
sixth fields from the left. The fields that contained all zeros (the third and fourth fields from the left)
were shortened to a single zero. The fifth field from the left had the three leading zeros removed, leaving
a single 8 in that field, and the sixth field from the left had the one leading zero removed, leaving 800 in
that field.
It is common for IPv6 addresses to contain several consecutive hexadecimal fields of zeros. You can use
two colons (::) to compress consecutive fields of zeros at the beginning, middle, or end of an IPv6
address (the colons represent the successive hexadecimal fields of zeros). Table B-4 shows several
examples of address compression for different types of IPv6 address.
Table B-4 IPv6 Address Compression Examples
Address Type Standard Form Compressed Form
Unicast 2001:0DB8:0:0:0:BA98:0:3210 2001:0DB8::BA98:0:3210
Multicast FF01:0:0:0:0:0:0:101 FF01::101
Loopback 0:0:0:0:0:0:0:1 ::1
Unspecified 0:0:0:0:0:0:0:0 ::
B-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
IPv6 Addresses
Note Two colons (::) can be used only once in an IPv6 address to represent successive fields of zeros.
An alternative form of the IPv6 format is often used when dealing with an environment that contains
both IPv4 and IPv6 addresses. This alternative has the format x:x:x:x:x:x:y.y.y.y, where x represent the
hexadecimal values for the six high-order parts of the IPv6 address and y represent decimal values for
the 32-bit IPv4 part of the address (which takes the place of the remaining two 16-bit parts of the IPv6
address). For example, the IPv4 address 192.168.1.1 could be represented as the IPv6 address
0:0:0:0:0:0:FFFF:192.168.1.1 or ::FFFF:192.168.1.1.
IPv6 Address Types
The following are the three main types of IPv6 addresses:
UnicastA unicast address is an identifier for a single interface. A packet sent to a unicast address
is delivered to the interface identified by that address. An interface may have more than one unicast
address assigned to it.
MulticastA multicast address is an identifier for a set of interfaces. A packet sent to a multicast
address is delivered to all addresses identified by that address.
AnycastAn anycast address is an identifier for a set of interfaces. Unlike a multicast address, a
packet sent to an anycast address is only delivered to the nearest interface, as determined by the
measure of distances for the routing protocol.
Note There are no broadcast addresses in IPv6. Multicast addresses provide the broadcast functionality.
This section includes the following topics:
Unicast Addresses, page B-6
Multicast Address, page B-8
Anycast Address, page B-9
Required Addresses, page B-10
Unicast Addresses
This section describes IPv6 unicast addresses. Unicast addresses identify an interface on a network node.
This section includes the following topics:
Global Address, page B-7
Site-Local Address, page B-7
Link-Local Address, page B-7
IPv4-Compatible IPv6 Addresses, page B-7
Unspecified Address, page B-8
Loopback Address, page B-8
Interface Identifiers, page B-8
B-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
IPv6 Addresses
Global Address
The general format of an IPv6 global unicast address is a global routing prefix followed by a subnet ID
followed by an interface ID. The global routing prefix can be any prefix not reserved by another IPv6
address type (see the IPv6 Address Prefixes section on page B-10, for information about the IPv6
address type prefixes).
All global unicast addresses, other than those that start with binary 000, have a 64-bit interface ID in the
Modified EUI-64 format. See the Interface Identifiers section on page B-8, for more information about
the Modified EUI-64 format for interface identifiers.
Global unicast address that start with the binary 000 do not have any constraints on the size or structure
of the interface ID portion of the address. One example of this type of address is an IPv6 address with
an embedded IPv4 address (see the IPv4-Compatible IPv6 Addresses section on page B-7).
Site-Local Address
Site-local addresses are used for addressing within a site. They can be used to address an entire site
without using a globally unique prefix. Site-local addresses have the prefix FEC0::/10, followed by a
54-bit subnet ID, and end with a 64-bit interface ID in the modified EUI-64 format.
Site-local routers do not forward any packets that have a site-local address for a source or destination
outside of the site. Therefore, site-local addresses can be considered private addresses.
Link-Local Address
All interfaces are required to have at least one link-local address. You can configure multiple IPv6
addresses per interfaces, but only one link-local address.
A link-local address is an IPv6 unicast address that can be automatically configured on any interface
using the link-local prefix FE80::/10 and the interface identifier in modified EUI-64 format. Link-local
addresses are used in the neighbor discovery protocol and the stateless autoconfiguration process. Nodes
with a link-local address can communicate; they do not need a site-local or globally unique address to
communicate.
Routers do not forward any packets that have a link-local address for a source or destination. Therefore,
link-local addresses can be considered private addresses.
IPv4-Compatible IPv6 Addresses
There are two types of IPv6 addresses that can contain IPv4 addresses.
The first type is the IPv4-compatibly IPv6 address. The IPv6 transition mechanisms include a technique
for hosts and routers to dynamically tunnel IPv6 packets over IPv4 routing infrastructure. IPv6 nodes
that use this technique are assigned special IPv6 unicast addresses that carry a global IPv4 address in the
low-order 32 bits. This type of address is termed an IPv4-compatible IPv6 address and has the format
::y.y.y.y, where y.y.y.y is an IPv4 unicast address.
Note The IPv4 address used in the IPv4-compatible IPv6 address must be a globally unique IPv4 unicast
address.
The second type of IPv6 address, which holds an embedded IPv4 address, is called the IPv4-mapped
IPv6 address. This address type is used to represent the addresses of IPv4 nodes as IPv6 addresses. This
type of address has the format ::FFFF:y.y.y.y, where y.y.y.y is an IPv4 unicast address.
B-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
IPv6 Addresses
Unspecified Address
The unspecified address, 0:0:0:0:0:0:0:0, indicates the absence of an IPv6 address. For example, a newly
initialized node on an IPv6 network may use the unspecified address as the source address in its packets
until it receives its IPv6 address.
Note The IPv6 unspecified address cannot be assigned to an interface. The unspecified IPv6 addresses must
not be used as destination addresses in IPv6 packets or the IPv6 routing header.
Loopback Address
The loopback address, 0:0:0:0:0:0:0:1, may be used by a node to send an IPv6 packet to itself. The
loopback address in IPv6 functions the same as the loopback address in IPv4 (127.0.0.1).
Note The IPv6 loopback address cannot be assigned to a physical interface. A packet that has the IPv6
loopback address as its source or destination address must remain within the node that created the packet.
IPv6 routers do not forward packets that have the IPv6 loopback address as their source or destination
address.
Interface Identifiers
Interface identifiers in IPv6 unicast addresses are used to identify the interfaces on a link. They need to
be unique within a subnet prefix. In many cases, the interface identifier is derived from the interface
link-layer address. The same interface identifier may be used on multiple interfaces of a single node, as
long as those interfaces are attached to different subnets.
For all unicast addresses, except those that start with the binary 000, the interface identifier is required
to be 64 bits long and to be constructed in the Modified EUI-64 format. The Modified EUI-64 format is
created from the 48-bit MAC address by inverting the universal/local bit in the address and by inserting
the hexadecimal number FFFE between the upper three bytes and lower three bytes of the of the MAC
address.
For example, and interface with the MAC address of 00E0.b601.3B7A would have a 64-bit interface ID
of 02E0:B6FF:FE01:3B7A.
Multicast Address
An IPv6 multicast address is an identifier for a group of interfaces, typically on different nodes. A packet
sent to a multicast address is delivered to all interfaces identified by the multicast address. An interface
may belong to any number of multicast groups.
An IPv6 multicast address has a prefix of FF00::/8 (1111 1111). The octet following the prefix defines
the type and scope of the multicast address. A permanently assigned (well known) multicast address has
a flag parameter equal to 0; a temporary (transient) multicast address has a flag parameter equal to 1. A
multicast address that has the scope of a node, link, site, or organization, or a global scope has a scope
parameter of 1, 2, 5, 8, or E, respectively. For example, a multicast address with the prefix FF02::/16 is
a permanent multicast address with a link scope. Figure B-1 shows the format of the IPv6 multicast
address.
B-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
IPv6 Addresses
Figure B-1 IPv6 Multicast Address Format
IPv6 nodes (hosts and routers) are required to join the following multicast groups:
The All Nodes multicast addresses:
FF01:: (interface-local)
FF02:: (link-local)
The Solicited-Node Address for each IPv6 unicast and anycast address on the node:
FF02:0:0:0:0:1:FFXX:XXXX/104, where XX:XXXX is the low-order 24-bits of the unicast or
anycast address.
Note Solicited-Node addresses are used in Neighbor Solicitation messages.
IPv6 routers are required to join the following multicast groups:
FF01::2 (interface-local)
FF02::2 (link-local)
FF05::2 (site-local)
Multicast address should not be used as source addresses in IPv6 packets.
Note There are no broadcast addresses in IPv6. IPv6 multicast addresses are used instead of broadcast
addresses.
Anycast Address
The IPv6 anycast address is a unicast address that is assigned to more than one interface (typically
belonging to different nodes). A packet that is routed to an anycast address is routed to the nearest
interface having that address, the nearness being determined by the routing protocol in effect.
Anycast addresses are allocated from the unicast address space. An anycast address is simply a unicast
address that has been assigned to more than one interface, and the interfaces must be configured to
recognize the address as an anycast address.
The following restrictions apply to anycast addresses:
An anycast address cannot be used as the source address for an IPv6 packet.
9
2
6
1
7
128 bits
4 bits 4 bits
0 if permanent
1 if temporary
Interface ID 0
1111 1111
8 bits 8 bits
F F Flag Scope
Flag =
Scope =
1 = node
2 = link
4 = admin
5 = site
8 = organization
E = global
B-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
IPv6 Addresses
An anycast address cannot be assigned to an IPv6 host; it can only be assigned to an IPv6 router.
Note Anycast addresses are not supported on the ASA.
Required Addresses
IPv6 hosts must, at a minimum, be configured with the following addresses (either automatically or
manually):
A link-local address for each interface
The loopback address
The All-Nodes multicast addresses
A Solicited-Node multicast address for each unicast or anycast address
IPv6 routers must, at a minimum, be configured with the following addresses (either automatically or
manually):
The required host addresses
The Subnet-Router anycast addresses for all interfaces for which it is configured to act as a router
The All-Routers multicast addresses
IPv6 Address Prefixes
An IPv6 address prefix, in the format ipv6-prefix/prefix-length, can be used to represent bit-wise
contiguous blocks of the entire address space. The IPv6-prefix must be in the form documented in RFC
2373 where the address is specified in hexadecimal using 16-bit values between colons. The prefix
length is a decimal value that indicates how many of the high-order contiguous bits of the address
comprise the prefix (the network portion of the address). For example, 2001:0DB8:8086:6502::/32 is a
valid IPv6 prefix.
The IPv6 prefix identifies the type of IPv6 address. Table B-5 shows the prefixes for each IPv6 address
type.
Table B-5 IPv6 Address Type Prefixes
Address Type Binary Prefix IPv6 Notation
Unspecified 000...0 (128 bits) ::/128
Loopback 000...1 (128 bits) ::1/128
Multicast 11111111 FF00::/8
Link-Local (unicast) 1111111010 FE80::/10
Site-Local (unicast) 1111111111 FEC0::/10
Global (unicast) All other addresses.
Anycast Taken from the unicast address space.
B-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
Protocols and Applications
Protocols and Applications
Table B-6 lists the protocol literal values and port numbers; either can be entered in ASA commands.
Protocol numbers can be viewed online at the IANA website:
http://www.iana.org/assignments/protocol-numbers
TCP and UDP Ports
Table B-7 lists the literal values and port numbers; either can be entered in ASA commands. See the
following caveats:
The ASA uses port 1521 for SQL*Net. This is the default port used by Oracle for SQL*Net. This
value, however, does not agree with IANA port assignments.
The ASA listens for RADIUS on ports 1645 and 1646. If your RADIUS server uses the standard
ports 1812 and 1813, you can configure the ASA to listen to those ports using the
authentication-port and accounting-port commands.
Table B-6 Protocol Literal Values
Literal Value Description
ah 51 Authentication Header for IPv6, RFC 1826.
eigrp 88 Enhanced Interior Gateway Routing Protocol.
esp 50 Encapsulated Security Payload for IPv6, RFC 1827.
gre 47 Generic Routing Encapsulation.
icmp 1 Internet Control Message Protocol, RFC 792.
icmp6 58 Internet Control Message Protocol for IPv6, RFC 2463.
igmp 2 Internet Group Management Protocol, RFC 1112.
igrp 9 Interior Gateway Routing Protocol.
ip 0 Internet Protocol.
ipinip 4 IP-in-IP encapsulation.
ipsec 50 IP Security. Entering the ipsec protocol literal is
equivalent to entering the esp protocol literal.
nos 94 Network Operating System (Novells NetWare).
ospf 89 Open Shortest Path First routing protocol, RFC 1247.
pcp 108 Payload Compression Protocol.
pim 103 Protocol Independent Multicast.
pptp 47 Point-to-Point Tunneling Protocol. Entering the pptp
protocol literal is equivalent to entering the gre protocol
literal.
snp 109 Sitara Networks Protocol.
tcp 6 Transmission Control Protocol, RFC 793.
udp 17 User Datagram Protocol, RFC 768.
B-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
TCP and UDP Ports
To assign a port for DNS access, use the domain literal value, not dns. If you use dns, the ASA
assumes you meant to use the dnsix literal value.
Port numbers can be viewed online at the IANA website:
http://www.iana.org/assignments/port-numbers
Table B-7 Port Literal Values
Literal TCP or UDP? Value Description
aol TCP 5190 America Online
bgp TCP 179 Border Gateway Protocol, RFC 1163
biff UDP 512 Used by mail system to notify users that new mail is
received
bootpc UDP 68 Bootstrap Protocol Client
bootps UDP 67 Bootstrap Protocol Server
chargen TCP 19 Character Generator
citrix-ica TCP 1494 Citrix Independent Computing Architecture (ICA)
protocol
cmd TCP 514 Similar to exec except that cmd has automatic
authentication
ctiqbe TCP 2748 Computer Telephony Interface Quick Buffer
Encoding
daytime TCP 13 Day time, RFC 867
discard TCP, UDP 9 Discard
domain TCP, UDP 53 DNS
dnsix UDP 195 DNSIX Session Management Module Audit
Redirector
echo TCP, UDP 7 Echo
exec TCP 512 Remote process execution
finger TCP 79 Finger
ftp TCP 21 File Transfer Protocol (control port)
ftp-data TCP 20 File Transfer Protocol (data port)
gopher TCP 70 Gopher
https TCP 443 HTTP over SSL
h323 TCP 1720 H.323 call signalling
hostname TCP 101 NIC Host Name Server
ident TCP 113 Ident authentication service
imap4 TCP 143 Internet Message Access Protocol, version 4
irc TCP 194 Internet Relay Chat protocol
isakmp UDP 500 Internet Security Association and Key Management
Protocol
kerberos TCP, UDP 750 Kerberos
B-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
TCP and UDP Ports
klogin TCP 543 KLOGIN
kshell TCP 544 Korn Shell
ldap TCP 389 Lightweight Directory Access Protocol
ldaps TCP 636 Lightweight Directory Access Protocol (SSL)
lpd TCP 515 Line Printer Daemon - printer spooler
login TCP 513 Remote login
lotusnotes TCP 1352 IBM Lotus Notes
mobile-ip UDP 434 MobileIP-Agent
nameserver UDP 42 Host Name Server
netbios-ns UDP 137 NetBIOS Name Service
netbios-dgm UDP 138 NetBIOS Datagram Service
netbios-ssn TCP 139 NetBIOS Session Service
nntp TCP 119 Network News Transfer Protocol
ntp UDP 123 Network Time Protocol
pcanywhere-status UDP 5632 pcAnywhere status
pcanywhere-data TCP 5631 pcAnywhere data
pim-auto-rp TCP, UDP 496 Protocol Independent Multicast, reverse path
flooding, dense mode
pop2 TCP 109 Post Office Protocol - Version 2
pop3 TCP 110 Post Office Protocol - Version 3
pptp TCP 1723 Point-to-Point Tunneling Protocol
radius UDP 1645 Remote Authentication Dial-In User Service
radius-acct UDP 1646 Remote Authentication Dial-In User Service
(accounting)
rip UDP 520 Routing Information Protocol
secureid-udp UDP 5510 SecureID over UDP
smtp TCP 25 Simple Mail Transport Protocol
snmp UDP 161 Simple Network Management Protocol
snmptrap UDP 162 Simple Network Management Protocol - Trap
sqlnet TCP 1521 Structured Query Language Network
ssh TCP 22 Secure Shell
sunrpc (rpc) TCP, UDP 111 Sun Remote Procedure Call
syslog UDP 514 System Log
tacacs TCP, UDP 49 Terminal Access Controller Access Control System
Plus
talk TCP, UDP 517 Talk
telnet TCP 23 RFC 854 Telnet
Table B-7 Port Literal Values (continued)
Literal TCP or UDP? Value Description
B-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
Local Ports and Protocols
Local Ports and Protocols
Table B-8 lists the protocols, TCP ports, and UDP ports that the ASA may open to process traffic
destined to the ASA. Unless you enable the features and services listed in Table B-8, the ASA does not
open any local protocols or any TCP or UDP ports. You must configure a feature or service for the ASA
to open the default listening protocol or port. In many cases you can configure ports other than the
default port when you enable a feature or service.
tftp UDP 69 Trivial File Transfer Protocol
time UDP 37 Time
uucp TCP 540 UNIX-to-UNIX Copy Program
who UDP 513 Who
whois TCP 43 Who Is
www TCP 80 World Wide Web
xdmcp UDP 177 X Display Manager Control Protocol
Table B-7 Port Literal Values (continued)
Literal TCP or UDP? Value Description
Table B-8 Protocols and Ports Opened by Features and Services
Feature or Service Protocol Port Number Comments
DHCP UDP 67,68
Failover Control 105 N/A
HTTP TCP 80
HTTPS TCP 443
ICMP 1 N/A
IGMP 2 N/A Protocol only open on destination IP
address 224.0.0.1
ISAKMP/IKE UDP 500 Configurable.
IPsec (ESP) 50 N/A
IPsec over UDP
(NAT-T)
UDP 4500
IPsec over UDP
(Cisco VPN 3000
Series compatible)
UDP 10000 Configurable.
IPsec over TCP
(CTCP)
TCP No default port is used. You must specify
the port number when configuring IPsec
over TCP.
NTP UDP 123
OSPF 89 N/A Protocol only open on destination IP
address 224.0.0.5 and 224.0.0.6
B-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
ICMP Types
ICMP Types
Table B-9 lists the ICMP type numbers and names that you can enter in ASA commands.
PIM 103 N/A Protocol only open on destination IP
address 224.0.0.13
RIP UDP 520
RIPv2 UDP 520 Port only open on destination IP address
224.0.0.9
SNMP UDP 161 Configurable.
SSH TCP 22
Stateful Update 8 and 9 N/A
Telnet TCP 23
VPN Load Balancing UDP 9023 Configurable.
VPN Individual User
Authentication Proxy
UDP 1645, 1646 Port accessible only over VPN tunnel.
Table B-8 Protocols and Ports Opened by Features and Services (continued)
Feature or Service Protocol Port Number Comments
Table B-9 ICMP Types
ICMP Number ICMP Name
0 echo-reply
3 unreachable
4 source-quench
5 redirect
6 alternate-address
8 echo
9 router-advertisement
10 router-solicitation
11 time-exceeded
12 parameter-problem
13 timestamp-request
14 timestamp-reply
15 information-request
16 information-reply
17 mask-request
18 mask-reply
31 conversion-error
32 mobile-redirect
B-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix B Addresses, Protocols, and Ports
ICMP Types
C-1
Cisco ASA 5500 Series Configuration Guide using the CLI
A P P E N D I X C
Configuring an External Server for Authorization
and Authentication
This appendix describes how to configure an external LDAP, RADIUS, or TACACS+ server to support
AAA on the ASA. Before you configure the ASA to use an external server, you must configure the server
with the correct ASA authorization attributes and, from a subset of these attributes, assign specific
permissions to individual users.
This appendix includes the following sections:
Understanding Policy Enforcement of Permissions and Attributes, page C-1
Configuring an External LDAP Server, page C-2
Configuring an External RADIUS Server, page C-27
RADIUS Accounting Disconnect Reason Codes, page C-37
Understanding Policy Enforcement of Permissions and
Attributes
The ASA supports several methods of applying user authorization attributes (also called user
entitlements or permissions) to VPN connections. You can configure the ASA to obtain user attributes
from a Dynamic Access Policy (DAP) on the ASA, from an external authentication and/or authorization
AAA server (RADIUS or LDAP), from a group policy on the ASA, or from all three.
If the ASA receives attributes from all sources, the attributes are evaluated, merged, and applied to the
user policy. If there are conflicts between attributes coming from the DAP, the AAA server, or the group
policy, those attributes obtained from the DAP always take precedence.
The ASA applies attributes in the following order (see Figure C-1).
1. DAP attributes on the ASAIntroduced in Version 8.0(2), these attributes take precedence over all
others. If you set a bookmark or URL list in DAP, it overrides a bookmark or URL list set in the
group policy.
2. User attributes on the AAA serverThe server returns these attributes after successful user
authentication and/or authorization. Do not confuse these with attributes that are set for individual
users in the local AAA database on the ASA (User Accounts in ASDM).
3. Group policy configured on the ASAIf a RADIUS server returns the value of the RADIUS CLASS
attribute IETF-Class-25 (OU=group-policy) for the user, the ASA places the user in the group policy
of the same name and enforces any attributes in the group policy that are not returned by the server.
C-2
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
For LDAP servers, any attribute name can be used to set the group policy for the session. The LDAP
attribute map that you configure on the ASA maps the LDAP attribute to the Cisco attribute
IETF-Radius-Class.
4. Group policy assigned by the Connection Profile (called tunnel-group in the CLI)The Connection
Profile has the preliminary settings for the connection, and includes a default group policy applied
to the user before authentication. All users connecting to the ASA initially belong to this group,
which provides any attributes that are missing from the DAP, user attributes returned by the server,
or the group policy assigned to the user.
5. Default group policy assigned by the ASA (DfltGrpPolicy)System default attributes provide any
values that are missing from the DAP, user attributes, group policy, or connection profile.
Figure C-1 Policy Enforcement Flow
Configuring an External LDAP Server
The VPN 3000 concentrator and the ASA/PIX 7.0 software required a Cisco LDAP schema for
authorization operations. Beginning with Version 7.1.x, the ASA performs authentication and
authorization using the native LDAP schema, and the Cisco schema is no longer needed.
You configure authorization (permission policy) using an LDAP attribute map. For examples, see the
Active Directory/LDAP VPN Remote Access Authorization Examples section on page C-16.
This section describes the structure, schema, and attributes of an LDAP server and includes the following
topics:
Organizing the ASA for LDAP Operations, page C-3
Defining the ASA LDAP Configuration, page C-5
Active Directory/LDAP VPN Remote Access Authorization Examples, page C-16
The specific steps of these processes vary, depending on which type of LDAP server that you are using.
C-3
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Note For more information about the LDAP protocol, see RFCs 1777, 2251, and 2849.
Organizing the ASA for LDAP Operations
This section describes how to search within the LDAP hierarchy and perform authenticated binding to
the LDAP server on the ASA and includes the following topics:
Searching the LDAP Hierarchy, page C-3
Binding the ASA to the LDAP Server, page C-4
Your LDAP configuration should reflect the logical hierarchy of your organization. For example,
suppose an employee at your company, Example Corporation, is named Employee1. Employee1 works
in the Engineering group. Your LDAP hierarchy could have one or many levels. You might decide to set
up a single-level hierarchy in which Employee1 is considered a member of Example Corporation. Or you
could set up a multi-level hierarchy in which Employee1 is considered to be a member of the department
Engineering, which is a member of an organizational unit called People, which is itself a member of
Example Corporation. See Figure C-2 for an example of a multi-level hierarchy.
A multi-level hierarchy has more detail, but searches return results more quickly in a single-level
hierarchy.
Figure C-2 A Multi-Level LDAP Hierarchy
Searching the LDAP Hierarchy
The ASA lets you tailor the search within the LDAP hierarchy. You configure the following three fields
on the ASA to define where in the LDAP hierarchy that your search begins, the extent, and the type of
information it is looking for. Together these fields allow you to limit the search of the hierarchy to only
the part that includes the user permissions.
LDAP Base DN defines where in the LDAP hierarchy that the server should begin searching for user
information when it receives an authorization request from the ASA.
3
3
0
3
6
8
Enterprise LDAP Hierarchy
dc=ExampleCorp, dc=com Root/Top
People Equipment OU=Organization Units
Engineering Marketing HR Groups/Departments
cn=User1 cn=User3 cn=User4 Users cn=User2
C-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Search Scope defines the extent of the search in the LDAP hierarchy. The search proceeds this many
levels in the hierarchy below the LDAP Base DN. You can choose to have the server search only the
level immediately below it, or it can search the entire subtree. A single level search is quicker, but
a subtree search is more extensive.
Naming Attribute(s) defines the RDN that uniquely identifies an entry in the LDAP server. Common
naming attributes can include cn (Common Name), sAMAccountName, and userPrincipalName.
Figure C-2 shows a sample LDAP hierarchy for Example Corporation. Given this hierarchy, you could
define your search in different ways. Table C-1 shows two sample search configurations.
In the first example configuration, when Employee1 establishes the IPsec tunnel with LDAP
authorization required, the ASA sends a search request to the LDAP server, indicating it should search
for Employee1 in the Engineering group. This search is quick.
In the second example configuration, the ASA sends a search request indicating that the server should
search for Employee1 within Example Corporation. This search takes longer.
Binding the ASA to the LDAP Server
Some LDAP servers (including the Microsoft Active Directory server) require the ASA to establish a
handshake via authenticated binding before they accept requests for any other LDAP operations. The
ASA uses the Login Distinguished Name (DN) and Login Password to establish a trust relationship
(bind) with an LDAP server before a user can search. The Login DN represents a user record in the LDAP
server that the administrator uses for binding.
When binding, the ASA authenticates to the server using the Login DN and the Login Password. When
performing a Microsoft Active Directory read-only operation (such as for authentication, authorization,
or group search), the ASA can bind with a Login DN with fewer privileges. For example, the Login DN
can be a user whose AD Member Of designation is part of Domain Users. For VPN password
management write operations, the Login DN needs elevated privileges and must be part of the Account
Operators AD group. Microsoft Active Directory group search (also called MemberOf retrieval) was
added in ASA Version 8.0.4.
An example of a Login DN includes the following entries:
cn=Binduser1,ou=Admins,ou=Users,dc=company_A,dc=com
See your LDAP Administrator guide for specific Login DN requirements for read and write operations.
The ASA supports the following features:
Simple LDAP authentication with an unencrypted password using the default port 389 . You can also
use other ports instead of the default port.
Secure LDAP (LDAP-S) using the default port 636. You can also use other ports instead of the
default port.
Simple Authentication and Security Layer (SASL) MD5
SASL Kerberos
The ASA does not support anonymous authentication.
Table C-1 Example Search Configurations
No. LDAP Base DN
Search
Scope
Naming
Attribute Result
1 group= Engineering,ou=People,dc=ExampleCorporation, dc=com One Level cn=Employee1 Quicker search
2 dc=ExampleCorporation,dc=com Subtree cn=Employee1 Longer search
C-5
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Note As an LDAP client, the ASA does not support the transmission of anonymous binds or requests.
Defining the ASA LDAP Configuration
This section describes how to define the LDAP AV-pair attribute syntax and includes the following
topics:
Supported Cisco Attributes for LDAP Authorization, page C-5
Cisco AV Pair Attribute Syntax, page C-13
Cisco AV Pairs ACL Examples, page C-14
Note The ASA enforces the LDAP attributes based on attribute name, not numeric ID. RADIUS attributes, on
the other hand, are enforced by numeric ID, not by name.
Authorization refers to the process of enforcing permissions or attributes. An LDAP server defined as
an authentication or authorization server enforces permissions or attributes if they are configured.
For software Version 7.0, LDAP attributes include the cVPN3000 prefix. For software Versions 7.1 and
later, this prefix was removed.
Supported Cisco Attributes for LDAP Authorization
This section provides a complete list of attributes (see Table C-2) for the ASA 5500, VPN 3000
concentrator, and PIX 500 series ASAs. The table includes attribute support information for the VPN
3000 concentrator and PIX 500 series ASAs to assist you in configuring networks with a combination
of these devices.
C-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Table C-2 ASA Supported Cisco Attributes for LDAP Authorization
Attribute Name VPN 3000 ASA PIX
Syntax/
Type
Single or
Multi-Valued Possible Values
Access-Hours Y Y Y String Single Name of the time-range
(for example, Business-Hours)
Allow-Network-Extension- Mode Y Y Y Boolean Single 0 = Disabled
1 = Enabled
Authenticated-User-Idle- Timeout Y Y Y Integer Single 1 - 35791394 minutes
Authorization-Required Y Integer Single 0 = No
1 = Yes
Authorization-Type Y Integer Single 0 = None
1 = RADIUS
2 = LDAP
Banner1 Y Y Y String Single Banner string for clientless and
client SSL VPN, and IPsec clients.
Banner2 Y Y Y String Single Banner string for clientless and
client SSL VPN, and IPsec clients.
Cisco-AV-Pair Y Y Y String Multi An octet string in the following
format:
[Prefix] [Action] [Protocol]
[Source] [Source Wildcard Mask]
[Destination] [Destination Wildcard
Mask] [Established] [Log]
[Operator] [Port]
For more information, see the
Cisco AV Pair Attribute Syntax
section on page C-13.
Cisco-IP-Phone-Bypass Y Y Y Integer Single 0 = Disabled
1 = Enabled
Cisco-LEAP-Bypass Y Y Y Integer Single 0 = Disabled
1 = Enabled
Client-Intercept-DHCP-
Configure-Msg
Y Y Y Boolean Single 0 = Disabled
1 = Enabled
Client-Type-Version-Limiting Y Y Y String Single IPsec VPN client version number
string
Confidence-Interval Y Y Y Integer Single 10 - 300 seconds
DHCP-Network-Scope Y Y Y String Single IP address
DN-Field Y Y Y String Single Possible values: UID, OU, O, CN,
L, SP, C, EA, T, N, GN, SN, I,
GENQ, DNQ, SER, and
use-entire-name.
Firewall-ACL-In Y Y String Single Access list ID
Firewall-ACL-Out Y Y String Single Access list ID
C-7
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Group-Policy Y Y String Single Sets the group policy for the remote
access VPN session. For version 8.2
and later, use this attribute instead of
IETF-Radius-Class. You can use
one of the three following formats:
group policy name
OU=group policy name
OU=group policy name:
IE-Proxy-Bypass-Local Boolean Single 0=Disabled
1=Enabled
IE-Proxy-Exception-List String Single A list of DNS domains. Entries must
be separated by the new line
character sequence (\n).
IE-Proxy-Method Y Y Y Integer Single 1 = Do not modify proxy settings
2 = Do not use proxy
3 = Auto detect
4 = Use ASA setting
IE-Proxy-Server Y Y Y Integer Single IP address
IETF-Radius-Class Y Y Y Single Sets the group policy for the remote
access VPN session. For versions
8.2 and later, we recommend that
you use the Group-Policy attribute.
You can use one of the three
following formats:
group policy name
OU=group policy name
OU=group policy name:
IETF-Radius-Filter-Id Y Y Y String Single Access list name that is defined on
the ASA. The setting applies to
VPN remote access IPsec and SSL
VPN clients.
IETF-Radius-Framed-IP-Address Y Y Y String Single An IP address. The setting applies to
VPN remote access IPsec and SSL
VPN clients.
IETF-Radius-Framed-IP-Netmask Y Y Y String Single An IP address mask. The setting
applies to VPN remote access IPsec
and SSL VPN clients.
IETF-Radius-Idle-Timeout Y Y Y Integer Single Seconds
Table C-2 ASA Supported Cisco Attributes for LDAP Authorization (continued)
Attribute Name VPN 3000 ASA PIX
Syntax/
Type
Single or
Multi-Valued Possible Values
C-8
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
IETF-Radius-Service-Type Y Y Y Integer Single 1 = Login
2 = Framed
5 = Remote access
6 = Administrative
7 = NAS prompt
IETF-Radius-Session-Timeout Y Y Y Integer Single Seconds
IKE-Keep-Alives Y Y Y Boolean Single 0 = Disabled
1 = Enabled
IPsec-Allow-Passwd-Store Y Y Y Boolean Single 0 = Disabled
1 = Enabled
IPsec-Authentication Y Y Y Integer Single 0 = None
1 = RADIUS
2 = LDAP (authorization only)
3 = NT Domain
4 = SDI (RSA)
5 = Internal
6 = RADIUS with Expiry
7 = Kerberos or Active Directory
IPsec-Auth-On-Rekey Y Y Y Boolean Single 0 = Disabled
1 = Enabled
IPsec-Backup-Server-List Y Y Y String Single Server addresses (space delimited)
IPsec-Backup-Servers Y Y Y String Single 1 = Use client-configured list
2 = Disabled and clear client list
3 = Use backup server list
IPsec-Client-Firewall-Filter- Name Y String Single Specifies the name of the filter to be
pushed to the client as firewall
policy.
IPsec-Client-Firewall-Filter-
Optional
Y Y Y Integer Single 0 = Required
1 = Optional
IPsec-Default-Domain Y Y Y String Single Specifies the single default domain
name to send to the client (1 - 255
characters).
IPsec-Extended-Auth-On-Rekey Y Y String Single String
IPsec-IKE-Peer-ID-Check Y Y Y Integer Single 1 = Required
2 = If supported by peer certificate
3 = Do not check
IPsec-IP-Compression Y Y Y Integer Single 0 = Disabled
1 = Enabled
IPsec-Mode-Config Y Y Y Boolean Single 0 = Disabled
1 = Enabled
IPsec-Over-UDP Y Y Y Boolean Single 0 = Disabled
1 = Enabled
Table C-2 ASA Supported Cisco Attributes for LDAP Authorization (continued)
Attribute Name VPN 3000 ASA PIX
Syntax/
Type
Single or
Multi-Valued Possible Values
C-9
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
IPsec-Over-UDP-Port Y Y Y Integer Single 4001 - 49151; The default is 10000.
IPsec-Required-Client-Firewall-
Capability
Y Y Y Integer Single 0 = None
1 = Policy defined by remote FW
Are-You-There (AYT)
2 = Policy pushed CPP
4 = Policy from server
IPsec-Sec-Association Y String Single Name of the security association
IPsec-Split-DNS-Names Y Y Y String Single Specifies the list of secondary
domain names to send to the client
(1 - 255 characters).
IPsec-Split-Tunneling-Policy Y Y Y Integer Single 0 = Tunnel everything
1 = Split tunneling
2 = Local LAN permitted
IPsec-Split-Tunnel-List Y Y Y String Single Specifies the name of the network or
access list that describes the split
tunnel inclusion list.
IPsec-Tunnel-Type Y Y Y Integer Single 1 = LAN-to-LAN
2 = Remote access
IPsec-User-Group-Lock Y Boolean Single 0 = Disabled
1 = Enabled
L2TP-Encryption Y Integer Single Bitmap:
1 = Encryption required
2 = 40 bit
4 = 128 bits
8 = Stateless-Req
15 = 40/128-Encr/Stateless-Req
L2TP-MPPC-Compression Y Integer Single 0 = Disabled
1 = Enabled
MS-Client-Subnet-Mask Y Y Y String Single An IP address
PFS-Required Y Y Y Boolean Single 0 = No
1 = Yes
Port-Forwarding-Name Y Y String Single Name string (for example,
Corporate-Apps)
PPTP-Encryption Y Integer Single Bitmap:
1 = Encryption required
2 = 40 bits
4 = 128 bits
8 = Stateless-Required
Example:
15 = 40/128-Encr/Stateless-Req
PPTP-MPPC-Compression Y Integer Single 0 = Disabled
1 = Enabled
Table C-2 ASA Supported Cisco Attributes for LDAP Authorization (continued)
Attribute Name VPN 3000 ASA PIX
Syntax/
Type
Single or
Multi-Valued Possible Values
C-10
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Primary-DNS Y Y Y String Single An IP address
Primary-WINS Y Y Y String Single An IP address
Privilege-Level Integer Single For usernames, 0 - 15
Required-Client-
Firewall-Vendor-Code
Y Y Y Integer Single 1 = Cisco Systems (with Cisco
Integrated Client)
2 = Zone Labs
3 = NetworkICE
4 = Sygate
5 = Cisco Systems (with Cisco
Intrusion Prevention Security
Agent)
Required-Client-Firewall-
Description
Y Y Y String Single
Required-Client-Firewall-
Product-Code
Y Y Y Integer Single Cisco Systems Products:
1 = Cisco Intrusion Prevention
Security Agent or Cisco Integrated
Client (CIC)
Zone Labs Products:
1 = Zone Alarm
2 = Zone AlarmPro
3 = Zone Labs Integrity
NetworkICE Product:
1 = BlackIce Defender/Agent
Sygate Products:
1 = Personal Firewall
2 = Personal Firewall Pro
3 = Security Agent
Require-HW-Client-Auth Y Y Y Boolean Single 0 = Disabled
1 = Enabled
Require-Individual-User-Auth Y Y Y Integer Single 0 = Disabled
1 = Enabled
Secondary-DNS Y Y Y String Single An IP address
Secondary-WINS Y Y Y String Single An IP address
SEP-Card-Assignment Integer Single Not used
Simultaneous-Logins Y Y Y Integer Single 0 - 2147483647
Strip-Realm Y Y Y Boolean Single 0 = Disabled
1 = Enabled
TACACS-Authtype Y Y Y Interger Single
TACACS-Privilege-Level Y Y Y Interger Single
Tunnel-Group-Lock Y Y String Single Name of the tunnel group or none
Table C-2 ASA Supported Cisco Attributes for LDAP Authorization (continued)
Attribute Name VPN 3000 ASA PIX
Syntax/
Type
Single or
Multi-Valued Possible Values
C-11
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Tunneling-Protocols Y Y Y Integer Single 1 = PPTP
2 = L2TP
4 = IPSec (IKEv1)
8 = L2TP/IPSec
16 = WebVPN
32 = SVC
64 = IPsec (IKEv2)
8 and 4 are mutually exclusive
(0 - 11, 16 - 27, 32 - 43, 48 - 59 are
legal values).
Use-Client-Address Y Boolean Single 0 = Disabled
1 = Enabled
User-Auth-Server-Name Y String Single IP address or hostname
User-Auth-Server-Port Y Integer Single Port number for server protocol
User-Auth-Server-Secret Y String Single Server password
WebVPN-ACL-Filters Y String Single Webtype access list name
WebVPN-Apply-ACL-Enable Y Y Integer Single 0 = Disabled
1 = Enabled
With Version 8.0 and later, this
attribute is not required.
WebVPN-Citrix-Support-Enable Y Y Integer Single 0 = Disabled
1 = Enabled
With Versions 8.0 and later, this
attribute is not required.
WebVPN-Enable-functions Integer Single Not used - deprecated
WebVPN-Exchange-Server-
Address
String Single Not used - deprecated
WebVPN-Exchange-Server-
NETBIOS-Name
String Single Not used - deprecated
WebVPN-File-Access-Enable Y Y Integer Single 0 = Disabled
1 = Enabled
WebVPN-File-Server-Browsing-
Enable
Y Y Integer Single 0 = Disabled
1 = Enabled
WebVPN-File-Server-Entry-
Enable
Y Y Integer Single 0 = Disabled
1 = Enabled
WebVPN-Forwarded-Ports Y String Single Port-forward list name
WebVPN-Homepage Y Y String Single A URL such as
http://www.example.com
Table C-2 ASA Supported Cisco Attributes for LDAP Authorization (continued)
Attribute Name VPN 3000 ASA PIX
Syntax/
Type
Single or
Multi-Valued Possible Values
C-12
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
WebVPN-Macro-Substitution-
Value1
Y Y String Single See the SSL VPN Deployment Guide
for examples at the following URL:
http://supportwiki.cisco.com/View
Wiki/index.php/Cisco_ASA_5500_
SSL_VPN_Deployment_Guide%2
C_Version_8.x
WebVPN-Macro-Substitution-
Value2
Y Y String Single See the SSL VPN Deployment Guide
for examples at the following URL:
http://supportwiki.cisco.com/View
Wiki/index.php/Cisco_ASA_5500_
SSL_VPN_Deployment_Guide%2
C_Version_8.x
WebVPN-Port-Forwarding-
Auto-Download-Enable
Y Y Integer Single 0 = Disabled
1 = Enabled
WebVPN-Port-Forwarding- Enable Y Y Integer Single 0 = Disabled
1 = Enabled
WebVPN-Port-Forwarding-
Exchange-Proxy-Enable
Y Y Integer Single 0 = Disabled
1 = Enabled
WebVPN-Port-Forwarding-
HTTP-Proxy-Enable
Y Y Integer Single 0 = Disabled
1 = Enabled
WebVPN-Single-Sign-On-
Server-Name
Y String Single Name of the SSO Server (1 - 31
characters).
WebVPN-SVC-Client-DPD Y Y Integer Single 0 = Disabled
n = Dead peer detection value in
seconds (30 - 3600)
WebVPN-SVC-Compression Y Y Integer Single 0 = None
1 = Deflate compression
WebVPN-SVC-Enable Y Y Integer Single 0 = Disabled
1 = Enabled
WebVPN-SVC-Gateway-DPD Y Y Integer Single 0 = Disabled
n = Dead peer detection value in
seconds (30 - 3600)
WebVPN-SVC-Keepalive Y Y Integer Single 0 = Disabled
n = Keepalive value in seconds (15 -
600)
WebVPN-SVC-Keep-Enable Y Y Integer Single 0 = Disabled
1 = Enabled
WebVPN-SVC-Rekey-Method Y Y Integer Single 0 = None
1 = SSL
2 = New tunnel
3 = Any (sets to SSL)
Table C-2 ASA Supported Cisco Attributes for LDAP Authorization (continued)
Attribute Name VPN 3000 ASA PIX
Syntax/
Type
Single or
Multi-Valued Possible Values
C-13
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Cisco AV Pair Attribute Syntax
The Cisco Attribute Value (AV) pair (ID Number 26/9/1) can be used to enforce access lists from a
RADIUS server (like Cisco ACS), or from an LDAP server via an LDAP attribute map.
The syntax of each Cisco-AV-Pair rule is as follows:
[Prefix] [Action] [Protocol] [Source] [Source Wildcard Mask] [Destination] [Destination Wildcard
Mask] [Established] [Log] [Operator] [Port]
Table C-3 describes the syntax rules.
WebVPN-SVC-Rekey-Period Y Y Integer Single 0 = Disabled
n = Retry period in minutes
(4 - 10080)
WebVPN-SVC-Required-Enable Y Y Integer Single 0 = Disabled
1 = Enabled
WebVPN-URL-Entry-Enable Y Y Integer Single 0 = Disabled
1 = Enabled
WebVPN-URL-List Y String Single URL list name
Table C-2 ASA Supported Cisco Attributes for LDAP Authorization (continued)
Attribute Name VPN 3000 ASA PIX
Syntax/
Type
Single or
Multi-Valued Possible Values
Table C-3 AV-Pair Attribute Syntax Rules
Field Description
Action Action to perform if the rule matches a deny or a permit.
Destination Network or host that receives the packet. Specify it as an IP address, a
hostname, or the any keyword. If using an IP address, the source wildcard
mask must follow.
Destination Wildcard
Mask
The wildcard mask that applies to the destination address.
Log Generates a FILTER log message. You must use this keyword to generate
events of severity level 9.
Operator Logic operators: greater than, less than, equal to, not equal to.
Port The number of a TCP or UDP port in the range of 0 - 65535.
Prefix A unique identifier for the AV pair (for example: ip:inacl#1= for standard
access lists or webvpn:inacl# = for clientless SSL VPN access lists). This
field only appears when the filter has been sent as an AV pair.
Protocol Number or name of an IP protocol. Either an integer in the range of 0 - 255
or one of the following keywords: icmp, igmp, ip, tcp, udp.
C-14
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Cisco AV Pairs ACL Examples
Table C-4 shows examples of Cisco AV pairs and describes the permit or deny actions that result.
Note Each ACL # in inacl# must be unique. However, they do not need to be sequential (for example, 1, 2, 3,
4). That is, they could be 5, 45, 135.
URL Types Supported in ACLs
The URL may be a partial URL, contain wildcards for the server, or include a port.
Source Network or host that sends the packet. Specify it as an IP address, a
hostname, or the any keyword. If using an IP address, the source wildcard
mask must follow. This field does not apply to Clientless SSL VPN because
the ASA has the role of the source or proxy.
Source Wildcard Mask The wildcard mask that applies to the source address. This field does not
apply to Clientless SSL VPN because the ASA has the role of the source or
proxy.
Table C-3 AV-Pair Attribute Syntax Rules (continued)
Field Description
Table C-4 Examples of Cisco AV Pairs and Their Permitting or Denying Action
Cisco AV Pair Example Permitting or Denying Action
ip:inacl#1=deny ip 10.155.10.0 0.0.0.255
10.159.2.0 0.0.0.255 log
Allows IP traffic between the two hosts using a full
tunnel IPsec or SSL VPN client.
ip:inacl#2=permit TCP any host
10.160.0.1 eq 80 log
Allows TCP traffic from all hosts to the specific host
on port 80 only using a full tunnel IPsec or SSL VPN
client.
webvpn:inacl#1=permit url
http://www.example.com
webvpn:inacl#2=deny url smtp://server
webvpn:inacl#3=permit url
cifs://server/share
Allows clientlessSSL VPN traffic to the URL
specified, denies SMTP traffic to a specific server,
and allows file share access (CIFS) to the specified
server.
webvpn:inacl#1=permit tcp 10.86.1.2 eq
2222 log
webvpn:inacl#2=deny tcp 10.86.1.2 eq
2323 log
Denies Telnet access and permits SSH access on
non-default ports 2323 and 2222, respectively, or
other application traffic flows using these ports for
clientless SSL VPN.
webvpn:inacl#1=permit url
ssh://10.86.1.2
webvpn:inacl#35=permit tcp 10.86.1.5 eq
22 log
webvpn:inacl#48=deny url
telnet://10.86.1.2
webvpn:inacl#100=deny tcp 10.86.1.6 eq
23
Allows clientless SSL VPN SSH access to default
port 22 and denies Telnet access to port 23,
respectively. This example assumes that you are using
Telnet or SSH Java plug-ins enforced by these ACLs.
C-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
The following URL types are supported.
Note The URLs listed in this table appear in CLI or ASDM menus based on whether or not the
associated plug-in is enabled.
Guidelines for Using Cisco-AV Pairs (ACLs)
Use Cisco-AV pair entries with the ip:inacl# prefix to enforce access lists for remote IPsec and SSL
VPN Client (SVC) tunnels.
Use Cisco-AV pair entries with the webvpn:inacl# prefix to enforce access lists for SSL VPN
clientless (browser-mode) tunnels.
For webtype ACLs, you do not specify the source because the ASA is the source.
Table C-5 lists the tokens for the Cisco-AV-pair attribute:
any All URLs https:// post:// ssh://
cifs:// ica:// rdp:// telnet://
citrix:// imap4:// rdp2:// vnc://
citrixs:// ftp:// smart-tunnel://
http:// pop3:// smtp://
Table C-5 ASA-Supported Tokens
Token Syntax Field Description
ip:inacl#Num= N/A (Identifier) (Where Num is a unique integer.) Starts all AV pair access control lists. Enforces
access lists for remote IPsec and SSL VPN (SVC) tunnels.
webvpn:inacl#Num= N/A (Identifier) (Where Num is a unique integer.) Starts all clientless SSL AV pair access control
lists. Enforces access lists for clientless (browser-mode) tunnels.
deny Action Denies action. (Default)
permit Action Allows action.
icmp Protocol Internet Control Message Protocol (ICMP)
1 Protocol Internet Control Message Protocol (ICMP)
IP Protocol Internet Protocol (IP)
0 Protocol Internet Protocol (IP)
TCP Protocol Transmission Control Protocol (TCP)
6 Protocol Transmission Control Protocol (TCP)
UDP Protocol User Datagram Protocol (UDP)
17 Protocol User Datagram Protocol (UDP)
any Hostname Rule applies to any host.
host Hostname Any alpha-numeric string that denotes a hostname.
log Log When the event occurs, a filter log message appears. (Same as permit and log or
deny and log.)
lt Operator Less than value
C-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Active Directory/LDAP VPN Remote Access Authorization Examples
This section presents example procedures for configuring authentication and authorization on the ASA
using the Microsoft Active Directory server. It includes the following topics:
User-Based Attributes Policy Enforcement, page C-16
Placing LDAP Users in a Specific Group Policy, page C-18
Enforcing Static IP Address Assignment for AnyConnect Tunnels, page C-20
Enforcing Dial-in Allow or Deny Access, page C-22
Enforcing Logon Hours and Time-of-Day Rules, page C-25
Other configuration examples available on Cisco.com include the following TechNotes.
ASA/PIX: Mapping VPN Clients to VPN Group Policies Through LDAP Configuration Example at
the following URL:
http://www.cisco.com/en/US/products/ps6120/products_configuration_example09186a008089149
d.shtml
PIX/ASA 8.0: Use LDAP Authentication to Assign a Group Policy at Login at the following URL:
http://www.cisco.com/en/US/partner/products/ps6120/products_configuration_example09186a008
08d1a7c.shtml
User-Based Attributes Policy Enforcement
You can map any standard LDAP attribute to a well-known Vendor-Specific Attribute (VSA) as well as
map one or more LDAP attribute(s) to one or more Cisco LDAP attributes.
The following example shows how to configure the ASA to enforce a simple banner for a user configured
on an AD LDAP server. On the server, use the Office field in the General tab to enter the banner text.
This field uses the attribute named physicalDeliveryOfficeName. On the ASA, create an attribute map
that maps physicalDeliveryOfficeName to the Cisco attribute Banner1. During authentication, the ASA
retrieves the value of physicalDeliveryOfficeName from the server, maps the value to the Cisco attribute
Banner1, and displays the banner to the user.
This example applies to any connection type, including the IPsec VPN client, AnyConnect SSL VPN
client, or clientless SSL VPN. In the example, User1 connects through a clientless SSL VPN connection.
To configure the attributes for a user on the AD or LDAP Server, perform the following steps:
Step 1 Right-click a user.
The Properties dialog box appears (see Figure C-3).
gt Operator Greater than value
eq Operator Equal to value
neq Operator Not equal to value
range Operator Inclusive range. Should be followed by two values.
Table C-5 ASA-Supported Tokens (continued)
Token Syntax Field Description
C-17
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Step 2 Click the General tab and enter banner text in the Office field, which uses the AD/LDAP attribute
physicalDeliveryOfficeName.
Figure C-3 LDAP User Configuration
Step 3 Create an LDAP attribute map on the ASA.
The following example creates the map Banner and maps the AD/LDAP attribute
physicalDeliveryOfficeName to the Cisco attribute Banner1:
hostname(config)# ldap attribute-map Banner
hostname(config-ldap-attribute-map)# map-name physicalDeliveryOfficeName Banner1
Step 4 Associate the LDAP attribute map to the AAA server.
The following example enters the aaa server host configuration mode for the host 10.1.1.2 in the AAA
server group MS_LDAP, and associates the attribute map Banner that you created in Step 3:
hostname(config)# aaa-server MS_LDAP host 10.1.1.2
hostname(config-aaa-server-host)# ldap-attribute-map Banner
Step 5 Test the banner enforcement.
The following example shows a clientless SSL connection and the banner enforced through the attribute
map after the user authenticates (see Figure C-4).
C-18
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Figure C-4 Banner Displayed
Placing LDAP Users in a Specific Group Policy
The following example shows how to authenticate User1 on the AD LDAP server to a specific group
policy on the ASA. On the server, use the Department field of the Organization tab to enter the name of
the group policy. Then create an attribute map and map Department to the Cisco attribute
IETF-Radius-Class. During authentication, the ASA retrieves the value of Department from the server,
maps the value to the IETF-Radius-Class, and places User1 in the group policy.
This example applies to any connection type, including the IPsec VPN client, AnyConnect SSL VPN
client, or clientless SSL VPN. In this example, User1 is connecting through a clientless SSL VPN
connection.
To configure the attributes for the user on the AD LDAP server, perform the following steps:
Step 1 Right-click the user.
The Properties dialog box appears (see Figure C-5).
Step 2 Click the Organization tab and enter Group-Policy-1 in the Department field.
C-19
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Figure C-5 AD/LDAP Department Attribute
Step 3 Define an attribute map for the LDAP configuration shown in Step 1.
The following example shows how to map the AD attribute Department to the Cisco attribute
IETF-Radius-Class.
hostname(config)# ldap attribute-map group_policy
hostname(config-ldap-attribute-map)# map-name Department IETF-Radius-Class
Step 4 Associate the LDAP attribute map to the AAA server.
The following example enters the aaa server host configuration mode for the host 10.1.1.2 in the AAA
server group MS_LDAP, and associates the attribute map group_policy that you created in Step 3:
hostname(config)# aaa-server MS_LDAP host 10.1.1.2
hostname(config-aaa-server-host)# ldap-attribute-map group_policy
Step 5 Add the new group-policy on the ASA and configure the required policy attributes that will be assigned
to the user. The following example creates Group-policy-1, the name entered in the Department field on
the server:
hostname(config)# group-policy Group-policy-1 external server-group LDAP_demo
hostname(config-aaa-server-group)#
Step 6 Establish the VPN connection as the user would, and verify that the session inherits the attributes from
Group-Policy1 (and any other applicable attributes from the default group-policy).
Step 7 Monitor the communication between the ASA and the server by enabling the debug ldap 255 command
from privileged EXEC mode. The following is sample output from this command, which has been edited
to provide the key messages:
[29] Authentication successful for user1 to 10.1.1.2
[29] Retrieving user attributes from server 10.1.1.2
C-20
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
[29] Retrieved Attributes:
[29] department: value = Group-Policy-1
[29] mapped to IETF-Radius-Class: value = Group-Policy-1
Enforcing Static IP Address Assignment for AnyConnect Tunnels
In this example, configure the AnyConnect client user Web1 to receive a static IP address. then enter the
address in the Assign Static IP Address field of the Dialin tab on the AD LDAP server. This field uses
the msRADIUSFramedIPAddress attribute. Create an attribute map that maps this attribute to the Cisco
attribute IETF-Radius-Framed-IP-Address.
During authentication, the ASA retrieves the value of msRADIUSFramedIPAddress from the server,
maps the value to the Cisco attribute IETF-Radius-Framed-IP-Address, and provides the static address
to User1.
The following example applies to full-tunnel clients, including the IPsec client and the SSL VPN clients
(AnyConnect client 2.x and the SSL VPN client).
To configure the user attributes on the AD/LDAP server, perform the following steps:
Step 1 Right-click the username.
The Properties dialog box appears (see Figure C-6).
Step 2 Click the Dialin tab, check the Assign Static IP Address check box, and enter an IP address of 10.1.1.2.
Figure C-6 Assign Static IP Address
Step 3 Create an attribute map for the LDAP configuration shown in Step 1.
C-21
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
The following example shows how to map the AD attribute msRADIUSFramedIPAddress used by the
Static Address field to the Cisco attribute IETF-Radius-Framed-IP-Address:
hostname(config)# ldap attribute-map static_address
hostname(config-ldap-attribute-map)# map-name msRADIUSFramedIPAddress
IETF-Radius-Framed-IP-Address
Step 4 Associate the LDAP attribute map to the AAA server.
The following example enters the aaa server host configuration mode for the host 10.1.1.2, in the AAA
server group MS_LDAP, and associates the attribute map static_address that you created in Step 3:
hostname(config)# aaa-server MS_LDAP host 10.1.1.2
hostname(config-aaa-server-host)# ldap-attribute-map static_address
Step 5 Verify that the vpn-address-assignment command is configured to specify AAA by viewing this part of
the configuration with the show run all vpn-addr-assign command:
hostname(config)# show run all vpn-addr-assign
vpn-addr-assign aaa << Make sure this is configured >>
no vpn-addr-assign dhcp
vpn-addr-assign local
hostname(config)#
Step 6 Establish a connection to the ASA with the AnyConnect client. Observe the following:
The banner is received in the same sequence as a clientless connection (see Figure C-7).
The user receives the IP address configured on the server and mapped to the ASA (see Figure C-8).
Figure C-7 Verify the Banner for the AnyConnect Session
C-22
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Figure C-8 AnyConnect Session Established
Step 7 Use the show vpn-sessiondb svc command to view the session details and verify the address assigned:
hostname# show vpn-sessiondb svc
Session Type: SVC
Username : web1 Index : 31
Assigned IP : 10.1.1.2 Public IP : 10.86.181.70
Protocol : Clientless SSL-Tunnel DTLS-Tunnel
Encryption : RC4 AES128 Hashing : SHA1
Bytes Tx : 304140 Bytes Rx : 470506
Group Policy : VPN_User_Group Tunnel Group : Group1_TunnelGroup
Login Time : 11:13:05 UTC Tue Aug 28 2007
Duration : 0h:01m:48s
NAC Result : Unknown
VLAN Mapping : N/A VLAN : none
Enforcing Dial-in Allow or Deny Access
The following example creates an LDAP attribute map that specifies the tunneling protocols allowed by
the user. You map the allow access and deny access settings on the Dialin tab to the Cisco attribute
Tunneling-Protocol, which supports the bitmap values shown in Table C-6:
Table C-6 Bitmap Values for Cisco Tunneling-Protocol Attribute
Value Tunneling Protocol
1 PPTP
2 L2TP
4
1
IPsec (IKEv1)
8
2
L2TP/IPsec
C-23
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Use this attribute to create an Allow Access (TRUE) or a Deny Access (FALSE) condition for the
protocols and enforce the method for which the user is allowed access.
For this simplified example, by mapping the tunnel protocol IPsec/IKEv1 (4), you can create an allow
(true) condition for the Cisco VPN client. You also map WebVPN (16) and SVC/AC (32), which are
mapped as a value of 48 (16+32) and create a deny (false) condition. This allows the user to connect to
the ASA using IPsec, but any attempt to connect using clientless SSL or the AnyConnect client is denied.
Another example of enforcing dial-in allow access or deny access is available in the Tech Note ASA/PIX:
Mapping VPN Clients to VPN Group Policies Through LDAP Configuration Example at the following
URL:
http://www.cisco.com/en/US/products/ps6120/products_configuration_example09186a008089149d.sht
ml
To configure the user attributes on the AD/LDAP server, perform the following steps:
Step 1 Right-click the user.
The Properties dialog box appears.
Step 2 Click the Dial-in tab, then click the Allow Access radio button (Figure C-9).
Figure C-9 AD/LDAP User1 - Allow Access
16 Clientless SSL
32 SSL clientAnyConnect or SSL VPN client
64 IPsec (IKEv2)
1. IPsec and L2TP over IPsec are not supported simultaneously. Therefore, the values
4 and 8 are mutually exclusive.
2. See note 1.
Table C-6 Bitmap Values for Cisco Tunneling-Protocol Attribute (continued)
Value Tunneling Protocol
C-24
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Note If you select the Control access through the Remote Access Policy option, then a value is not
returned from the server, and the permissions that are enforced are based on the internal group
policy settings of the ASA.
Step 3 Create an attribute map to allow both an IPsec and AnyConnect connection, but deny a clientless SSL
connection.
The following example shows how to create the map tunneling_protocols, and map the AD attribute
msNPAllowDialin used by the Allow Access setting to the Cisco attribute Tunneling-Protocols using the
map-name command, and add map values with the map-value command:
hostname(config)# ldap attribute-map tunneling_protocols
hostname(config-ldap-attribute-map)# map-name msNPAllowDialin Tunneling-Protocols
hostname(config-ldap-attribute-map)# map-value msNPAllowDialin FALSE 48
hostname(config-ldap-attribute-map)# map-value msNPAllowDialin TRUE 4
Step 4 Associate the LDAP attribute map to the AAA server.
The following example enters the aaa server host configuration mode for the host 10.1.1.2, in the AAA
server group MS_LDAP, and associates the attribute map tunneling_protocols that you created in Step 2:
hostname(config)# aaa-server MS_LDAP host 10.1.1.2
hostname(config-aaa-server-host)# ldap-attribute-map tunneling_protocols
Step 5 Verify that the attribute map works as configured.
Step 6 Try connections using clientless SSL, the AnyConnect client, and the IPsec client. The clientless and
AnyConnect connections should fail, and the user should be informed that an unauthorized connection
mechanism was the reason for the failed connection. The IPsec client should connect because IPsec is
an allowed tunneling protocol according to the attribute map (see Figure C-10 and Figure C-11).
Figure C-10 Login Denied Message for Clientless User
C-25
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Figure C-11 Login Denied Message for AnyConnect Client User
Enforcing Logon Hours and Time-of-Day Rules
The following example shows how to configure and enforce the hours that a clientless SSL user (such as
a business partner) is allowed to access the network.
On the AD server, use the Office field to enter the name of the partner, which uses the
physicalDeliveryOfficeName attribute. Then we create an attribute map on the ASA to map that attribute
to the Cisco attribute Access-Hours. During authentication, the ASA retrieves the value of
physicalDeliveryOfficeName and maps it to Access-Hours.
To configure the user attributes on the AD /LDAP server, perform the following steps:
Step 1 Select the user, and right-click Properties.
The Properties dialog box appears (see Figure C-12).
Step 2 Click the General tab.
C-26
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External LDAP Server
Figure C-12 Active Directory Properties Dialog Box
Step 3 Create an attribute map.
The following example shows how to create the attribute map access_hours and map the AD attribute
physicalDeliveryOfficeName used by the Office field to the Cisco attribute Access-Hours.
hostname(config)# ldap attribute-map access_hours
hostname(config-ldap-attribute-map)# map-name physicalDeliveryOfficeName Access-Hours
Step 4 Associate the LDAP attribute map to the AAA server.
The following example enters the aaa server host configuration mode for the host 10.1.1.2, in the AAA
server group MS_LDAP, and associates the attribute map access_hours that you created in Step 3:
hostname(config)# aaa-server MS_LDAP host 10.1.1.2
hostname(config-aaa-server-host)# ldap-attribute-map access_hours
Step 5 Configure time ranges for each value allowed on the server.
The following example configures Partner access hours from 9am to 5pm Monday through Friday:
hostname(config)# time-range Partner
hostname(config-time-range)# periodic weekdays 09:00 to 17:00
C-27
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External RADIUS Server
Configuring an External RADIUS Server
This section presents an overview of the RADIUS configuration procedure and defines the Cisco
RADIUS attributes. It includes the following topics:
Reviewing the RADIUS Configuration Procedure, page C-27
ASA RADIUS Authorization Attributes, page C-27
ASA IETF RADIUS Authorization Attributes, page C-36
RADIUS Accounting Disconnect Reason Codes, page C-37
Reviewing the RADIUS Configuration Procedure
This section describes the RADIUS configuration steps required to support authentication and
authorization of ASA users.
To set up the RADIUS server to interoperate with the ASA, preform the following steps:
Step 1 Load the ASA attributes into the RADIUS server. The method you use to load the attributes depends on
which type of RADIUS server you are using:
If you are using Cisco ACS: the server already has these attributes integrated. You can skip this step.
If you are using a FUNK RADIUS server: Cisco supplies a dictionary file that contains all the ASA
attributes. Obtain this dictionary file, cisco3k.dct, from the Cisco Download Software Center on
Cisco.com or from the ASA CD-ROM. Load the dictionary file on your server.
For RADIUS servers from other vendors (for example, Microsoft Internet Authentication Service):
you must manually define each ASA attribute. To define an attribute, use the attribute name or
number, type, value, and vendor code (3076). For a list of ASA RADIUS authorization attributes
and values, see Table C-7.
Step 2 Set up the users or groups with the permissions and attributes to send during IPsec or SSL tunnel
establishment.
ASA RADIUS Authorization Attributes
Authorization refers to the process of enforcing permissions or attributes. A RADIUS server defined as
an authentication server enforces permissions or attributes if they are configured. These attributes have
vendor ID 3076.
Table C-7 lists the ASA supported RADIUS attributes that can be used for user authorization.
Note RADIUS attribute names do not contain the cVPN3000 prefix. Cisco Secure ACS 4.x supports this new
nomenclature, but attribute names in pre-4.0 ACS releases still include the cVPN3000 prefix. The ASAs
enforce the RADIUS attributes based on attribute numeric ID, not attribute name. LDAP attributes are
enforced by their name, not by the ID.
All attributes listed in Table C-7 are downstream attributes that are sent from the RADIUS server to the
ASA except for the following attribute numbers: 146, 150, 151, and 152. These attribute numbers are
upstream attributes that are sent from the ASA to the RADIUS server. RADIUS attributes 146 and 150
C-28
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External RADIUS Server
are sent from the ASA to the RADIUS server for authentication and authorization requests. All four
previously listed attributes are sent from the ASA to the RADIUS server for accounting start,
interim-update, and stop requests. Upstream RADIUS attributes 146, 150, 151, and 152 were introduced
in ASA Version 8.4.3.
Table C-7 ASA Supported RADIUS Attributes and Values
Attribute Name
VPN
3000 ASA PIX
Attr.
No.
Syntax/
Type
Single
or
Multi-
Valued Description or Value
Access-Hours Y Y Y 1 String Single Name of the time range, for
example, Business-hours
Simultaneous-Logins Y Y Y 2 Integer Single 0 - 2147483647
Primary-DNS Y Y Y 5 String Single An IP address
Secondary-DNS Y Y Y 6 String Single An IP address
Primary-WINS Y Y Y 7 String Single An IP address
Secondary-WINS Y Y Y 8 String Single An IP address
SEP-Card-Assignment 9 Integer Single Not used
Tunneling-Protocols Y Y Y 11 Integer Single 1 = PPTP
2 = L2TP
4 = IPSec (IKEv1)
8 = L2TP/IPSec
16 = WebVPN
32 = SVC
64 = IPsec (IKEv2)
8 and 4 are mutually exclusive
(0 - 11, 16 - 27, 32 - 43, 48 - 59
are legal values).
IPsec-Sec-Association Y 12 String Single Name of the security
association
IPsec-Authentication Y 13 Integer Single 0 = None
1 = RADIUS
2 = LDAP (authorization only)
3 = NT Domain
4 = SDI
5 = Internal
6 = RADIUS with Expiry
7 = Kerberos/Active Directory
Banner1 Y Y Y 15 String Single Banner string to display for
Cisco VPN remote access
sessions: IPsec IKEv1,
AnyConnect
SSL-TLS/DTLS/IKEv2, and
Clientless SSL
IPsec-Allow-Passwd-Store Y Y Y 16 Boolean Single 0 = Disabled
1 = Enabled
C-29
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External RADIUS Server
Use-Client-Address Y 17 Boolean Single 0 = Disabled
1 = Enabled
PPTP-Encryption Y 20 Integer Single Bitmap:
1 = Encryption required
2 = 40 bits
4 = 128 bits
8 = Stateless-Required
15= 40/128-Encr/Stateless-Req
L2TP-Encryption Y 21 Integer Single Bitmap:
1 = Encryption required
2 = 40 bits
4 = 128 bits
8 = Stateless-Req
15= 40/128-Encr/Stateless-Req
Group-Policy Y Y 25 String Single Sets the group policy for the
remote access VPN session. For
versions 8.2 and later, use this
attribute instead of
IETF-Radius-Class. You can
use one of the three following
formats:
group policy name
OU=group policy name
OU=group policy name;
IPsec-Split-Tunnel-List Y Y Y 27 String Single Specifies the name of the
network/access list that
describes the split tunnel
inclusion list.
IPsec-Default-Domain Y Y Y 28 String Single Specifies the single default
domain name to send to the
client (1-255 characters).
IPsec-Split-DNS-Names Y Y Y 29 String Single Specifies the list of secondary
domain names to send to the
client (1-255 characters).
IPsec-Tunnel-Type Y Y Y 30 Integer Single 1 = LAN-to-LAN
2 = Remote access
IPsec-Mode-Config Y Y Y 31 Boolean Single 0 = Disabled
1 = Enabled
IPsec-User-Group-Lock Y 33 Boolean Single 0 = Disabled
1 = Enabled
Table C-7 ASA Supported RADIUS Attributes and Values (continued)
Attribute Name
VPN
3000 ASA PIX
Attr.
No.
Syntax/
Type
Single
or
Multi-
Valued Description or Value
C-30
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External RADIUS Server
IPsec-Over-UDP Y Y Y 34 Boolean Single 0 = Disabled
1 = Enabled
IPsec-Over-UDP-Port Y Y Y 35 Integer Single 4001 - 49151. The default
is10000.
Banner2 Y Y Y 36 String Single Banner string to display for
Cisco VPN remote access
sessions: IPsec IKEv1,
AnyConnect
SSL-TLS/DTLS/IKEv2, and
Clientless SSL. The Banner2
string is concatenated to the
Banner1 string , if configured.
PPTP-MPPC-Compression Y 37 Integer Single 0 = Disabled
1 = Enabled
L2TP-MPPC-Compression Y 38 Integer Single 0 = Disabled
1 = Enabled
IPsec-IP-Compression Y Y Y 39 Integer Single 0 = Disabled
1 = Enabled
IPsec-IKE-Peer-ID-Check Y Y Y 40 Integer Single 1 = Required
2 = If supported by peer
certificate
3 = Do not check
IKE-Keep-Alives Y Y Y 41 Boolean Single 0 = Disabled
1 = Enabled
IPsec-Auth-On-Rekey Y Y Y 42 Boolean Single 0 = Disabled
1 = Enabled
Required-Client- Firewall-Vendor-Code Y Y Y 45 Integer Single 1 = Cisco Systems (with Cisco
Integrated Client)
2 = Zone Labs
3 = NetworkICE
4 = Sygate
5 = Cisco Systems (with Cisco
Intrusion Prevention Security
Agent)
Table C-7 ASA Supported RADIUS Attributes and Values (continued)
Attribute Name
VPN
3000 ASA PIX
Attr.
No.
Syntax/
Type
Single
or
Multi-
Valued Description or Value
C-31
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External RADIUS Server
Required-Client-Firewall-Product-Code Y Y Y 46 Integer Single Cisco Systems Products:
1 = Cisco Intrusion Prevention
Security Agent or Cisco
Integrated Client (CIC)
Zone Labs Products:
1 = Zone Alarm
2 = Zone AlarmPro
3 = Zone Labs Integrity
NetworkICE Product:
1 = BlackIce Defender/Agent
Sygate Products:
1 = Personal Firewall
2 = Personal Firewall Pro
3 = Security Agent
Required-Client-Firewall-Description Y Y Y 47 String Single String
Require-HW-Client-Auth Y Y Y 48 Boolean Single 0 = Disabled
1 = Enabled
Required-Individual-User-Auth Y Y Y 49 Integer Single 0 = Disabled
1 = Enabled
Authenticated-User-Idle-Timeout Y Y Y 50 Integer Single 1-35791394 minutes
Cisco-IP-Phone-Bypass Y Y Y 51 Integer Single 0 = Disabled
1 = Enabled
IPsec-Split-Tunneling-Policy Y Y Y 55 Integer Single 0 = No split tunneling
1 = Split tunneling
2 = Local LAN permitted
IPsec-Required-Client-Firewall-Capability Y Y Y 56 Integer Single 0 = None
1 = Policy defined by remote
FW Are-You-There (AYT)
2 = Policy pushed CPP
4 = Policy from server
IPsec-Client-Firewall-Filter-Name Y 57 String Single Specifies the name of the filter
to be pushed to the client as
firewall policy
IPsec-Client-Firewall-Filter-Optional Y Y Y 58 Integer Single 0 = Required
1 = Optional
IPsec-Backup-Servers Y Y Y 59 String Single 1 = Use Client-Configured list
2 = Disable and clear client list
3 = Use Backup Server list
IPsec-Backup-Server-List Y Y Y 60 String Single Server Addresses (space
delimited)
Table C-7 ASA Supported RADIUS Attributes and Values (continued)
Attribute Name
VPN
3000 ASA PIX
Attr.
No.
Syntax/
Type
Single
or
Multi-
Valued Description or Value
C-32
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External RADIUS Server
DHCP-Network-Scope Y Y Y 61 String Single IP Address
Intercept-DHCP-Configure-Msg Y Y Y 62 Boolean Single 0 = Disabled
1 = Enabled
MS-Client-Subnet-Mask Y Y Y 63 Boolean Single An IP address
Allow-Network-Extension-Mode Y Y Y 64 Boolean Single 0 = Disabled
1 = Enabled
Authorization-Type Y Y Y 65 Integer Single 0 = None
1 = RADIUS
2 = LDAP
Authorization-Required Y 66 Integer Single 0 = No
1 = Yes
Authorization-DN-Field Y Y Y 67 String Single Possible values: UID, OU, O,
CN, L, SP, C, EA, T, N, GN, SN,
I, GENQ, DNQ, SER,
use-entire-name
IKE-KeepAlive-Confidence-Interval Y Y Y 68 Integer Single 10 - 300 seconds
WebVPN-Content-Filter-Parameters Y Y 69 Integer Single 1 = Java ActiveX
2 = Java Script
4 = Image
8 = Cookies in images
WebVPN-URL-List Y 71 String Single URL-List name
WebVPN-Port-Forward-List Y 72 String Single Port-Forward list name
WebVPN-Access-List Y 73 String Single Access-List name
Cisco-LEAP-Bypass Y Y Y 75 Integer Single 0 = Disabled
1 = Enabled
WebVPN-Homepage Y Y 76 String Single A URL such as
http://example-example.com
Client-Type-Version-Limiting Y Y Y 77 String Single IPsec VPN version number
string
WebVPN-Port-Forwarding-Name Y Y 79 String Single String name (example,
Corporate-Apps).
This text replaces the default
string, Application Access, on
the clientless portal home page.
IE-Proxy-Server Y 80 String Single IP address
IE-Proxy-Server-Policy Y 81 Integer Single 1 = No Modify
2 = No Proxy
3 = Auto detect
4 = Use Concentrator Setting
Table C-7 ASA Supported RADIUS Attributes and Values (continued)
Attribute Name
VPN
3000 ASA PIX
Attr.
No.
Syntax/
Type
Single
or
Multi-
Valued Description or Value
C-33
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External RADIUS Server
IE-Proxy-Exception-List Y 82 String Single New line (\n) separated list of
DNS domains
IE-Proxy-Bypass-Local Y 83 Integer Single 0 = None
1 = Local
IKE-Keepalive-Retry-Interval Y Y Y 84 Integer Single 2 - 10 seconds
Tunnel-Group-Lock Y Y 85 String Single Name of the tunnel group or
none
Access-List-Inbound Y Y 86 String Single Access list ID
Access-List-Outbound Y Y 87 String Single Access list ID
Perfect-Forward-Secrecy-Enable Y Y Y 88 Boolean Single 0 = No
1 = Yes
NAC-Enable Y 89 Integer Single 0 = No
1 = Yes
NAC-Status-Query-Timer Y 90 Integer Single 30 - 1800 seconds
NAC-Revalidation-Timer Y 91 Integer Single 300 - 86400 seconds
NAC-Default-ACL Y 92 String Access list
WebVPN-URL-Entry-Enable Y Y 93 Integer Single 0 = Disabled
1 = Enabled
WebVPN-File-Access-Enable Y Y 94 Integer Single 0 = Disabled
1 = Enabled
WebVPN-File-Server-Entry-Enable Y Y 95 Integer Single 0 = Disabled
1 = Enabled
WebVPN-File-Server-Browsing-Enable Y Y 96 Integer Single 0 = Disabled
1 = Enabled
WebVPN-Port-Forwarding-Enable Y Y 97 Integer Single 0 = Disabled
1 = Enabled
WebVPN-Outlook-Exchange-Proxy-Enable Y Y 98 Integer Single 0 = Disabled
1 = Enabled
WebVPN-Port-Forwarding-HTTP-Proxy Y Y 99 Integer Single 0 = Disabled
1 = Enabled
WebVPN-Auto-Applet-Download-Enable Y Y 100 Integer Single 0 = Disabled
1 = Enabled
WebVPN-Citrix-Metaframe-Enable Y Y 101 Integer Single 0 = Disabled
1 = Enabled
WebVPN-Apply-ACL Y Y 102 Integer Single 0 = Disabled
1 = Enabled
WebVPN-SSL-VPN-Client-Enable Y Y 103 Integer Single 0 = Disabled
1 = Enabled
Table C-7 ASA Supported RADIUS Attributes and Values (continued)
Attribute Name
VPN
3000 ASA PIX
Attr.
No.
Syntax/
Type
Single
or
Multi-
Valued Description or Value
C-34
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External RADIUS Server
WebVPN-SSL-VPN-Client-Required Y Y 104 Integer Single 0 = Disabled
1 = Enabled
WebVPN-SSL-VPN-Client-Keep-
Installation
Y Y 105 Integer Single 0 = Disabled
1 = Enabled
SVC-Keepalive Y Y 107 Integer Single 0 = Off
15 - 600 seconds
SVC-DPD-Interval-Client Y Y 108 Integer Single 0 = Off
5 - 3600 seconds
SVC-DPD-Interval-Gateway Y Y 109 Integer Single 0 = Off)
5 - 3600 seconds
SVC-Rekey-Time Y 110 Integer Single 0 = Disabled
1- 10080 minutes
WebVPN-Deny-Message Y 116 String Single Valid string (up to 500
characters)
Extended-Authentication-On-Rekey Y Y 122 Integer Single 0 = Disabled
1 = Enabled
SVC-DTLS Y 123 Integer Single 0 = False
1 = True
SVC-MTU Y 125 Integer Single MTU value
256 - 1406 in bytes
SVC-Modules Y 127 String Single String (name of a module)
SVC-Profiles Y 128 String Single String (name of a profile)
SVC-Ask Y 131 String Single 0 = Disabled
1 = Enabled
3 = Enable default service
5 = Enable default clientless
(2 and 4 not used)
SVC-Ask-Timeout Y 132 Integer Single 5 - 120 seconds
IE-Proxy-PAC-URL Y 133 String Single PAC Address String
Strip-Realm Y Y Y 135 Boolean Single 0 = Disabled
1 = Enabled
Smart-Tunnel Y 136 String Single Name of a Smart Tunnel
WebVPN-ActiveX-Relay Y 137 Integer Single 0 = Disabled
Otherwise = Enabled
Smart-Tunnel-Auto Y 138 Integer Single 0 = Disabled
1 = Enabled
2 = AutoStart
Table C-7 ASA Supported RADIUS Attributes and Values (continued)
Attribute Name
VPN
3000 ASA PIX
Attr.
No.
Syntax/
Type
Single
or
Multi-
Valued Description or Value
C-35
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External RADIUS Server
Smart-Tunnel-Auto-Signon-Enable Y 139 String Single Name of a Smart Tunnel Auto
Signon list appended by the
domain name
VLAN Y 140 Integer Single 0 - 4094
NAC-Settings Y 141 String Single Name of the NAC policy
Member-Of Y Y 145 String Single Comma-delimited string, for
example:
Engineering, Sales
An administrative attribute that
can be used in dynamic access
policies. It does not set a group
policy.
Tunnel Group Name Y Y 146 String Single 1 - 253 characters
Client Type Y Y 150 Integer Single 1 = Cisco VPN Client (IKEv1)
2 = AnyConnect Client SSL
VPN
3 = Clientless SSL VPN
4 = Cut-Through-Proxy
5 = L2TP/IPsec SSL VPN
6 = AnyConnect Client IPsec
VPN (IKEv2)
Session Type Y Y 151 Integer Single 0 = None
1 = AnyConnect Client SSL
VPN
2 = AnyConnect Client IPSec
VPN (IKEv2)
3 = Clientless SSL VPN
4 = Clientless Email Proxy
5 = Cisco VPN Client (IKEv1)
6 = IKEv1 LAN-LAN
7 = IKEv2 LAN-LAN
8 = VPN Load Balancing
Session Subtype Y Y 152 Integer Single 0 = None
1 = Clientless
2 = Client
3 = Client Only
Session Subtype applies only
when the Session Type (151)
attribute has the following
values: 1, 2, 3, and 4.
Address-Pools Y Y 217 String Single Name of IP local pool
IPv6-Address-Pools Y 218 String Single Name of IP local pool-IPv6
Table C-7 ASA Supported RADIUS Attributes and Values (continued)
Attribute Name
VPN
3000 ASA PIX
Attr.
No.
Syntax/
Type
Single
or
Multi-
Valued Description or Value
C-36
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External RADIUS Server
ASA IETF RADIUS Authorization Attributes
Table C-8 lists the supported IETF RADIUS attributes.
IPv6-VPN-Filter Y 219 String Single ACL value
Privilege-Level Y Y 220 Integer Single An integer between 0 and 15.
WebVPN-Macro-Value1 Y 223 String Single Unbounded. For examples, see
the SSL VPN Deployment Guide
at the following URL:
http://supportwiki.cisco.com/Vi
ewWiki/index.php/Cisco_ASA
_5500_SSL_VPN_Deployment
_Guide%2C_Version_8.x
WebVPN-Macro-Value2 Y 224 String Single Unbounded. For examples, see
the SSL VPN Deployment Guide
at the following URL:
http://supportwiki.cisco.com/Vi
ewWiki/index.php/Cisco_ASA
_5500_SSL_VPN_Deployment
_Guide%2C_Version_8.x
Table C-7 ASA Supported RADIUS Attributes and Values (continued)
Attribute Name
VPN
3000 ASA PIX
Attr.
No.
Syntax/
Type
Single
or
Multi-
Valued Description or Value
Table C-8 ASA Supported IETF RADIUS Attributes and Values
Attribute Name
VPN
3000 ASA PIX
Attr.
No.
Syntax/
Type
Single or
Multi-
Valued Description or Value
IETF-Radius-Class Y Y Y 25 Single For Versions 8.2.x and later, we
recommend that you use the
Group-Policy attribute (VSA 3076,
#25) as described in Table C-7:
group policy name
OU=group policy name
OU=group policy name
IETF-Radius-Filter-Id Y Y Y 11 String Single Access list name that is defined on the
ASA, which applies only to full
tunnel IPsec and SSL VPN clients
IETF-Radius-Framed-IP-Address Y Y Y n/a String Single An IP address
IETF-Radius-Framed-IP-Netmask Y Y Y n/a String Single An IP address mask
IETF-Radius-Idle-Timeout Y Y Y 28 Integer Single Seconds
C-37
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External RADIUS Server
RADIUS Accounting Disconnect Reason Codes
These codes are returned if the ASA encounters a disconnect when sending packets:
IETF-Radius-Service-Type Y Y Y 6 Integer Single Seconds. Possible Service Type
values:
.AdministrativeUser is allowed
access to configure prompt.
.NAS-PromptUser is allowed
access to exec prompt.
.remote-accessUser is allowed
network access
IETF-Radius-Session-Timeout Y Y Y 27 Integer Single Seconds
Table C-8 ASA Supported IETF RADIUS Attributes and Values
Disconnect Reason Code
ACCT_DISC_USER_REQ = 1
ACCT_DISC_LOST_CARRIER = 2
ACCT_DISC_LOST_SERVICE = 3
ACCT_DISC_IDLE_TIMEOUT = 4
ACCT_DISC_SESS_TIMEOUT = 5
ACCT_DISC_ADMIN_RESET = 6
ACCT_DISC_ADMIN_REBOOT = 7
ACCT_DISC_PORT_ERROR = 8
ACCT_DISC_NAS_ERROR = 9
ACCT_DISC_NAS_REQUEST = 10
ACCT_DISC_NAS_REBOOT = 11
ACCT_DISC_PORT_UNNEEDED = 12
ACCT_DISC_PORT_PREEMPTED = 13
ACCT_DISC_PORT_SUSPENDED = 14
ACCT_DISC_SERV_UNAVAIL = 15
ACCT_DISC_CALLBACK = 16
ACCT_DISC_USER_ERROR = 17
ACCT_DISC_HOST_REQUEST = 18
ACCT_DISC_ADMIN_SHUTDOWN = 19
ACCT_DISC_SA_EXPIRED = 21
ACCT_DISC_MAX_REASONS = 22
C-38
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External TACACS+ Server
Configuring an External TACACS+ Server
The ASA provides support for TACACS+ attributes. TACACS+ separates the functions of
authentication, authorization, and accounting. The protocol supports two types of attributes: mandatory
and optional. Both the server and client must understand a mandatory attribute, and the mandatory
attribute must be applied to the user. An optional attribute may or may not be understood or used.
Note To use TACACS+ attributes, make sure that you have enabled AAA services on the NAS.
Table C-9 lists supported TACACS+ authorization response attributes for cut-through-proxy
connections. Table C-10 lists supported TACACS+ accounting attributes.
.
Table C-9 Supported TACACS+ Authorization Response Attributes
Attribute Description
acl Identifies a locally configured access list to be applied to the connection.
idletime Indicates the amount of inactivity in minutes that is allowed before the
authenticated user session is terminated.
timeout Specifies the absolute amount of time in minutes that authentication credentials
remain active before the authenticated user session is terminated.
Table C-10 Supported TACACS+ Accounting Attributes
Attribute Description
bytes_in Specifies the number of input bytes transferred during this connection (stop
records only).
bytes_out Specifies the number of output bytes transferred during this connection (stop
records only).
cmd Defines the command executed (command accounting only).
disc-cause Indicates the numeric code that identifies the reason for disconnecting (stop
records only).
elapsed_time Defines the elapsed time in seconds for the connection (stop records only).
foreign_ip Specifies the IP address of the client for tunnel connections. Defines the address
on the lowest security interface for cut-through-proxy connections.
local_ip Specifies the IP address that the client connected to for tunnel connections. Defines
the address on the highest security interface for cut-through-proxy connections.
NAS port Contains a session ID for the connection.
packs_in Specifies the number of input packets transferred during this connection.
packs_out Specifies the number of output packets transferred during this connection.
priv-level Set to the user privilege level for command accounting requests or to 1 otherwise.
rem_iddr Indicates the IP address of the client.
service Specifies the service used. Always set to shell for command accounting only.
C-39
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External TACACS+ Server
task_id Specifies a unique task ID for the accounting transaction.
username Indicates the name of the user.
Table C-10 Supported TACACS+ Accounting Attributes (continued)
Attribute Description
C-40
Cisco ASA 5500 Series Configuration Guide using the CLI
Appendix C Configuring an External Server for Authorization and Authentication
Configuring an External TACACS+ Server
GL-1
Cisco ASA 5500 Series Configuration Guide using the CLI
G L O S S A R Y
Numerics | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X
Numerics
3DES See DES.
A
AAA Authentication, authorization, and accounting. See also TACACS+ and RADIUS.
ABR Area Border Router. In OSPF, a router with interfaces in multiple areas.
ACE access control entry. Information entered into the configuration that lets you specify what type of traffic
to permit or deny on an interface. By default, traffic that is not explicitly permitted is denied.
Access Modes The ASA CLI uses several command modes. The commands available in each mode vary. See also user
EXEC mode, privileged EXEC mode, global configuration mode, command-specific configuration mode.
ACL access control list. A collection of ACEs. An ACL lets you specify what type of traffic to allow on an
interface. By default, traffic that is not explicitly permitted is denied. ACLs are usually applied to the
interface which is the source of inbound traffic. See also rule, outbound ACL.
ActiveX A set of object-oriented programming technologies and tools used to create mobile or portable
programs. An ActiveX program is roughly equivalent to a Java applet.
Address Resolution
Protocol
See ARP.
address translation The translation of a network address and/or port to another network address/or port. See also IP address,
interface PAT, NAT, PAT, Static PAT, xlate.
AES Advanced Encryption Standard. A symmetric block cipher that can encrypt and decrypt information.
The AES algorithm is capable of using cryptographic keys of 128, 192 and 256 bits to encrypt and
decrypt data in blocks of 128 bits. See also DES.
AH Authentication Header. An IP protocol (type 51) that can ensure data integrity, authentication, and
replay detection. AH is embedded in the data to be protected (a full IP datagram, for example). AH can
be used either by itself or with ESP. AH is an older IPsec protocol that is less important in most
networks than ESP. AH provides authentication services but does not provide encryption services. It is
provided to ensure compatibility with IPsec peers that do not support ESP, which provides both
authentication and encryption. See also encryption and VPN. Refer to the RFC 2402.
AIP Advanced Inspection and Prevention. For example, the AIP SSM or AIP SSC, which runs IPS software.
Glossary
GL-2
Cisco ASA 5500 Series Configuration Guide using the CLI
A record address A stands for address, and refers to name-to-address mapped records in DNS.
APCF Application Profile Customization Framework. Lets the security appliance handle nonstandard
applications so that they render correctly over a clientless SSL VPN connection.
ARP Address Resolution Protocol. A low-level TCP/IP protocol that maps a hardware address, or MAC
address, to an IP address. An example hardware address is 00:00:a6:00:01:ba. The first three groups of
characters (00:00:a6) identify the manufacturer; the rest of the characters (00:01:ba) identify the
system card. ARP is defined in RFC 826.
ASA Adaptive Security Algorithm. Used by the ASA to perform inspections. ASA allows one-way (inside
to outside) connections without an explicit configuration for each internal system and application. See
also inspection engine.
ASA adaptive ASA.
ASDM Adaptive Security Device Manager. An application for managing and configuring a single ASA.
asymmetric
encryption
Also called public key systems, asymmetric encryption allows anyone to obtain access to the public
key of anyone else. Once the public key is accessed, you can send an encrypted message to that person
using the public key. See also encryption, public key.
authentication Cryptographic protocols and services that verify the identity of users and the integrity of data. One of
the functions of the IPsec framework. Authentication establishes the integrity of the datastream and
ensures that it is not tampered with in transit. It also provides confirmation about the origin of the
datastream. See also AAA, encryption, and VPN.
Auto Applet
Download
Automatically downloads the clientless SSL VPN port-forwarding applet when the user first logs in to
clientless SSL VPN.
auto-signon This command provides a single sign-on method for clientless SSL VPN users. It passes the clientless
SSL VPN login credentials (username and password) to internal servers for authentication using
NTLM authentication, basic authentication, or both.
B
backup server IPsec backup servers let a VPN client connect to the central site when the primary security appliance
is unavailable.
BGP Border Gateway Protocol. BGP performs interdomain routing in TCP/IP networks. BGP is an Exterior
Gateway Protocol, which means that it performs routing between multiple autonomous systems or
domains and exchanges routing and access information with other BGP systems. The ASA does not
support BGP. See also EGP.
BLT stream Bandwidth Limited Traffic stream. Stream or flow of packets whose bandwidth is constrained.
BOOTP Bootstrap Protocol. Lets diskless workstations boot over the network as is described in RFC 951 and
RFC 1542.
BPDU Bridge Protocol Data Unit. Spanning-Tree Protocol hello packet that is sent out at configurable
intervals to exchange information among bridges in the network. Protocol data unit is the OSI term for
packet.
Glossary
GL-3
Cisco ASA 5500 Series Configuration Guide using the CLI
C
CA Certificate Authority, Certification Authority. A third-party entity that is responsible for issuing and
revoking certificates. Each device with the public key of the CA can authenticate a device that has a
certificate issued by the CA. The term CA also refers to software that provides CA services. See also
certificate, CRL, public key, RA.
cache A temporary repository of information accumulated from previous task executions that can be reused,
decreasing the time required to perform the tasks. Caching stores frequently reused objects in the system
cache, which reduces the need to perform repeated rewriting and compressing of content.
CBC Cipher Block Chaining. A cryptographic technique that increases the encryption strength of an
algorithm. CBC requires an initialization vector (IV) to start encryption. The IV is explicitly given in
the IPsec packet.
certificate A signed cryptographic object that contains the identity of a user or device and the public key of the
CA that issued the certificate. Certificates have an expiration date and may also be placed on a CRL if
known to be compromised. Certificates also establish non-repudiation for IKE negotiation, which
means that you can prove to a third party that IKE negotiation was completed with a specific peer.
CHAP Challenge Handshake Authentication Protocol.
CIFS Common Internet File System. It is a platform-independent file sharing system that provides users with
network access to files, printers, and other machine resources. Microsoft implemented CIFS for
networks of Windows computers, however, open source implementations of CIFS provide file access
to servers running other operating systems, such as Linux, UNIX, and Mac OS X.
Citrix An application that virtualizes client-server applications and optimizes web applications.
CLI command-line interface. The primary interface for entering configuration and monitoring commands
to the ASA.
client/server
computing
Distributed computing (processing) network systems in which transaction responsibilities are divided
into two parts: client (front end) and server (back end). Also called distributed computing. See also
RPC.
Client update Lets you update revisions of clients to which the update applies; provide a URL or IP address from
which to get the update; and, in the case of Windows clients, optionally notify users that they should
update their VPN client version.
command-specific
configuration mode
From global configuration mode, some commands enter a command-specific configuration mode. All
user EXEC, privileged EXEC, global configuration, and command-specific configuration commands
are available in this mode. See also global configuration mode, privileged EXEC mode, user EXEC
mode.
compression The process of encoding information using fewer bits or other information-bearing units than an
unencoded representation would use. Compression can reduce the size of transferring packets and
increase communication performance.
configuration,
config, config file
A file on the ASA that represents the equivalent of settings, preferences, and properties administered
by ASDM or the CLI.
Glossary
GL-4
Cisco ASA 5500 Series Configuration Guide using the CLI
Content
Rewriting/Transfor
mation
Interprets and modifies applications so that they render correctly over a clientless SSL VPN
connection.
cookie A cookie is a object stored by a browser. Cookies contain information, such as user preferences, to
persistent storage.
CPU Central Processing Unit. Main processor.
CRC Cyclical Redundancy Check. Error-checking technique in which the frame recipient calculates a
remainder by dividing frame contents by a prime binary divisor and compares the calculated remainder
to a value stored in the frame by the sending node.
CRL Certificate Revocation List. A digitally signed message that lists all of the current but revoked
certificates listed by a given CA. A CRL is analogous to a book of stolen charge card numbers that
allow stores to reject bad credit cards. When certificates are revoked, they are added to a CRL. When
you implement authentication using certificates, you can choose to use CRLs or not. Using CRLs lets
you easily revoke certificates before they expire, but the CRL is generally only maintained by the CA
or an RA. If you are using CRLs and the connection to the CA or RA is not available when
authentication is requested, the authentication request will fail. See also CA, certificate, public key, RA.
CRV Call Reference Value. Used by H.225.0 to distinguish call legs signaled between two entities.
cryptography Encryption, authentication, integrity, keys and other services used for secure communication over
networks. See also VPN and IPsec.
crypto map A data structure with a unique name and sequence number that is used for configuring VPNs on the
ASA. A crypto map selects data flows that need security processing and defines the policy for these
flows and the crypto peer that traffic needs to go to. A crypto map is applied to an interface. Crypto
maps contain the ACLs, encryption standards, peers, and other parameters necessary to specify security
policies for VPNs using IKE and IPsec. See also VPN.
CTIQBE Computer Telephony Interface Quick Buffer Encoding. A protocol used in IP telephony between the
Cisco CallManager and CTI TAPI and JTAPI applications. CTIQBE is used by the TAPI/JTAPI
protocol inspection module and supports NAT, PAT, and bidirectional NAT. This protocol enables
Cisco IP SoftPhone and other Cisco TAPI/JTAPI applications to communicate with Cisco CallManager
for call setup and voice traffic across the ASA.
cut-through proxy Enables the ASA to provide faster traffic flow after user authentication. The cut-through proxy
challenges a user initially at the application layer. After the security appliance authenticates the user,
it shifts the session flow and all traffic flows directly and quickly between the source and destination
while maintaining session state information.
D
data confidentiality Describes any method that manipulates data so that no attacker can read it. This is commonly achieved
by data encryption and keys that are only available to the parties involved in the communication.
data integrity Describes mechanisms that, through the use of encryption based on secret key or public key
algorithms, allow the recipient of a piece of protected data to verify that the data has not been modified
in transit.
Glossary
GL-5
Cisco ASA 5500 Series Configuration Guide using the CLI
data origin
authentication
A security service where the receiver can verify that protected data could have originated only from
the sender. This service requires a data integrity service plus a key distribution mechanism, where a
secret key is shared only between the sender and receiver.
decryption Application of a specific algorithm or cipher to encrypted data so as to render the data comprehensible
to those who are authorized to see the information. See also encryption.
DES Data encryption standard. DES was published in 1977 by the National Bureau of Standards and is a
secret key encryption scheme based on the Lucifer algorithm from IBM. Cisco uses DES in classic
crypto (40-bit and 56-bit key lengths), IPsec crypto (56-bit key), and 3DES (triple DES), which
performs encryption three times using a 56-bit key. 3DES is more secure than DES but requires more
processing for encryption and decryption. See also AES, ESP.
DHCP Dynamic Host Configuration Protocol. Provides a mechanism for allocating IP addresses to hosts
dynamically, so that addresses can be reused when hosts no longer need them and so that mobile
computers, such as laptops, receive an IP address applicable to the LAN to which it is connected.
Diffie-Hellman A public key cryptography protocol that allows two parties to establish a shared secret over insecure
communications channels. Diffie-Hellman is used within IKE to establish session keys.
Diffie-Hellman is a component of Oakley key exchange.
Diffie-Hellman
Group 1, Group 2,
Group 5, Group 7
Diffie-Hellman refers to a type of public key cryptography using asymmetric encryption based on
large prime numbers to establish both Phase 1 and Phase 2 SAs. Group 1 provides a smaller prime
number than Group 2 but may be the only version supported by some IPsec peers. Diffe-Hellman
Group 5 uses a 1536-bit prime number, is the most secure, and is recommended for use with AES.
Group 7 has an elliptical curve field size of 163 bits and is for use with the Movian VPN client, but
works with any peer that supports Group 7 (ECC). See also VPN and encryption.
Note The group 7 command option was deprecated in ASA Version 8.0(4). Attempts to configure
group 7 will generate an error message and use group 5 instead.
digital certificate See certificate.
DMZ See interface.
DN Distinguished Name. Global, authoritative name of an entry in the OSI Directory (X.500).
DNS Domain Name System (or Service). An Internet service that translates domain names into IP
addresses.
DoS Denial of Service. A type of network attack in which the goal is to render a network service
unavailable.
DSL digital subscriber line. Public network technology that delivers high bandwidth over conventional
copper wiring at limited distances. DSL is provisioned via modem pairs, with one modem located at
a central office and the other at the customer site. Because most DSL technologies do not use the
whole bandwidth of the twisted pair, there is room remaining for a voice channel.
DSP digital signal processor. A DSP segments a voice signal into frames and stores them in voice packets.
DSS Digital Signature Standard. A digital signature algorithm designed by The US National Institute of
Standards and Technology and based on public-key cryptography. DSS does not do user datagram
encryption. DSS is a component in classic crypto, as well as the Redcreek IPsec card, but not in IPsec
implemented in Cisco IOS software.
Glossary
GL-6
Cisco ASA 5500 Series Configuration Guide using the CLI
Dynamic NAT See NAT and address translation.
Dynamic PAT Dynamic Port Address Translation. Dynamic PAT lets multiple outbound sessions appear to originate
from a single IP address. With PAT enabled, the ASA chooses a unique port number from the PAT IP
address for each outbound translation slot (xlate). This feature is valuable when an ISP cannot allocate
enough unique IP addresses for your outbound connections. The global pool addresses always come
first, before a PAT address is used. See also NAT, Static PAT, and xlate.
E
ECHO See ping, ICMP. See also inspection engine.
EGP Exterior Gateway Protocol. Replaced by BGP. The ASA does not support EGP. See also BGP.
EIGRP Enhanced Interior Gateway Routing Protocol. The ASA does not support EIGRP.
EMBLEM Enterprise Management BaseLine Embedded Manageability. A syslog format designed to be
consistent with the Cisco IOS system log format and is more compatible with CiscoWorks
management applications.
encryption Application of a specific algorithm or cipher to data so as to render the data incomprehensible to those
unauthorized to see the information. See also decryption.
ESMTP Extended SMTP. Extended version of SMTP that includes additional functionality, such as delivery
notification and session delivery. ESMTP is described in RFC 1869, SMTP Service Extensions.
ESP Encapsulating Security Payload. An IPsec protocol, ESP provides authentication and encryption
services for establishing a secure tunnel over an insecure network. For more information, refer to
RFCs 2406 and 1827.
F
failover, failover
mode
Failover lets you configure two ASAs so that one will take over operation if the other one fails. The
ASA supports two failover configurations, Active/Active failover and Active/Standby failover. Each
failover configuration has its own method for determining and performing failover. With
Active/Active failover, both units can pass network traffic. Active/Active failover lets you configure
load balancing on your network. Active/Active failover is only available on units running in multiple
context mode. With Active/Standby failover, only one unit passes traffic while the other unit waits in
a standby state. Active/Standby failover is available on units running in either single or multiple
context mode.
Fixup See inspection engine.
Flash, Flash
memory
A nonvolatile storage device used to store the configuration file when the ASA is powered down.
FQDN/IP Fully qualified domain name/IP address. IPsec parameter that identifies peers that are security
gateways.
Glossary
GL-7
Cisco ASA 5500 Series Configuration Guide using the CLI
FragGuard Provides IP fragment protection and performs full reassembly of all ICMP error messages and virtual
reassembly of the remaining IP fragments that are routed through the ASA.
FTP File Transfer Protocol. Part of the TCP/IP protocol stack, used for transferring files between hosts.
G
GGSN gateway GPRS support node. A wireless gateway that allows mobile cell phone users to access the
public data network or specified private IP networks.
global
configuration mode
Global configuration mode lets you change the ASA configuration. All user EXEC, privileged EXEC,
and global configuration commands are available in this mode. See also user EXEC mode, privileged
EXEC mode, command-specific configuration mode.
GMT Greenwich Mean Time. Replaced by UTC (Coordinated Universal Time) in 1967 as the world time
standard.
GPRS general packet radio service. A service defined and standardized by the European Telecommunication
Standards Institute. GPRS is an IP-packet-based extension of GSM networks and provides mobile,
wireless, data communications
GRE Generic Routing Encapsulation described in RFCs 1701 and 1702. GRE is a tunneling protocol that
can encapsulate a wide variety of protocol packet types inside IP tunnels, creating a virtual
point-to-point link to routers at remote points over an IP network. By connecting multiprotocol
subnetworks in a single-protocol backbone environment, IP tunneling using GRE allows network
expansion across a single protocol backbone environment.
GSM Global System for Mobile Communication. A digital, mobile, radio standard developed for mobile,
wireless, voice communications.
GTP GPRS tunneling protocol. GTP handles the flow of user packet data and signaling information
between the SGSN and GGSN in a GPRS network. GTP is defined on both the Gn and Gp interfaces
of a GPRS network.
H
H.225 A protocol used for TCP signaling in applications such as video conferencing. See also H.323 and
inspection engine.
H.225.0 An ITU standard that governs H.225.0 session establishment and packetization. H.225.0 actually
describes several different protocols: RAS, use of Q.931, and use of RTP.
H.245 An ITU standard that governs H.245 endpoint control.
H.320 Suite of ITU-T standard specifications for video conferencing over circuit-switched media, such as
ISDN, fractional T-1, and switched-56 lines. Extensions of ITU-T standard H.320 enable video
conferencing over LANs and other packet-switched networks, as well as video over the Internet.
Glossary
GL-8
Cisco ASA 5500 Series Configuration Guide using the CLI
H.323 Allows dissimilar communication devices to communicate with each other by using a standardized
communication protocol. H.323 defines a common set of CODECs, call setup and negotiating
procedures, and basic data transport methods.
H.323 RAS Registration, admission, and status signaling protocol. Enables devices to perform registration,
admissions, bandwidth changes, and status and disengage procedures between VoIP gateway and the
gatekeeper.
H.450.2 Call transfer supplementary service for H.323.
H.450.3 Call diversion supplementary service for H.323.
Hash, Hash
Algorithm
A hash algorithm is a one-way function that operates on a message of arbitrary length to create a
fixed-length message digest used by cryptographic services to ensure its data integrity. MD5 has a
smaller digest and is considered to be slightly faster than SHA-1. Cisco uses both SHA-1 and MD5
hashes within our implementation of the IPsec framework. See also encryption, HMAC, and VPN.
headend A firewall, concentrator, or other host that serves as the entry point into a private network for VPN
client connections over the public network. See also ISP and VPN.
HMAC A mechanism for message authentication using cryptographic hashes such as SHA-1 and MD5.
host The name for any device on a TCP/IP network that has an IP address. See also network and node.
host/network An IP address and netmask used with other information to identify a single host or network subnet for
ASA configuration, such as an address translation (xlate) or ACE.
HTTP Hypertext Transfer Protocol. A protocol used by browsers and web servers to transfer files. When a
user views a web page, the browser can use HTTP to request and receive the files used by the web
page. HTTP transmissions are not encrypted.
HTTPS Hypertext Transfer Protocol Secure. An SSL-encrypted version of HTTP.
I
IANA Internet Assigned Number Authority. Assigns all port and protocol numbers for use on the Internet.
ICMP Internet Control Message Protocol. Network-layer Internet protocol that reports errors and provides
other information relevant to IP packet processing.
IDS Intrusion Detection System. A method of detecting malicious network activity by signatures and then
implementing a policy for that signature.
IETF The Internet Engineering Task Force. A technical standards organization that develops RFC
documents defining protocols for the Internet.
IGMP Internet Group Management Protocol. IGMP is a protocol used by IPv4 systems to report IP multicast
memberships to neighboring multicast routers.
Glossary
GL-9
Cisco ASA 5500 Series Configuration Guide using the CLI
IKE Internet Key Exchange. IKE establishes a shared security policy and authenticates keys for services
(such as IPsec) that require keys. Before any IPsec traffic can be passed, each ASA must verify the
identity of its peer. Identification can be done by manually entering preshared keys into both hosts or
by a CA service. IKE is a hybrid protocol that uses part Oakley and part of another protocol suite called
SKEME inside the ISAKMP framework. IKE (formerly known as ISAKMP/Oakley) is defined in RFC
2409.
IKE Extended
Authentication
IKE Extended Authenticate (Xauth) is implemented per the IETF draft-ietf-ipsec-isakmp-xauth-04.txt
(extended authentication). This protocol provides the capability of authenticating a user within IKE
using TACACS+ or RADIUS.
IKE Mode
Configuration
IKE Mode Configuration is implemented per the IETF draft-ietf-ipsec-isakmp-mode-cfg-04.txt. IKE
Mode Configuration provides a method for a security gateway to download an IP address (and other
network level configuration) to the VPN client as part of an IKE negotiation.
ILS Internet Locator Service. ILS is based on LDAP and is ILSv2 compliant. ILS was developed by
Microsoft for use with its NetMeeting, SiteServer, and Active Directory products.
IMAP Internet Message Access Protocol. Method of accessing e-mail or bulletin board messages kept on a
mail server that can be shared. IMAP permits client e-mail applications to access remote message
stores as if they were local without actually transferring the message.
implicit rule An access rule automatically created by the ASA based on default rules or as a result of user-defined
rules.
IMSI International Mobile Subscriber Identity. One of two components of a GTP tunnel ID, the other being
the NSAPI. See also NSAPI.
inside The first interface, usually port 1, that connects your internal, trusted network protected by the ASA.
See also interface, interface name.
inspection engine The ASA inspects certain application-level protocols to identify the location of embedded addressing
information in traffic. Inspection allows NAT to translate these embedded addresses and to update any
checksum or other fields that are affected by the translation. Because many protocols open secondary
TCP or UDP ports, each application inspection engine also monitors sessions to determine the port
numbers for secondary channels. The initial session on a well-known port is used to negotiate
dynamically assigned port numbers. The application inspection engine monitors these sessions,
identifies the dynamic port assignments, and permits data exchange on these ports for the duration of
the specific session. Some of the protocols that the ASA can inspect are CTIQBE, FTP, H.323, HTTP,
MGCP, SMTP, and SNMP.
interface The physical connection between a particular network and a ASA.
interface IP address The IP address of the ASA network interface. Each interface IP address must be unique. Two or more
interfaces must not be given the same IP address or IP addresses that are on the same IP network.
interface name Human-readable name assigned to the ASA network interface. The inside interface default name is
inside and the outside interface default name is outside. See also inside and outside.
interface PAT The use of PAT where the PAT IP address is also the IP address of the outside interface. See Dynamic
PAT, Static PAT.
Internet The global network that uses IP. Not a LAN. See also intranet.
Glossary
GL-10
Cisco ASA 5500 Series Configuration Guide using the CLI
intranet Intranetwork. A LAN that uses IP. See also network and Internet.
IP Internet Protocol. IP protocols are the most popular nonproprietary protocols because they can be used
to communicate across any set of interconnected networks and are equally well suited for LAN and
WAN communications.
IPS Intrusion Prevention Service. An in-line, deep-packet inspection-based solution that helps mitigate a
wide range of network attacks.
IP address An IP protocol address. A ASA interface ip_address. IP version 4 addresses are 32 bits in length. This
address space is used to designate the network number, optional subnetwork number, and a host
number. The 32 bits are grouped into four octets (8 binary bits), represented by 4 decimal numbers
separated by periods, or dots. The meaning of each of the four octets is determined by their use in a
particular network.
IP pool A range of local IP addresses specified by a name, and a range with a starting IP address and an ending
address. IP pools are used by DHCP and VPNs to assign local IP addresses to clients on the inside
interface.
IPsec IP Security. A framework of open standards that provides data confidentiality, data integrity, and data
authentication between participating peers. IPsec provides these security services at the IP layer. IPsec
uses IKE to handle the negotiation of protocols and algorithms based on local policy and to generate
the encryption and authentication keys to be used by IPsec. IPsec can protect one or more data flows
between a pair of hosts, between a pair of security gateways, or between a security gateway and a host.
IPsec Phase 1 The first phase of negotiating IPsec, includes the key exchange and the ISAKMP portions of IPsec.
IPsec Phase 2 The second phase of negotiating IPsec. Phase 2 determines the type of encryption rules used for
payload, the source and destination that will be used for encryption, the definition of interesting traffic
according to access lists, and the IPsec peer. IPsec is applied to the interface in Phase 2.
IPsec transform set A transform set specifies the IPsec protocol, encryption algorithm, and hash algorithm to use on traffic
matching the IPsec policy. A transform describes a security protocol (AH or ESP) with its
corresponding algorithms. The IPsec protocol used in almost all transform sets is ESP with the DES
algorithm and HMAC-SHA for authentication.
ISAKMP Internet Security Association and Key Management Protocol. A protocol framework that defines
payload formats, the mechanics of implementing a key exchange protocol, and the negotiation of a
security association. See IKE.
ISP Internet Service Provider. An organization that provides connection to the Internet via their services,
such as modem dial in over telephone voice lines or DSL.
J
JTAPI Java Telephony Application Programming Interface. A Java-based API supporting telephony
functions. See also TAPI.
Glossary
GL-11
Cisco ASA 5500 Series Configuration Guide using the CLI
K
key A data object used for encryption, decryption, or authentication.
L
L2TP Layer Two Tunneling Protocol. An IETF standards track protocol defined in RFC 2661 that provides
tunneling of PPP. L2TP is an extension to the PPP. L2TP merges the older Cisco Layer Two
Forwarding (L2F) protocol with PPTP. L2TP can be used with IPsec encryption and is considered
more secure against attack than PPTP.
LAN Local area network. A network residing in one location, such as a single building or campus. See also
Internet, intranet, and network.
layer, layers Networking models implement layers with which different protocols are associated. The most
common networking model is the OSI model, which consists of the following seven layers, in order:
physical, data link, network, transport, session, presentation, and application.
LCN Logical channel number.
LDAP Lightweight Directory Access Protocol. LDAP provides management and browser applications with
access to X.500 directories.
M
mask A 32-bit mask that shows how an Internet address is divided into network, subnet, and host parts. The
mask has ones in the bit positions to be used for the network and subnet parts, and zeros for the host
part. The mask should contain at least the standard network portion, and the subnet field should be
contiguous with the network portion.
MCR See multicast.
MC router Multicast (MC) routers route multicast data transmissions to the hosts on each LAN in an internetwork
that are registered to receive specific multimedia or other broadcasts. See also multicast.
MD5 Message Digest 5. A one-way hashing algorithm that produces a 128-bit hash. Both MD5 and SHA-1
are variations on MD4 and are designed to strengthen the security of the MD4 hashing algorithm.
SHA-1 is more secure than MD4 and MD5. Cisco uses hashes for authentication within the IPsec
framework. Also used for message authentication in SNMP v.2. MD5 verifies the integrity of the
communication, authenticates the origin, and checks for timeliness. MD5 has a smaller digest and is
considered to be slightly faster than SHA-1.
MDI media dependent interface.
MDIX media dependent interface crossover.
message digest A message digest is created by a hash algorithm, such as MD5 or SHA-1, that is used for ensuring
message integrity.
Glossary
GL-12
Cisco ASA 5500 Series Configuration Guide using the CLI
MGCP Media Gateway Control Protocol. Media Gateway Control Protocol is a protocol for the control of
VoIP calls by external call-control elements known as media gateway controllers or call agents. MGCP
merges the IPDC and SGCP protocols.
Mode See Access Modes.
Mode Config See IKE Mode Configuration.
Modular Policy
Framework
A means of configuring ASA features in a manner similar to Cisco IOS software Modular QoS CLI.
MS mobile station. Refers generically to any mobile device, such as a mobile handset or computer, that is
used to access network services. GPRS networks support three classes of MS, which describe the type
of operation supported within the GPRS and the GSM mobile wireless networks. For example, a Class
A MS supports simultaneous operation of GPRS and GSM services.
MS-CHAP Microsoft CHAP.
MTU maximum transmission unit. The maximum number of bytes in a packet that can flow efficiently
across the network with best response time. For Ethernet, the default MTU is 1500 bytes, but each
network can have different values, with serial connections having the smallest values. The MTU is
described in RFC 1191.
multicast Refers to a network addressing method in which the source transmits a packet to multiple destinations,
a multicast group, simultaneously. See also PIM, SMR.
N
N2H2 A third-party, policy-oriented filtering application that works with the ASA to control user web
access. N2H2 can filter HTTP requests based on the destination hostname, destination IP address,
username, and password. The N2H2 corporation was acquired by Secure Computing in October, 2003.
NAT Network Address Translation. Mechanism for reducing the need for globally unique IP addresses.
NAT allows an organization with addresses that are not globally unique to connect to the Internet by
translating those addresses into a globally routable address space.
NEM Network Extension Mode. Lets VPN hardware clients present a single, routable network to the remote
private network over the VPN tunnel.
NetBIOS Network Basic Input/Output System. A Microsoft protocol that supports Windows hostname
registration, session management, and data transfer. The ASA supports NetBIOS by performing NAT
of the packets for NBNS UDP port 137 and NBDS UDP port 138.
netmask See mask.
network In the context of ASA configuration, a network is a group of computing devices that share part of an
IP address space and not a single host. A network consists of multiple nodes or hosts. See also host,
Internet, intranet, IP, LAN, and node.
NMS network management system. System responsible for managing at least part of a network. An NMS is
generally a reasonably powerful and well-equipped computer, such as an engineering workstation.
NMSs communicate with agents to help keep track of network statistics and resources.
Glossary
GL-13
Cisco ASA 5500 Series Configuration Guide using the CLI
node Devices such as routers and printers that would not normally be called hosts. See also host, network.
nonvolatile storage,
memory
Storage or memory that, unlike RAM, retains its contents without power. Data in a nonvolatile storage
device survives a power-off, power-on cycle.
NSAPI network service access point identifier. One of two components of a GTP tunnel ID, the other
component being the IMSI. See also IMSI.
NSSA not-so-stubby-area. An OSPF feature described by RFC 1587. NSSA was first introduced in Cisco
IOS software release 11.2. It is a nonproprietary extension of the existing stub area feature that allows
the injection of external routes in a limited fashion into the stub area.
NTLM NT Lan Manager. A Microsoft Windows challenge-response authentication method.
NTP Network Time Protocol.
O
Oakley A key exchange protocol that defines how to acquire authenticated keying material. The basic
mechanism for Oakley is the Diffie-Hellman key exchange algorithm. Oakley is defined in RFC 2412.
object grouping Simplifies access control by letting you apply access control statements to groups of network objects,
such as protocol, services, hosts, and networks.
OSPF Open Shortest Path First. OSPF is a routing protocol for IP networks. OSPF is a routing protocol
widely deployed in large networks because of its efficient use of network bandwidth and its rapid
convergence after changes in topology. The ASA supports OSPF.
OU Organizational Unit. An X.500 directory attribute.
outbound Refers to traffic whose destination is on an interface with lower security than the source interface.
outbound ACL An ACL applied to outbound traffic.
outside The first interface, usually port 0, that connects to other untrusted networks outside the ASA; the
Internet. See also interface, interface name, outbound.
P
PAC PPTP Access Concentrator. A device attached to one or more PSTN or ISDN lines capable of PPP
operation and of handling the PPTP protocol. The PAC needs to implement TCP/IP to pass traffic to
one or more PNSs. It may also tunnel non-IP protocols.
PAT See Dynamic PAT, interface PAT, and Static PAT.
PDP Packet Data Protocol.
Perfmon The ASA feature that gathers and reports a wide variety of feature statistics, such as
connections/second, xlates/second, and so on.
Glossary
GL-14
Cisco ASA 5500 Series Configuration Guide using the CLI
PFS Perfect Forwarding Secrecy. PFS enhances security by using a different security key for the IPsec
Phase 1 and Phase 2 SAs. Without PFS, the same security key is used to establish SAs in both phases.
PFS ensures that a given IPsec SA key was not derived from any other secret (like some other keys).
In other words, if someone were to break a key, PFS ensures that the attacker would not be able to
derive any other key. If PFS were not enabled, someone could hypothetically break the IKE SA secret
key, copy all the IPsec protected data, and then use knowledge of the IKE SA secret to compromise
the IPsec SA setup by this IKE SA. With PFS, breaking IKE would not give an attacker immediate
access to IPsec. The attacker would have to break each IPsec SA individually.
Phase 1 See IPsec Phase 1.
Phase 2 See IPsec Phase 2.
PIM Protocol Independent Multicast. PIM provides a scalable method for determining the best paths for
distributing a specific multicast transmission to a group of hosts. Each host has registered using IGMP
to receive the transmission. See also PIM-SM.
PIM-SM Protocol Independent Multicast-Sparse Mode. With PIM-SM, which is the default for Cisco routers,
when the source of a multicast transmission begins broadcasting, the traffic is forwarded from one MC
router to the next, until the packets reach every registered host. See also PIM.
ping An ICMP request sent by a host to determine if a second host is accessible.
PIX Private Internet eXchange. The Cisco PIX 500 series ASAs ranged from compact, plug-and-play
desktop models for small/home offices to carrier-class gigabit models for the most demanding
enterprise and service provider environments. Cisco PIX ASAs provided robust, enterprise-class
integrated network security services to create a strong multilayered defense for fast changing network
environments. The PIX has been replaced by the Cisco ASA 5500 series.
PKCS12 A standard for the transfer of PKI-related data, such as private keys, certificates, and other data.
Devices supporting this standard let administrators maintain a single set of personal identity
information.
PNS PPTP Network Server. A PNS is envisioned to operate on general-purpose computing/server
platforms. The PNS handles the server side of PPTP. Because PPTP relies completely on TCP/IP and
is independent of the interface hardware, the PNS may use any combination of IP interface hardware
including LAN and WAN devices.
Policy NAT Lets you identify local traffic for address translation by specifying the source and destination
addresses (or ports) in an access list.
POP Post Office Protocol. Protocol that client e-mail applications use to retrieve mail from a mail server.
Pool See IP pool.
Port A field in the packet headers of TCP and UDP protocols that identifies the higher level service which
is the source or destination of the packet.
PPP Point-to-Point Protocol. Developed for dial-up ISP access using analog phone lines and modems.
PPPoE Point-to-Point Protocol over Ethernet. An IP protocol that encapsulates PPP packets and sends them
over a local network or the internet to establish a connection to a host, usually between a client and
an ISP.
Glossary
GL-15
Cisco ASA 5500 Series Configuration Guide using the CLI
PPTP Point-to-Point Tunneling Protocol. PPTP was introduced by Microsoft to provide secure remote
access to Windows networks; however, because it is vulnerable to attack, PPTP is commonly used
only when stronger security methods are not available or are not required. PPTP Ports are pptp,
1723/tcp, 1723/udp, and pptp. For more information about PPTP, see RFC 2637. See also PAC, PPTP
GRE, PPTP GRE tunnel, PNS, PPTP session, and PPTP TCP.
PPTP GRE Version 1 of GRE for encapsulating PPP traffic.
PPTP GRE tunnel A tunnel defined by a PNS-PAC pair. The tunnel protocol is defined by a modified version of GRE.
The tunnel carries PPP datagrams between the PAC and the PNS. Many sessions are multiplexed on a
single tunnel. A control connection operating over TCP controls the establishment, release, and
maintenance of sessions and of the tunnel itself.
PPTP session PPTP is connection-oriented. The PNS and PAC maintain the state for each user that is attached to a
PAC. A session is created when an end-to-end PPP connection is attempted between a dial-up user and
the PNS. The datagrams related to a session are sent over the tunnel between the PAC and PNS.
PPTP TCP Standard TCP session over which PPTP call control and management information is passed. The
control session is logically associated with, but separate from, the sessions being tunneled through a
PPTP tunnel.
preshared key A preshared key provides a method of IKE authentication that is suitable for networks with a limited,
static number of IPsec peers. This method is limited in scalability because the key must be configured
for each pair of IPsec peers. When a new IPsec peer is added to the network, the preshared key must
be configured for every IPsec peer with which it communicates. Using certificates and CAs provides
a more scalable method of IKE authentication.
primary, primary
unit
The ASA normally operating when two units, a primary and secondary, are operating in failover mode.
privileged EXEC
mode
The highest privilege level at the ASA CLI. Any user EXEC mode command will work in privileged
EXEC mode. The privileged EXEC mode prompt appears as follows after you enter the enable
command:
hostname> enable
hostname#
See also command-specific configuration mode, global configuration mode, user EXEC mode.
protocol, protocol
literals
A standard that defines the exchange of packets between network nodes for communication. Protocols
work together in layers. Protocols are specified in the ASA configuration as part of defining a security
policy by their literal values or port numbers. Possible ASA protocol literal values are ahp, eigrp, esp,
gre, icmp, igmp, igrp, ip, ipinip, ipsec, nos, ospf, pcp, snp, tcp, and udp.
Proxy-ARP Enables the ASA to reply to an ARP request for IP addresses in the global pool. See also ARP.
public key A public key is one of a pair of keys that are generated by devices involved in public key infrastructure.
Data encrypted with a public key can only be decrypted using the associated private key. When a
private key is used to produce a digital signature, the receiver can use the public key of the sender to
verify that the message was signed by the sender. These characteristics of key pairs provide a scalable
and secure method of authentication over an insecure media, such as the Internet.
Glossary
GL-16
Cisco ASA 5500 Series Configuration Guide using the CLI
Q
QoS quality of service. Measure of performance for a transmission system that reflects its transmission
quality and service availability.
R
RA Registration Authority. An authorized proxy for a CA. RAs can perform certificate enrollment and can
issue CRLs. See also CA, certificate, public key.
RADIUS Remote Authentication Dial-In User Service. RADIUS is a distributed client/server system that
secures networks against unauthorized access. RFC 2058 and RFC 2059 define the RADIUS protocol
standard. See also AAA and TACACS+.
refresh Retrieve the running configuration from the ASA and update the screen. The icon and the button
perform the same function.
registration
authority
See RA.
replay-detection A security service where the receiver can reject old or duplicate packets to defeat replay attacks.
Replay attacks rely on the attacker sending out older or duplicate packets to the receiver and the
receiver thinking that the bogus traffic is legitimate. Replay-detection is done by using sequence
numbers combined with authentication and is a standard feature of IPsec.
RFC Request for Comments. RFC documents define protocols and standards for communications over the
Internet. RFCs are developed and published by IETF.
RIP Routing Information Protocol. Interior Gateway Protocol (IGP) supplied with UNIX BSD systems.
The most common IGP in the Internet. RIP uses hop count as a routing metric.
RLLA Reserved Link Local Address. Multicast addresses range from 224.0.0.0 to 239.255.255.255; however
only the range 224.0.1.0 to 239.255.255.255 is available to users. The first part of the multicast
address range, 224.0.0.0 to 224.0.0.255, is reserved and referred to as the RLLA. These addresses are
unavailable.
route, routing The path through a network.
routed firewall
mode
In routed firewall mode, the ASA is counted as a router hop in the network. It performs NAT between
connected networks and can use OSPF or RIP. See also transparent firewall mode.
RPC Remote Procedure Call. RPCs are procedure calls that are built or specified by clients and executed
on servers, with the results returned over the network to the clients.
RSA A public key cryptographic algorithm (named after its inventors, Rivest, Shamir, and Adelman) with
a variable key length. The main weakness of RSA is that it is significantly slow to compute compared
to popular secret-key algorithms, such as DES. The Cisco implementation of IKE uses a
Diffie-Hellman exchange to get the secret keys. This exchange can be authenticated with RSA (or
preshared keys). With the Diffie-Hellman exchange, the DES key never crosses the network (not even
in encrypted form), which is not the case with the RSA encrypt and sign technique. RSA is not public
domain, and must be licensed from RSA Data Security.
Glossary
GL-17
Cisco ASA 5500 Series Configuration Guide using the CLI
RSH Remote Shell. A protocol that allows a user to execute commands on a remote system without having
to log in to the system. For example, RSH can be used to remotely examine the status of a number of
access servers without connecting to each communication server, executing the command, and then
disconnecting from the communication server.
RTCP RTP Control Protocol. Protocol that monitors the QoS of an IPv6 RTP connection and conveys
information about the ongoing session. See also RTP.
RTP Real-Time Transport Protocol. Commonly used with IP networks. RTP is designed to provide
end-to-end network transport functions for applications transmitting real-time data, such as audio,
video, or simulation data, over multicast or unicast network services. RTP provides such services as
payload type identification, sequence numbering, timestamping, and delivery monitoring to real-time
applications.
RTSP Real Time Streaming Protocol. Enables the controlled delivery of real-time data, such as audio and
video. RTSP is designed to work with established protocols, such as RTP and HTTP.
rule Conditional statements added to the ASA configuration to define security policy for a particular
situation. See also ACE, ACL, NAT.
running
configuration
The configuration currently running in RAM on the ASA. The configuration that determines the
operational characteristics of the ASA.
S
SA security association. An instance of security policy and keying material applied to a data flow. SAs
are established in pairs by IPsec peers during both phases of IPsec. SAs specify the encryption
algorithms and other security parameters used to create a secure tunnel. Phase 1 SAs (IKE SAs)
establish a secure tunnel for negotiating Phase 2 SAs. Phase 2 SAs (IPsec SAs) establish the secure
tunnel used for sending user data. Both IKE and IPsec use SAs, although SAs are independent of one
another. IPsec SAs are unidirectional and they are unique in each security protocol. A set of SAs are
needed for a protected data pipe, one per direction per protocol. For example, if you have a pipe that
supports ESP between peers, one ESP SA is required for each direction. SAs are uniquely identified
by destination (IPsec endpoint) address, security protocol (AH or ESP), and Security Parameter Index.
IKE negotiates and establishes SAs on behalf of IPsec. A user can also establish IPsec SAs manually.
An IKE SA is used by IKE only, and unlike the IPsec SA, it is bidirectional.
SCCP Skinny Client Control Protocol. A Cisco-proprietary protocol used between Cisco Call Manager and
Cisco VoIP phones.
SCEP Simple Certificate Enrollment Protocol. A method of requesting and receiving (also known as
enrolling) certificates from CAs.
SDP Session Definition Protocol. An IETF protocol for the definition of Multimedia Services. SDP
messages can be part of SGCP and MGCP messages.
secondary unit The backup ASA when two are operating in failover mode.
secret key A secret key is a key shared only between the sender and receiver. See key, public key.
Glossary
GL-18
Cisco ASA 5500 Series Configuration Guide using the CLI
security context You can partition a single ASA into multiple virtual firewalls, known as security contexts. Each
context is an independent firewall, with its own security policy, interfaces, and administrators.
Multiple contexts are similar to having multiple stand-alone firewalls.
security services See cryptography.
serial transmission A method of data transmission in which the bits of a data character are transmitted sequentially over
a single channel.
SGCP Simple Gateway Control Protocol. Controls VoIP gateways by an external call control element (called
a call-agent).
SGSN Serving GPRS Support Node. The SGSN ensures mobility management, session management, and
packet relaying functions.
SHA-1 Secure Hash Algorithm 1. SHA-1 [NIS94c] is a revision to SHA that was published in 1994. SHA is
closely modeled after MD4 and produces a 160-bit digest. Because SHA produces a 160-bit digest, it
is more resistant to brute-force attacks than 128-bit hashes (such as MD5), but it is slower. Secure
Hash Algorithm 1 is a joint creation of the National Institute of Standards and Technology and the
National Security Agency. This algorithm, like other hash algorithms, is used to generate a hash value,
also known as a message digest, that acts like a CRC used in lower-layer protocols to ensure that
message contents are not changed during transmission. SHA-1 is generally considered more secure
than MD5.
SIP Session Initiation Protocol. Enables call handling sessions, particularly two-party audio conferences,
or calls. SIP works with SDP for call signaling. SDP specifies the ports for the media stream. Using
SIP, the ASA can support any SIP VoIP gateways and VoIP proxy servers.
site-to-site VPN A site-to-site VPN is established between two IPsec peers that connect remote networks into a single
VPN. In this type of VPN, neither IPsec peer is the destination nor source of user traffic. Instead, each
IPsec peer provides encryption and authentication services for hosts on the LANs connected to each
IPsec peer. The hosts on each LAN send and receive data through the secure tunnel established by the
pair of IPsec peers.
SKEME A key exchange protocol that defines how to derive authenticated keying material, with rapid key
refreshment.
SMR Stub Multicast Routing. SMR allows the ASA to function as a stub router. A stub router is a device
that acts as an IGMP proxy agent. IGMP is used to dynamically register specific hosts in a multicast
group on a particular LAN with a multicast router. Multicast routers route multicast data transmissions
to hosts that are registered to receive specific multimedia or other broadcasts. A stub router forwards
IGMP messages between hosts and MC routers.
SMTP Simple Mail Transfer Protocol. SMTP is an Internet protocol that supports email services.
SNMP Simple Network Management Protocol. A standard method for managing network devices using data
structures called Management Information Bases.
split tunneling Allows a remote VPN client simultaneous encrypted access to a private network and clear unencrypted
access to the Internet. If you do not enable split tunneling, all traffic between the VPN client and the
ASA is sent through an IPsec tunnel. All traffic originating from the VPN client is sent to the outside
interface through a tunnel, and client access to the Internet from its remote site is denied.
Glossary
GL-19
Cisco ASA 5500 Series Configuration Guide using the CLI
spoofing A type of attack designed to foil network security mechanisms such as filters and access lists. A
spoofing attack sends a packet that claims to be from an address from which it was not actually sent.
SQL*Net Structured Query Language Protocol. An Oracle protocol used to communicate between client and
server processes.
SSC Security Services Card for the ASA 5505. For example, the AIP SSC.
SSH Secure Shell. An application running on top of a reliable transport layer, such as TCP/IP, that provides
strong authentication and encryption capabilities.
SSL Secure Sockets Layer. A protocol that resides between the application layer and TCP/IP to provide
transparent encryption of data traffic.
SSM Security Services Module. For example, the AIP SSM or CSC SSM.
standby unit See secondary unit.
stateful inspection Network protocols maintain certain data, called state information, at each end of a network connection
between two hosts. State information is necessary to implement the features of a protocol, such as
guaranteed packet delivery, data sequencing, flow control, and transaction or session IDs. Some of the
protocol state information is sent in each packet while each protocol is being used. For example, a
browser connected to a web server uses HTTP and supporting TCP/IP protocols. Each protocol layer
maintains state information in the packets it sends and receives. The ASA and some other firewalls
inspect the state information in each packet to verify that it is current and valid for every protocol it
contains. This feature is called stateful inspection and is designed to create a powerful barrier to
certain types of computer security threats.
Static PAT Static Port Address Translation. Static PAT is a static address that also maps a local port to a global
port. See also Dynamic PAT, NAT.
subnetmask See mask.
T
TACACS+ Terminal Access Controller Access Control System Plus. A client-server protocol that supports AAA
services, including command authorization. See also AAA, RADIUS.
TAPI Telephony Application Programming Interface. A programming interface in Microsoft Windows that
supports telephony functions.
TCP Transmission Control Protocol. Connection-oriented transport layer protocol that provides reliable
full-duplex data transmission.
Glossary
GL-20
Cisco ASA 5500 Series Configuration Guide using the CLI
TCP Intercept With the TCP intercept feature, once the optional embryonic connection limit is reached, and until the
embryonic connection count falls below this threshold, every SYN bound for the affected server is
intercepted. For each SYN, the ASA responds on behalf of the server with an empty SYN/ACK
segment. The ASA retains pertinent state information, drops the packet, and waits for the client
acknowledgment. If the ACK is received, a copy of the client SYN segment is sent to the server and
the TCP three-way handshake is performed between the ASA and the server. If this three-way
handshake completes, the connection may resume as normal. If the client does not respond during any
part of the connection phase, then the ASA retransmits the necessary segment using exponential
back-offs.
TDP Tag Distribution Protocol. TDP is used by tag switching devices to distribute, request, and release tag
binding information for multiple network layer protocols in a tag switching network. TDP does not
replace routing protocols. Instead, it uses information learned from routing protocols to create tag
bindings. TDP is also used to open, monitor, and close TDP sessions and to indicate errors that occur
during those sessions. TDP operates over a connection-oriented transport layer protocol with
guaranteed sequential delivery (such as TCP). The use of TDP does not preclude the use of other
mechanisms to distribute tag binding information, such as piggybacking information on other
protocols.
Telnet A terminal emulation protocol for TCP/IP networks such as the Internet. Telnet is a common way to
control web servers remotely; however, its security vulnerabilities have led to its replacement by SSH.
TFTP Trivial File Transfer Protocol. TFTP is a simple protocol used to transfer files. It runs on UDP and is
explained in depth in RFC 1350.
TID Tunnel Identifier.
TLS Transport Layer Security. A future IETF protocol to replace SSL.
traffic policing The traffic policing feature ensures that no traffic exceeds the maximum rate (bits per second) that you
configure, which ensures that no one traffic flow can take over the entire resource.
transform set See IPsec transform set.
translate,
translation
See xlate.
transparent firewall
mode
A mode in which the ASA is not a router hop. You can use transparent firewall mode to simplify your
network configuration or to make the ASA invisible to attackers. You can also use transparent firewall
mode to allow traffic through that would otherwise be blocked in routed firewall mode. See also routed
firewall mode.
transport mode An IPsec encryption mode that encrypts only the data portion (payload) of each packet but leaves the
header untouched. Transport mode is less secure than tunnel mode.
TSP TAPI Service Provider. See also TAPI.
tunnel mode An IPsec encryption mode that encrypts both the header and data portion (payload) of each packet.
Tunnel mode is more secure than transport mode.
Glossary
GL-21
Cisco ASA 5500 Series Configuration Guide using the CLI
tunnel A method of transporting data in one protocol by encapsulating it in another protocol. Tunneling is
used for reasons of incompatibility, implementation simplification, or security. For example, a tunnel
lets a remote VPN client have encrypted access to a private network.
Turbo ACL Increases ACL lookup speeds by compiling them into a set of lookup tables. Packet headers are used
to access the tables in a small, fixed number of lookups, independent of the existing number of ACL
entries.
U
UDP User Datagram Protocol. A connectionless transport layer protocol in the IP protocol stack. UDP is a
simple protocol that exchanges datagrams without acknowledgments or guaranteed delivery, which
requires other protocols to handle error processing and retransmission. UDP is defined in RFC 768.
UMTS Universal Mobile Telecommunication System. An extension of GPRS networks that moves toward an
all-IP network by delivering broadband information, including commerce and entertainment services,
to mobile users via fixed, wireless, and satellite networks.
Unicast RPF Unicast Reverse Path Forwarding. Unicast RPF guards against spoofing by ensuring that packets have
a source IP address that matches the correct source interface according to the routing table.
URL Uniform Resource Locator. A standardized addressing scheme for accessing hypertext documents and
other services using a browser. For example, http://www.cisco.com.
user EXEC mode The lowest privilege level at the ASA CLI. The user EXEC mode prompt appears as follows when you
first access the ASA:
hostname>
See also command-specific configuration mode, global configuration mode, and privileged EXEC
mode.
UTC Coordinated Universal Time. The time zone at zero degrees longitude, previously called Greenwich
Mean Time (GMT) and Zulu time. UTC replaced GMT in 1967 as the world time standard. UTC is
based on an atomic time scale rather than an astronomical time scale.
UTRAN Universal Terrestrial Radio Access Network. Networking protocol used for implementing wireless
networks in UMTS. GTP allows multi-protocol packets to be tunneled through a UMTS/GPRS
backbone between a GGSN, an SGSN and the UTRAN.
UUIE User-User Information Element. An element of an H.225 packet that identifies the users implicated in
the message.
V
VLAN Virtual LAN. A group of devices on one or more LANs that are configured (using management
software) so that they can communicate as if they were attached to the same physical network cable,
when they are located on a number of different LAN segments. Because VLANs are based on logical
instead of physical connections, they are extremely flexible.
Glossary
GL-22
Cisco ASA 5500 Series Configuration Guide using the CLI
VoIP Voice over IP. VoIP carries normal voice traffic, such as telephone calls and faxes, over an IP-based
network. DSP segments the voice signal into frames, which are coupled in groups of two and stored
in voice packets. These voice packets are transported using IP in compliance with ITU-T specification
H.323.
VPN Virtual Private Network. A network connection between two peers over the public network that is
made private by strict authentication of users and the encryption of all data traffic. You can establish
VPNs between clients, such as PCs, or a headend, such as the ASA.
virtual firewall See security context.
VSA Vendor-specific attribute. An attribute in a RADIUS packet that is defined by a vendor rather than by
RADIUS RFCs. The RADIUS protocol uses IANA-assigned vendor numbers to help identify VSAs.
This lets different vendors have VSAs of the same number. The combination of a vendor number and
a VSA number makes a VSA unique. For example, the cisco-av-pair VSA is attribute 1 in the set of
VSAs related to vendor number 9. Each vendor can define up to 256 VSAs. A RADIUS packet
contains any VSAs attribute 26, named Vendor-specific. VSAs are sometimes referred to as
subattributes.
W
WAN wide-area network. Data communications network that serves users across a broad geographic area
and often uses transmission devices provided by common carriers.
WCCP Web Cache Communication Protocol. Transparently redirects selected types of traffic to a group of
web cache engines to optimize resource usage and lower response times.
Websense A content filtering solution that manages employee access to the Internet. Websense uses a policy
engine and a URL database to control user access to websites.
WEP Wired Equivalent Privacy. A security protocol for wireless LANs, defined in the IEEE 802.11b
standard.
WINS Windows Internet Naming Service. A Windows system that determines the IP address associated with
a particular network device, also known as name resolution. WINS uses a distributed database that is
automatically updated with the NetBIOS names of network devices currently available and the IP
address assigned to each one.WINS provides a distributed database for registering and querying
dynamic NetBIOS names to IP address mapping in a routed network environment. It is the best choice
for NetBIOS name resolution in such a routed network because it is designed to solve the problems
that occur with name resolution in complex networks.
X
X.509 A widely used standard for defining digital certificates. X.509 is actually an ITU recommendation,
which means that it has not yet been officially defined or approved for standardized usage.
Glossary
GL-23
Cisco ASA 5500 Series Configuration Guide using the CLI
xauth See IKE Extended Authentication.
xlate An xlate, also referred to as a translation entry, represents the mapping of one IP address to another,
or the mapping of one IP address/port pair to another.
Glossary
GL-24
Cisco ASA 5500 Series Configuration Guide using the CLI
IN-1
Cisco ASA 5500 Series Configuration Guide using the CLI
I N D E X
Symbols
/bits subnet masks B-3
?
command string A-4
help A-4
Numerics
4GE SSM
connector types 6-12
fiber 6-12
SFP 6-12
802.1Q tagging 7-9
802.1Q trunk 6-30
A
AAA
about 35-1
accounting 38-18
addressing, configuring 68-2
authentication
CLI access 37-19
network access 38-2
privileged EXEC mode 37-19
authorization
command 37-22
downloadable access lists 38-14
network access 38-11
local database support 35-8
performance 38-1
server 77-4
adding 35-11
types 35-1
support summary 35-3
web clients 38-6
abbreviating commands A-3
ABR
definition of 24-2
Access Control Server 70-4, 70-13
Access Group pane
description 26-7
access hours, username attribute 67-81
accessing the security appliance using SSL 74-6
accessing the security appliance using TKS1 74-6
access list filter, username attribute 67-82
access lists
about 14-1
ACE logging, configuring 20-1
deny flows, managing 20-5
downloadable 38-14
exemptions from posture validation 70-11
global access rules 34-2
group policy WebVPN filter 67-74
implicit deny 14-3, 34-3
inbound 34-3
IP address guidelines 14-3
IPsec 64-27
IPv6
about 19-1
configuring 19-4
default settings 19-3
logging 20-1
NAT guidelines 14-3
Network Admission Control, default 70-10
Index
IN-2
Cisco ASA 5500 Series Configuration Guide using the CLI
object groups 13-2
outbound 34-3
phone proxy 48-7
remarks 15-5
scheduling activation 13-16
types 14-1
username for Clientless SSL VPN 67-88
access ports 7-7
ACEs
See access lists
activation key
entering 3-33
location 3-32
obtaining 3-33
Active/Active failover
about 63-1
actions 63-5
command replication 63-3
configuration synchronization 63-3
configuring
asymmetric routing support 63-18
failover criteria 63-16
failover group preemption 63-12
HTTP replication 63-14
interface monitoring 63-14
virtual MAC addresses 63-16
device initialization 63-3
duplicate MAC addresses, avoiding 63-2, 63-17
optional settings
about 63-6
configuring 63-12
primary status 63-2
secondary status 63-2
triggers 63-4
Active/Standby failover
about 62-1
actions 62-4
command replication 62-3
configuration synchronization 62-2
device initialization 62-2
primary unit 62-2
secondary unit 62-2
triggers 62-4
Active Directory, settings for password
management 67-28
Active Directory procedures C-16 to ??
ActiveX filtering 39-2
Adaptive Security Algorithm 1-27
Add/Edit Access Group dialog box
description 26-7
Add/Edit IGMP Join Group dialog box
description 26-6
Add/Edit OSPF Neighbor Entry dialog box 24-12
admin context
about 5-2
changing 5-24
administrative access
using ICMP for 37-11
administrative distance 22-3, 22-5
Advanced Encryption Standard (AES) 64-9, 64-10
AIP
See IPS module
AIP SSC
loading an image 58-21, 58-23, 60-14
AIP SSM
about 58-1
loading an image 58-21, 58-23, 60-14
port-forwarding
enabling 8-6, 9-8
alternate address, ICMP message B-15
analyzing syslog messages 77-2
Application Access Panel, WebVPN 74-88
application access using Clientless SSL VPN
group policy attribute for Clientless SSL VPN 67-75
username attribute for Clientless SSL VPN 67-89
application access using WebVPN
and hosts file errors 74-72
quitting properly 74-73
Index
IN-3
Cisco ASA 5500 Series Configuration Guide using the CLI
application inspection
about 42-1
applying 42-6
configuring 42-6
inspection class map 33-6
inspection policy map 33-2
security level requirements 8-2, 9-2
special actions 33-1
Application Profile Customization Framework 74-84
area border router 24-2
ARP
NAT 29-22
ARP inspection
about 4-10
enabling 4-12
static entry 4-11
ARP spoofing 4-10
ARP test, failover 61-15
ASA (Adaptive Security Algorithm) 1-27
ASA 5505
Base license 7-2
client
authentication 71-12
configuration restrictions, table 71-2
device pass-through 71-8
group policy attributes pushed to 71-10
mode 71-3
remote management 71-9
split tunneling 71-8
TCP 71-4
trustpoint 71-7
tunnel group 71-7
tunneling 71-5
Xauth 71-4
MAC addresses 7-4
maximum VLANs 7-2
native VLAN support 7-10
non-forwarding interface 7-7
power over Ethernet 7-4
protected switch ports 7-8, 7-10
Security Plus license 7-2
server (headend) 71-1
SPAN 7-4
Spanning Tree Protocol, unsupported 7-8
ASA 5550 throughput 8-6, 9-9
ASA CX module
about 59-1
ASA feature compatibility 59-4
authentication proxy
about 59-3
port 59-10
troubleshooting 59-20
basic settings 59-7
cabling 59-6
configuration 59-6
debugging 59-19
failover 59-5
licensing 59-4
management access 59-2
management defaults 59-5
management IP address 59-7
monitoring 59-12
password reset 59-17
PRSM 59-3
reload 59-18
security policy 59-9
sending traffic to 59-11
shutdown 59-19
traffic flow 59-2
VPN 59-4
ASBR
definition of 24-2
ASDM software
allowing access 37-6
installing 81-2
ASR 63-18
asymmetric routing
TCP state bypass 53-4
Index
IN-4
Cisco ASA 5500 Series Configuration Guide using the CLI
asymmetric routing support 63-18
attacks
DNS request for all records 57-10
DNS zone transfer 57-10
DNS zone transfer from high port 57-10
fragmented ICMP traffic 57-6, 57-9
IP fragment 57-4, 57-7
IP impossible packet 57-4, 57-7
large ICMP traffic 57-6, 57-9
ping of death 57-6, 57-9
proxied RPC request 57-10
statd buffer overflow 57-11
TCP NULL flags 57-6, 57-9
TCP SYN+FIN flags 57-6, 57-9
attributes
RADIUS C-27
username 67-80
attribute-value pairs
TACACS+ C-38
attribute-value pairs (AVP) 67-36
authentication
about 35-2
ASA 5505 as Easy VPN client 71-12
CLI access 37-19
FTP 38-3
HTTP 38-3
network access 38-2
privileged EXEC mode 37-19
Telnet 38-3
web clients 38-6
WebVPN users with digital certificates 74-28, 74-29
authorization
about 35-2
command 37-22
downloadable access lists 38-14
network access 38-11
Auto-MDI/MDIX 6-2, 7-4
auto-signon
group policy attribute for Clientless SSL VPN 67-73
username attribute for Clientless SSL VPN 67-91
Auto-Update, configuring 81-16
B
backup server attributes, group policy 67-56
Baltimore Technologies, CA server support 41-4
banner message, group policy 67-48
basic threat detection
See threat detection
before configuring KCD 74-44
bits subnet masks B-3
Black Ice firewall 67-67
Botnet Traffic Filter
actions 55-2
address categories 55-2
blacklist
adding entries 55-9
description 55-2
blocking traffic manually 55-15
classifying traffic 55-12
configuring 55-6
databases 55-2
default settings 55-6
DNS Reverse Lookup Cache
information about 55-4
maximum entries 55-4
using with dynamic database 55-10
DNS snooping 55-10
dropping traffic 55-13
graylist 55-13
dynamic database
enabling use of 55-7
files 55-3
information about 55-2
searching 55-16
updates 55-7
examples 55-19
feature history 55-22
Index
IN-5
Cisco ASA 5500 Series Configuration Guide using the CLI
graylist
description 55-2
dropping traffic 55-13
guidelines and limitations 55-6
information about 55-1
licensing 55-6
monitoring 55-17
static database
adding entries 55-9
information about 55-3
syslog messages 55-17
task flow 55-7
threat level
dropping traffic 55-13
whitelist
adding entries 55-9
description 55-2
working overview 55-5
bridge
entry timeout 4-15
table, See MAC address table
broadcast Ping test 61-15
building blocks 13-1
bypass authentication 71-8
bypassing firewall checks 53-3
C
CA
certificate validation, not done in WebVPN 74-5
CRs and 41-2
public key cryptography 41-2
revoked certificates 41-2
supported servers 41-4
cached Kerberos tickets
clearing 74-48
showing 74-47
caching 74-81
capturing packets 82-14
cascading access lists 64-23
CA server
Digicert 41-4
Geotrust 41-4
Godaddy 41-4
iPlanet 41-4
Netscape 41-4
RSA Keon 41-4
Thawte 41-4
certificate
authentication, e-mail proxy 74-79
Cisco Unified Mobility 50-5
Cisco Unified Presence 51-4
enrollment protocol 41-11
group matching
configuring 64-17
rule and policy, creating 64-17
Certificate Revocation Lists
See CRLs
certificates
phone proxy 48-15
required by phone proxy 48-16
change query interval 26-8
change query response time 26-8
change query timeout value 26-8
changing between contexts 5-23
changing the severity level 77-18
Cisco-AV-Pair LDAP attributes C-13
Cisco Integrated Firewall 67-66
Cisco IOS CS CA
server support 41-4
Cisco IP Communicator 48-10
Cisco IP Phones
DHCP 11-6
Cisco IP Phones, application inspection 44-25
Cisco Security Agent 67-66
Cisco Trust Agent 70-13
Cisco UMA. See Cisco Unified Mobility.
Cisco Unified Mobility
Index
IN-6
Cisco ASA 5500 Series Configuration Guide using the CLI
architecture 50-2
ASA role 47-2, 47-3
certificate 50-5
functionality 50-1
NAT and PAT requirements 50-3, 50-4
trust relationship 50-5
Cisco Unified Presence
ASA role 47-2, 47-3
configuring the TLS Proxy 51-8
debugging the TLS Proxy 51-14
NAT and PAT requirements 51-2
sample configuration 51-14
trust relationship 51-4
Cisco UP. See Cisco Unified Presence.
Class A, B, and C addresses B-1
class-default class map 32-9
classes, logging
filtering messages by 77-16
message class variables 77-4
types 77-4
classes, resource
See resource management
class map
inspection 33-6
Layer 3/4
management traffic 32-14
match commands 32-12, 32-15
through traffic 32-12
regular expression 13-15
clearing cached Kerberos tickets 74-48
CLI
abbreviating commands A-3
adding comments A-5
command line editing A-3
command output paging A-5
displaying A-5
help A-4
paging A-5
syntax formatting A-3
client
VPN 3002 hardware, forcing client update 66-4
Windows, client update notification 66-4
client access rules, group policy 67-68
client firewall, group policy 67-63
clientless authentication 70-13
Clientless SSL VPN
configuring for specific users 67-85
client mode 71-3
client update, performing 66-4
cluster
IP address, load balancing 66-6
load balancing configurations 66-9
mixed scenarios 66-10
virtual 66-6
command authorization
about 37-14
configuring 37-22
multiple contexts 37-16
command prompts A-2
comments
configuration A-5
configuration
clearing 2-18
comments A-5
factory default
commands 2-10
restoring 2-11
saving 2-16
text file 2-19
URL for a context 5-21
viewing 2-18
configuration examples
CSC SSM 60-16
logging 77-20
configuration examples for SNMP 79-28
configuration mode
accessing 2-2
prompt A-2
Index
IN-7
Cisco ASA 5500 Series Configuration Guide using the CLI
connection blocking 57-2
connection limits
configuring 53-1
per context 5-17
connect time, maximum, username attribute 67-82
console port logging 77-11
content transformation, WebVPN 74-82
context mode 27-2
context modes 22-2, 23-3, 24-3, 25-3, 26-3, 60-6
contexts
See security contexts
conversion error, ICMP message B-15
cookies, enabling for WebVPN 74-10
copying files using copy smb
command 81-8
Coredump 82-14
CRACK protocol 64-35
crash dump 82-14
creating a custom event list 77-13
crypto map
acccess lists 64-27
applying to interfaces 64-26, 73-10
clearing configurations 64-35
creating an entry to use the dynamic crypto map 69-13
definition 64-20
dynamic 64-32
dynamic, creating 69-12
entries 64-20
examples 64-28
policy 64-21
crypto show commands table 64-34
CSC SSM
about 60-1
loading an image 58-21, 58-23, 60-14
sending traffic to 60-10
what to scan 60-3
CSC SSM feature history 60-18
custom firewall 67-67
customization, Clientless SSL VPN
group policy attribute 67-71
login windows for users 67-27
username attribute 67-87
username attribute for Clientless SSL VPN 67-24
custom messages list
logging output destination 77-4
cut-through proxy
AAA performance 38-1
CX module
about 59-1
ASA feature compatibility 59-4
authentication proxy
about 59-3
port 59-10
troubleshooting 59-20
basic settings 59-7
cabling 59-6
configuration 59-6
debugging 59-19
failover 59-5
licensing 59-4
management access 59-2
management defaults 59-5
management IP address 59-7
monitoring 59-12
password reset 59-17
PRSM 59-3
reload 59-18
security policy 59-9
sending traffic to 59-11
shutdown 59-19
traffic flow 59-2
VPN 59-4
D
data flow
routed firewall 4-17
transparent firewall 4-23
Index
IN-8
Cisco ASA 5500 Series Configuration Guide using the CLI
date and time in messages 77-18
DDNS 12-2
debug messages 82-13
default
class 5-9
DefaultL2Lgroup 67-1
DefaultRAgroup 67-1
domain name, group policy 67-51
group policy 67-1, 67-8, 67-36
LAN-to-LAN tunnel group 67-17
remote access tunnel group, configuring 67-7
routes, defining equal cost routes 22-4
tunnel group 64-19, 67-2
default configuration
commands 2-10
restoring 2-11
default policy 32-7
default routes
about 22-4
configuring 22-4
delay sending flow-create events
flow-create events
delay sending 78-9
deleting files from Flash 81-2
deny flows, logging 20-5
deny in a crypto map 64-23
deny-message
group policy attribute for Clientless SSL VPN 67-71
username attribute for Clientless SSL VPN 67-87
DES, IKE policy keywords (table) 64-9, 64-10
device ID, including in messages 77-17
device ID in messages 77-17
device pass-through, ASA 5505 as Easy VPN client 71-8
DfltGrpPolicy 67-37
DHCP
addressing, configuring 68-3
Cisco IP Phones 11-6
options 11-4
relay 11-7
server 11-3
transparent firewall 34-5
DHCP Intercept, configuring 67-52
DHCP Relay panel 12-6
DHCP services 10-6
Diffie-Hellman
Group 5 64-10, 64-11
groups supported 64-10, 64-11
DiffServ preservation 54-5
digital certificates
authenticating WebVPN users 74-28, 74-29
SSL 74-11
directory hierarchy search C-3
disabling content rewrite 74-83
disabling messages 77-18
disabling messages, specific message IDs 77-18
DMZ, definition 1-24
DNS
dynamic 12-2
inspection
about 43-2
managing 43-1
rewrite, about 43-2
rewrite, configuring 43-3
NAT effect on 29-24
server, configuring 10-11, 67-40
DNS request for all records attack 57-10
DNS zone transfer attack 57-10
DNS zone transfer from high port attack 57-10
domain attributes, group policy 67-51
domain name 10-3
dotted decimal subnet masks B-3
downloadable access lists
configuring 38-14
converting netmask expressions 38-18
DSCP preservation 54-5
dual IP stack, configuring 8-2
dual-ISP support 22-6
duplex, configuring 6-11, 7-5
Index
IN-9
Cisco ASA 5500 Series Configuration Guide using the CLI
dynamic crypto map 64-32
creating 69-12
See also crypto map
Dynamic DNS 12-2
dynamic NAT
about 29-8
network object NAT 30-4
twice NAT 31-4
dynamic PAT
network object NAT 30-6
See also NAT
twice NAT 31-8
E
Easy VPN
client
authentication 71-12
configuration restrictions, table 71-2
enabling and disabling 71-1
group policy attributes pushed to 71-10
mode 71-3
remote management 71-9
trustpoint 71-7
tunnels 71-9
Xauth 71-4
server (headend) 71-1
Easy VPN client
ASA 5505
device pass-through 71-8
split tunneling 71-8
TCP 71-4
tunnel group 71-7
tunneling 71-5
echo reply, ICMP message B-15
ECMP 22-3
editing command lines A-3
egress VLAN for VPN sessions 67-44
EIGRP 34-5
DUAL algorithm 27-2
hello interval 27-13
hello packets 27-1
hold time 27-2, 27-13
neighbor discovery 27-1
stub routing 27-3
stuck-in-active 27-2
e-mail
configuring for WebVPN 74-79
proxies, WebVPN 74-79
proxy, certificate authentication 74-79
WebVPN, configuring 74-79
enable command 2-1
enabling logging 77-6
enabling secure logging 77-16
end-user interface, WebVPN, defining 74-88
Enterprises 11-6
Entrust, CA server support 41-4
established command, security level requirements 8-2, 9-2
EtherChannel
adding interfaces 6-27
channel group 6-27
compatibility 6-5
converting existing interfaces 6-13
example 6-34
failover 6-10
guidelines 6-10
interface requirements 6-5
LACP 6-6
load balancing
configuring 6-29
overview 6-7
MAC address 6-7
management interface 6-27
maximum interfaces 6-29
minimum interfaces 6-29
mode
active 6-6
on 6-7
Index
IN-10
Cisco ASA 5500 Series Configuration Guide using the CLI
passive 6-6
monitoring 6-33
overview 6-5
port priority 6-27
system priority 6-29
Ethernet
Auto-MDI/MDIX 6-2, 7-4
duplex 6-11, 7-5
jumbo frames, ASA 5580 6-32
MTU 8-11, 9-14
speed 6-11, 7-5
EtherType access list
compatibilty with extended access lists 34-2
implicit deny 34-3
evaluation license 3-21
exporting NetFlow records 78-5
extended ACLs
configuring
for management traffic 15-2
external group policy, configuring 67-39
F
facility, syslog 77-8
factory default configuration
commands 2-10
restoring 2-11
failover
about 61-1
Active/Active, See Active/Active failover
Active/Standby, See Active/Standby failover
configuration file
terminal messages, Active/Active 63-3
terminal messages, Active/Standby 62-2
contexts 62-2
debug messages 61-16
disabling 62-17, 63-24
Ethernet failover cable 61-3
failover link 61-3
forcing 62-16, 63-23
guidelines 60-6, 79-17
health monitoring 61-14
interface health 61-15
interface monitoring 61-15
interface tests 61-15
link communications 61-3
MAC addresses
about 62-2
automatically assigning 5-12
monitoring, health 61-14
network tests 61-15
primary unit 62-2
redundant interfaces 6-10
restoring a failed group 62-17, 63-24
restoring a failed unit 62-17, 63-24
secondary unit 62-2
SNMP syslog traps 61-17
Stateful Failover, See Stateful Failover
state link 61-4
system log messages 61-16
system requirements 61-2
testing 62-17, 63-24
Trusted Flow Acceleration 65-7
type selection 61-8
unit health 61-14
fast path 1-28
fiber interfaces 6-12
Fibre Channel interfaces
default settings 16-2, 17-2, 18-2, 34-7
filter (access list)
group policy attribute for Clientless SSL VPN 67-74
username attribute for Clientless SSL VPN 67-88
filtering
ActiveX 39-2
FTP 39-14
Java applet 39-4
Java applets 39-4
security level requirements 8-2, 9-2
Index
IN-11
Cisco ASA 5500 Series Configuration Guide using the CLI
servers supported 39-6
show command output A-4
URLs 39-1, 39-7
filtering messages 77-4
firewall
Black Ice 67-67
Cisco Integrated 67-66
Cisco Security Agent 67-66
custom 67-67
Network Ice 67-67
none 67-66
Sygate personal 67-67
Zone Labs 67-67
firewall mode
about 4-1
configuring 4-1
firewall policy, group policy 67-63
Flash memory
removing files 81-2
flash memory available for logs 77-15
flow control for 10 Gigabit Ethernet 6-22
flow-export actions 78-4
format of messages 77-3
fragmentation policy, IPsec 64-15
fragmented ICMP traffic attack 57-6, 57-9
fragment protection 1-25
fragment size 57-2
FTP inspection
about 43-11
configuring 43-11
G
general attributes, tunnel group 67-3
general parameters, tunnel group 67-3
general tunnel-group connection parameters 67-3
generating RSA keys 41-9
global e-mail proxy attributes 74-79
global IPsec SA lifetimes, changing 64-29
group-lock, username attribute 67-84
group policy
address pools 67-62
attributes 67-40
backup server attributes 67-56
client access rules 67-68
configuring 67-39
default domain name for tunneled packets 67-51
definition 67-1, 67-36
domain attributes 67-51
Easy VPN client, attributes pushed to ASA
5505 71-10
external, configuring 67-39
firewall policy 67-63
hardware client user idle timeout 67-54
internal, configuring 67-40
IP phone bypass 67-54
IPSec over UDP attributes 67-49
LEAP Bypass 67-55
network extension mode 67-55
security attributes 67-46
split tunneling attributes 67-49
split-tunneling domains 67-52
user authentication 67-53
VPN attributes 67-42
VPN hardware client attributes 67-53
webvpn attributes 67-70
WINS and DNS servers 67-40
group policy, default 67-36
group policy, secure unit authentication 67-53
group policy attributes for Clientless SSL VPN
application access 67-75
auto-signon 67-73
customization 67-71
deny-message 67-71
filter 67-74
home page 67-73
html-content filter 67-72
keep-alive-ignore 67-76
Index
IN-12
Cisco ASA 5500 Series Configuration Guide using the CLI
port forward 67-75
port-forward-name 67-76
sso-server 67-77
url-list 67-74
groups
SNMP 79-16
GTP inspection
about 46-3
configuring 46-3
H
H.225 timeouts 44-9
H.245 troubleshooting 44-10
H.323
transparent firewall guidelines 4-4
H.323 inspection
about 44-4
configuring 44-3
limitations 44-5
troubleshooting 44-10
hairpinning 64-26
hardware client, group policy attributes 67-53
help, command line A-4
high availability
about 61-1
HMAC hashing method 64-2, 73-3
hold-period 70-17
homepage
group policy attribute for Clientless SSL VPN 67-73
username attribute for Clientless SSL VPN 67-86
host
SNMP 79-16
hostname
configuring 10-2
in banners 10-2
multiple context mode 10-2
hosts, subnet masks for B-3
hosts file
errors 74-72
reconfiguring 74-73
WebVPN 74-72
HSRP 4-4
html-content-filter
group policy attribute for Clientless SSL VPN 67-72
username attribute for Clientless SSL VPN 67-86
HTTP
filtering 39-1
HTTP(S)
authentication 37-19
filtering 39-7
HTTP/HTTPS Web VPN proxy, setting 74-11
HTTP compression, Clientless SSL VPN, enabling 67-76,
67-91
HTTP inspection
about 43-16
configuring 43-16
HTTP redirection for login, Easy VPN client on the ASA
5505 71-12
HTTPS/Telnet/SSH
allowing network or host access to ASDM 37-1
HTTPS for WebVPN sessions 74-7
hub-and-spoke VPN scenario 64-26
I
ICMP
rules for access to ADSM 37-11
testing connectivity 82-1
type numbers B-15
identity NAT
about 29-11
network object NAT 30-12
twice NAT 31-20
idle timeout
hardware client user, group policy 67-54
username attribute 67-82
ID method for ISAKMP peers, determining 64-13
Index
IN-13
Cisco ASA 5500 Series Configuration Guide using the CLI
IKE
benefits 64-2, 73-3
creating policies 64-11
keepalive setting, tunnel group 67-4
pre-shared key, Easy VPN client on the ASA
5505 71-7
See also ISAKMP
IKEv1 64-19
ILS inspection 45-1
IM 44-19
implementing SNMP 79-16
inbound access lists 34-3
Individual user authentication 71-12
information reply, ICMP message B-15
information request, ICMP message B-15
inheritance
tunnel group 67-1
username attribute 67-81
inside, definition 1-24
inspection_default class-map 32-9
inspection engines
See application inspection
Instant Messaging inspection 44-19
intercept DHCP, configuring 67-52
interface
MTU 8-11, 9-14
interfaces
ASA 5505
enabled status 7-7
MAC addresses 7-4
maximum VLANs 7-2
non-forwarding 7-7
protected switch ports 7-8, 7-10
switch port configuration 7-7
trunk ports 7-9
ASA 5550 throughput 8-6, 9-9
configuring for remote access 69-7
default settings 16-2, 17-2, 18-2, 34-7, 60-6
duplex 6-11, 7-5
enabling 6-24
failover monitoring 61-15
fiber 6-12
IDs 6-23
IP address 8-7, 9-12
MAC addresses
automatically assigning 5-22
manually assigning to interfaces 8-11, 9-14
mapped name 5-20
naming, physical and subinterface 8-7, 9-10, 9-11
redundant 6-25
SFP 6-12
speed 6-11, 7-5
subinterfaces 6-30
internal group policy, configuring 67-40
Internet Security Association and Key Management
Protocol
See ISAKMP
IP addresses
classes B-1
configuring an assignment method for remote access
clients 68-1
configuring for VPNs 68-1
configuring local IP address pools 68-2
interface 8-7, 9-12
management, transparent firewall 9-7
private B-2
subnet mask B-4
IP fragment attack 57-4, 57-7
IP impossible packet attack 57-4, 57-7
IP overlapping fragments attack 57-5
IP phone 71-8
phone proxy provisioning 48-12
IP phone bypass, group policy 67-54
IP phones
addressing requirements for phone proxy 48-9
supported for phone proxy 48-3
IPSec
anti-replay window 54-12
Index
IN-14
Cisco ASA 5500 Series Configuration Guide using the CLI
modes 65-2
over UDP, group policy, configuring attributes 67-49
remote-access tunnel group 67-8
setting maximum active VPN sessions 66-3
IPsec
access list 64-27
basic configuration with static crypto maps 64-29
Cisco VPN Client 64-2
configuring 64-1, 64-19
crypto map entries 64-20
fragmentation policy 64-15
over NAT-T, enabling 64-14
over TCP, enabling 64-15
SA lifetimes, changing 64-29
tunnel 64-19
view configuration commands table 64-34
IPSec parameters, tunnel group 67-4
ipsec-ra, creating an IPSec remote-access tunnel 67-8
IPS module
about 58-1
configuration 58-7
operating modes 58-2
sending traffic to 58-17
traffic flow 58-2
virtual sensors 58-15
IP spoofing, preventing 57-1
IP teardrop attack 57-5
IPv6
commands 21-10
configuring alongside IPv4 8-2
default route 22-5
dual IP stack 8-2
duplicate address detection 8-12, 9-15
neighbor discovery 28-1
router advertisement messages 28-3
static neighbors 28-4
static routes 22-5
IPv6 addresses
anycast B-9
command support for 21-10
format B-5
multicast B-8
prefixes B-10
required B-10
types of B-6
unicast B-6
IPv6 prefixes 28-11
ISAKMP
about 64-2
configuring 64-1
determining an ID method for peers 64-13
disabling in aggressive mode 64-13
enabling on the outside interface 69-8
keepalive setting, tunnel group 67-4
See also IKE
J
Java applet filtering 39-4
Java applets, filtering 39-2
Java object signing 74-82
Join Group pane
description 26-6
jumbo frames, ASA 5580 6-32
K
KCD 74-41, 74-42
before configuring 74-44
KCD status
showing 74-46
keep-alive-ignore
group policy attribute for Clientless SSL VPN 67-76
username attribute for Clientless SSL VPN 67-90
Kerberos
configuring 35-11
support 35-6
Index
IN-15
Cisco ASA 5500 Series Configuration Guide using the CLI
Kerberos tickets
clearing 74-48
showing 74-47
L
L2TP description 65-1
LACP 6-6
LAN-to-LAN tunnel group, configuring 67-17
large ICMP traffic attack 57-6, 57-9
latency
about 54-1
configuring 54-2, 54-3
reducing 54-8
Layer 2 firewall
See transparent firewall
Layer 2 forwarding table
See MAC address table
Layer 2 Tunneling Protocol 65-1
Layer 3/4
matching multiple policy maps 32-6
LCS Federation Scenario 51-2
LDAP
application inspection 45-1
attribute mapping 35-18
Cisco-AV-pair C-13
configuring 35-11
configuring a AAA server C-2 to ??
directory search C-3
example configuration procedures C-16 to ??
hierarchy example C-3
SASL 35-6
user authentication 35-6
user authorization 35-16
LEAP Bypass, group policy 67-55
licenses
activation key
entering 3-33
location 3-32
obtaining 3-33
ASA 5505 3-2
ASA 5510 3-3, 3-8
ASA 5520 3-4
ASA 5540 3-5
ASA 5550 3-6
ASA 5580 3-7
ASA 5585-X 3-12, 3-13, 3-14
Cisco Unified Communications Proxy features 47-4,
49-5, 50-6, 51-7, 52-8
default 3-21
evaluation 3-21
failover 3-31
guidelines 3-31
managing 3-1
preinstalled 3-21
Product Authorization Key 3-33
shared
backup server, configuring 3-37
backup server, information 3-25
client, configuring 3-37
communication issues 3-25
failover 3-25
maximum clients 3-27
monitoring 3-44
overview 3-23
server, configuring 3-35
SSL messages 3-25
temporary 3-21
viewing current 3-38
VPN Flex 3-21
licensing requirements
CSC SSM 60-5
logging 77-5
licensing requirements for SNMP 79-17
link up/down test 61-15
LLQ
See low-latency queue
load balancing
Index
IN-16
Cisco ASA 5500 Series Configuration Guide using the CLI
cluster configurations 66-9
concepts 66-6
eligible clients 66-8
eligible platforms 66-8
implementing 66-7
mixed cluster scenarios 66-10
platforms 66-8
prerequisites 66-8
local user database
adding a user 35-20
configuring 35-20
logging in 37-20
support 35-8
lockout recovery 37-31
logging
access lists 20-1
classes
filtering messages by 77-4
types 77-4, 77-16
device-id, including in system log messages 77-17
e-mail
source address 77-10
EMBLEM format 77-14
facility option 77-8
filtering
by message class 77-16
by message list 77-4
by severity level 77-1
logging queue, configuring 77-15
output destinations 77-8
console port 77-8, 77-10, 77-11
internal buffer 77-1, 77-6
Telnet or SSH session 77-6
queue
changing the size of 77-15
configuring 77-15
viewing queue statistics 77-19
severity level, changing 77-19
timestamp, including 77-18
logging feature history 77-20
logging queue
configuring 77-15
login
banner, configuring 37-7
console 2-1
enable 2-1
FTP 38-3
global configuration mode 2-2
local user 37-20
password 10-1
simultaneous, username attribute 67-81
SSH 37-5
Telnet 10-1
windows, customizing for users of Clientless SSL
VPN sessions 67-27
low-latency queue
applying 54-2, 54-3
M
MAC address
redundant interfaces 6-4
MAC addresses
ASA 5505 7-4
ASA 5505 device pass-through 71-8
automatically assigning 5-22
failover 62-2
manually assigning to interfaces 8-11, 9-14
security context classification 5-3
MAC address table
about 4-23
built-in-switch 4-14
entry timeout 4-15
MAC learning, disabling 4-16
resource management 5-17
static entry 4-15
MAC learning, disabling 4-16
management interfaces
Index
IN-17
Cisco ASA 5500 Series Configuration Guide using the CLI
default settings 16-2, 17-2, 18-2, 34-7
management IP address, transparent firewall 9-7
man-in-the-middle attack 4-10
mapped addresses
guidelines 29-21
mapped interface name 5-20
mask
reply, ICMP message B-15
request, ICMP message B-15
Master Passphrase 10-6
match commands
inspection class map 33-4
Layer 3/4 class map 32-12, 32-15
matching, certificate group 64-17
maximum active IPSec VPN sessions, setting 66-3
maximum connect time,username attribute 67-82
maximum object size to ignore username attribute for
Clientless SSL VPN 67-90
MD5, IKE policy keywords (table) 64-9, 64-10, 64-11
media termination address, criteria 48-6
message filtering 77-4
message list
filtering by 77-4
message-of-the-day banner 37-8
messages, logging
classes
about 77-4
list of 77-4
component descriptions 77-3
filtering by message list 77-4
format of 77-3
message list, creating 77-13
severity levels 77-3
messages classes 77-4
messages in EMBLEM format 77-14
metacharacters, regular expression 13-13
MGCP inspection
about 44-11
configuring 44-11
mgmt0 interfaces
default settings 16-2, 17-2, 18-2, 34-7
MIBs 79-2
MIBs for SNMP 79-29
Microsoft Access Proxy 51-1
Microsoft Active Directory, settings for password
management 67-28
Microsoft Internet Explorer client parameters,
configuring 67-57
Microsoft KCD 74-41, 74-42
Microsoft Windows CA, supported 41-4
mixed cluster scenarios, load balancing 66-10
mixed-mode Cisco UCM cluster, configuring for phone
proxy 48-17
MMP inspection 50-1
mobile redirection, ICMP message B-15
mode
context 5-15
firewall 4-1
modular policy framework
configuring flow-export actions for NetFlow 78-5
monitoring
CSC SSM 60-13
failover 61-14
OSPF 24-16
resource management 5-29
SNMP 79-1
monitoring logging 77-19
monitoring NSEL 78-10
monitoring switch traffic, ASA 5505 7-4
More prompt A-5
MPF
default policy 32-7
examples 32-18
feature directionality 32-3
features 32-2
flows 32-6
matching multiple policy maps 32-6
service policy, applying 32-17
See also class map
Index
IN-18
Cisco ASA 5500 Series Configuration Guide using the CLI
See also policy map
MPLS
LDP 34-6
router-id 34-6
TDP 34-6
MRoute pane
description 26-4
MSIE client parameters, configuring 67-57
MTU 8-11, 9-14
MTU size, Easy VPN client, ASA 5505 71-5
multicast traffic 4-4
multiple context mode
logging 77-2
See security contexts
N
NAC
See Network Admission Control
naming an interface
other models 8-7, 9-10, 9-11
NAT
about 29-1
bidirectional initiation 29-2
disabling proxy ARP for global addresses 21-11
DNS 29-24
dynamic
about 29-8
dynamic NAT
network object NAT 30-4
twice NAT 31-4
dynamic PAT
about 29-10
network object NAT 30-6
twice NAT 31-8
identity
about 29-11
identity NAT
network object NAT 30-12
twice NAT 31-20
implementation 29-16
interfaces 29-21
mapped address guidelines 29-21
network object
comparison with twice NAT 29-16
network object NAT
about 29-17
configuring 30-1
dynamic NAT 30-4
dynamic PAT 30-6
examples 30-15
guidelines 30-2
identity NAT 30-12
monitoring 30-14
prerequisites 30-2
static NAT 30-10
no proxy ARP 30-13, 31-19
object
extended PAT 30-6
flat range for PAT 30-6
routed mode 29-13
route lookup 30-13, 31-24
RPC not supported with 45-3
rule order 29-20
static
about 29-3
few-to-many mapping 29-7
many-to-few mapping 29-6, 29-7
one-to-many 29-6
static NAT
network object NAT 30-10
twice NAT 31-15
static with port translation
about 29-4
terminology 29-2
transparent mode 29-13
twice
extended PAT 31-8
Index
IN-19
Cisco ASA 5500 Series Configuration Guide using the CLI
flat range for PAT 31-8
twice NAT
about 29-17
comparison with network object NAT 29-16
configuring 31-1
dynamic NAT 31-4
dynamic PAT 31-8
examples 31-24
guidelines 31-2
identity NAT 31-20
monitoring 31-24
prerequisites 31-2
static NAT 31-15
types 29-3
VPN 29-14
VPN client rules 29-20
native VLAN support 7-10
NAT-T
enabling IPsec over NAT-T 64-14
using 64-15
neighbor reachable time 28-3
neighbor solicitation messages 28-2
neighrbor advertisement messages 28-2
NetFlow
overview 78-1
NetFlow collector
configuring 78-5
NetFlow event
matching to configured collectors 78-5
NetFlow event logging
disabling 78-9
Network Activity test 61-15
Network Admission Control
ACL, default 70-10
clientless authentication 70-13
configuring 67-59
exemptions 70-11
revalidation timer 70-10
uses, requirements, and limitations 70-1
network extension mode 71-3
network extension mode, group policy 67-55
Network Ice firewall 67-67
network object NAT
about 29-17
comparison with twice NAT 29-16
configuring 30-1
dynamic NAT 30-4
dynamic PAT 30-6
examples 30-15
guidelines 30-2
identity NAT 30-12
monitoring 30-14
prerequisites 30-2
static NAT 30-10
Nokia VPN Client 64-35
non-secure Cisco UCM cluster, configuring phone
proxy 48-15
No Payload Encryption 3-30
no proxy ARP 31-19
NSEL and syslog messages
redundant messages 78-2
NSEL configuration examples 78-12
NSEL feature history 78-14
NSEL licensing requirements 78-3
NSEL runtime counters
clearing 78-10
NTLM support 35-6
NT server
configuring 35-11
support 35-6
O
object groups
about 13-1
configuring 13-6
removing 13-11
object NAT
Index
IN-20
Cisco ASA 5500 Series Configuration Guide using the CLI
See network object NAT
open ports B-14
operating systems, posture validation exemptions 70-11
OSPF
area authentication 24-11
area MD5 authentication 24-11
area parameters 24-10
authentication key 24-9
authentication support 24-2
cost 24-9
dead interval 24-9
defining a static neighbor 24-12
interaction with NAT 24-2
interface parameters 24-8
link-state advertisement 24-2
logging neighbor states 24-13
LSAs 24-2
MD5 authentication 24-9
monitoring 24-16
NSSA 24-11
packet pacing 24-16
processes 24-2
redistributing routes 24-4
route calculation timers 24-13
route summarization 24-7
outbound access lists 34-3
output destination 77-5
output destinations 77-1, 77-6
e-mail address 77-1, 77-6
SNMP management station 77-1, 77-6
Telnet or SSH session 77-1, 77-6
outside, definition 1-24
oversubscribing resources 5-8
P
packet
capture 82-14
classifier 5-3
packet flow
routed firewall 4-17
transparent firewall 4-23
packet trace, enabling 82-7
paging screen displays A-5
parameter problem, ICMP message B-15
password
resetting on SSM hardware module 82-11
password management, Active Directory settings 67-28
passwords
changing 10-2
recovery 82-8
security appliance 10-1
username, setting 67-80
WebVPN 74-109
password-storage, username attribute 67-84
PAT
Easy VPN client mode 71-3
See dynamic PAT
pause frames for flow control 6-22
PDA support for WebVPN 74-78
peers
alerting before disconnecting 64-16
ISAKMP, determining ID method 64-13
performance, optimizing for WebVPN 74-81
permit in a crypto map 64-23
phone proxy
access lists 48-7
ASA role 47-3
certificates 48-15
Cisco IP Communicator 48-10
Cisco UCM supported versions 48-3
configuring mixed-mode Cisco UCM cluster 48-17
configuring non-secure Cisco UCM cluster 48-15
event recovery 48-41
IP phone addressing 48-9
IP phone provisioning 48-12
IP phones supported 48-3
Linksys routers, configuring 48-26
Index
IN-21
Cisco ASA 5500 Series Configuration Guide using the CLI
NAT and PAT requirements 48-8
ports 48-7
rate limiting 48-11
required certificates 48-16
sample configurations 48-43
SAST keys 48-41
TLS Proxy on ASA, described 47-3
troubleshooting 48-27
ping
See ICMP
ping of death attack 57-6, 57-9
PKI protocol 41-11
PoE 7-4
policing
flow within a tunnel 54-11
policy, QoS 54-1
policy map
inspection 33-2
Layer 3/4
about 32-1
feature directionality 32-3
flows 32-6
pools, address
DHCP 11-3
port-forward
group policy attribute for Clientless SSL VPN 67-75
username attribute for Clientless SSL VPN 67-89
port-forwarding
enabling 8-6, 9-8
port-forward-name
group policy attribute for Clientless SSL VPN 67-76
username attribute for Clientless SSL VPN 67-90
ports
open on device B-14
phone proxy 48-7
TCP and UDP B-11
port translation
about 29-4
posture validation
exemptions 70-11
revalidation timer 70-10
uses, requirements, and limitations 70-1
power over Ethernet 7-4
PPPoE, configuring 72-1 to 72-5
prerequisites for use
CSC SSM 60-5
pre-shared key, Easy VPN client on the ASA 5505 71-7
primary unit, failover 62-2
printers 71-8
private networks B-2
privileged EXEC mode, accessing 2-1
privileged mode
accessing 2-1
prompt A-2
privilege level, username, setting 67-80
Product Authorization Key 3-33
prompts
command A-2
more A-5
protocol numbers and literal values B-11
Protocol pane (PIM)
description 26-10
proxied RPC request attack 57-10
proxy
See e-mail proxy
proxy ARP
NAT
NAT
proxy ARP 29-22
proxy ARP, disabling 21-11
proxy bypass 74-83
proxy servers
SIP and 44-19
PRSM 59-3
public key cryptography 41-2
Index
IN-22
Cisco ASA 5500 Series Configuration Guide using the CLI
Q
QoS
about 54-1, 54-3
DiffServ preservation 54-5
DSCP preservation 54-5
feature interaction 54-4
policies 54-1
priority queueing
IPSec anti-replay window 54-12
statistics 54-15
token bucket 54-2
traffic shaping
overview 54-4
viewing statistics 54-15
Quality of Service
See QoS
question mark
command string A-4
help A-4
queue, logging
changing the size of 77-15
viewing statistics 77-19
queue, QoS
latency, reducing 54-8
limit 54-2, 54-3
R
RADIUS
attributes C-27
Cisco AV pair C-13
configuring a AAA server C-27
configuring a server 35-11
downloadable access lists 38-14
network access authentication 38-4
network access authorization 38-14
support 35-4
RAS, H.323 troubleshooting 44-10
rate limit 77-19
rate limiting 54-3
rate limiting, phone proxy 48-11
RealPlayer 44-15
reboot, waiting until active sessions end 64-16
redirect, ICMP message B-15
redundancy, in site-to-site VPNs, using crypto
maps 64-34
redundant interface
EtherChannel
converting existing interfaces 6-13
redundant interfaces
configuring 6-25
failover 6-10
MAC address 6-4
setting the active interface 6-27
Registration Authority description 41-2
regular expression 13-12
reloading
context 5-26
security appliance 82-8
remote access
IPSec tunnel group, configuring 67-8
restricting 67-84
tunnel group, configuring default 67-7
VPN, configuring 69-1, 69-15
remote management, ASA 5505 71-9
Request Filter pane
description 26-11
resetting the SSM hardware module password 82-11
resource management
about 5-8
assigning a context 5-21
class 5-16
configuring 5-8
default class 5-9
monitoring 5-29
oversubscribing 5-8
resource types 5-17
Index
IN-23
Cisco ASA 5500 Series Configuration Guide using the CLI
unlimited 5-9
resource usage 5-32
revalidation timer, Network Admission Control 70-10
revoked certificates 41-2
rewrite, disabling 74-83
RFCs for SNMP 79-29
RIP
authentication 25-2
definition of 25-1
enabling 25-4
support for 25-2
RIP panel
limitations 25-3
RIP Version 2 Notes 25-3
routed mode
about 4-1
NAT 29-13
setting 4-1
route map
definition 23-1
route maps
defining 23-4
uses 23-1
router
advertisement, ICMP message B-15
solicitation, ICMP message B-15
router advertisement messages 28-3
router advertisement transmission interval 28-8
router lifetime value 28-8
routes
about default 22-4
configuring default routes 22-4
configuring IPv6 default 22-5
configuring IPv6 static 22-5
configuring static routes 22-3
routing
other protocols 34-5
RSA
keys, generating 37-4, 41-9
RTSP inspection
about 44-15
configuring 44-15
rules
ICMP 37-10
running configuration
copying 81-8
saving 2-16
S
same security level communication
enabling 8-15, 9-18
SAs, lifetimes 64-29
SAST keys 48-41
SCCP (Skinny) inspection
about 44-25
configuration 44-25
configuring 44-25
SDI
configuring 35-11
support 35-5
secondary unit, failover 62-2
secure unit authentication 71-12
secure unit authentication, group policy 67-53
security, WebVPN 74-5, 74-13
Security Agent, Cisco 67-66
security appliance
CLI A-1
connecting to 2-1
managing licenses 3-1
managing the configuration 2-15
reloading 82-8
upgrading software 81-2
viewing files in Flash memory 81-1
security association
clearing 64-34
See also SAs
security attributes, group policy 67-46
Index
IN-24
Cisco ASA 5500 Series Configuration Guide using the CLI
security contexts
about 5-1
adding 5-18
admin context
about 5-2
changing 5-24
assigning to a resource class 5-21
cascading 5-6
changing between 5-23
classifier 5-3
command authorization 37-16
configuration
URL, changing 5-25
URL, setting 5-21
logging in 5-7
MAC addresses
automatically assigning 5-22
classifying using 5-3
managing 5-1, 5-23
mapped interface name 5-20
monitoring 5-27
multiple mode, enabling 5-15
nesting or cascading 5-7
prompt A-2
reloading 5-26
removing 5-24
resource management 5-8
resource usage 5-32
saving all configurations 2-17
unsupported features 5-14
VLAN allocation 5-20
security level
about 8-1
interface 8-8, 9-10, 9-12
security models for SNMP 79-16
sending messages to an e-mail address 77-10
sending messages to an SNMP server 77-11
sending messages to ASDM 77-11
sending messages to a specified output destination 77-16
sending messages to a syslog server 77-8
sending messages to a Telnet or SSH session 77-12
sending messages to the console port 77-11
sending messages to the internal log buffer 77-9
service policy
applying 32-17
default 32-17
interface 32-18
session management path 1-28
severity levels, of system log messages
changing 77-1
filtering by 77-1
list of 77-3
severity levels, of system messages
definition 77-3
SHA, IKE policy keywords (table) 64-9, 64-10, 64-11
shared license
backup server, configuring 3-37
backup server, information 3-25
client, configuring 3-37
communication issues 3-25
failover 3-25
maximum clients 3-27
monitoring 3-44
server, configuring 3-35
SSL messages 3-25
show command, filtering output A-4
showing cached Kerberos tickets 74-47
showing KCD status 74-46
simultaneous logins, username attribute 67-81
single mode
backing up configuration 5-15
configuration 5-15
enabling 5-15
restoring 5-16
single sign-on
See SSO
single-signon
group policy attribute for Clientless SSL VPN 67-77
Index
IN-25
Cisco ASA 5500 Series Configuration Guide using the CLI
username attribute for Clientless SSL VPN 67-92
SIP inspection
about 44-19
configuring 44-19
instant messaging 44-19
timeouts 44-24
troubleshooting 44-24
site-to-site VPNs, redundancy 64-34
Smart Call Home monitoring 80-19
smart tunnels 74-48
SMTP inspection 43-31
SNMP
about 79-1
failover 79-17
management station 77-1, 77-6
prerequisites 79-17
SNMP configuration 79-18
SNMP groups 79-16
SNMP hosts 79-16
SNMP monitoring 79-26, 79-27
SNMP terminology 79-2
SNMP traps 79-2
SNMP users 79-16
SNMP Version 3 79-15, 79-23
SNMP Versions 1 and 2c 79-22
source quench, ICMP message B-15
SPAN 7-4
Spanning Tree Protocol, unsupported 7-8
speed, configuring 6-11, 7-5
split tunneling
ASA 5505 as Easy VPN client 71-8
group policy 67-49
group policy, domains 67-52
SSCs
management access 58-4
management defaults 58-6
management interface 58-11
password reset 58-23, 60-15
reload 58-24, 60-16
reset 58-24, 60-16
routing 58-8
sessioning to 58-10
shutdown 58-24, 60-16
SSH
authentication 37-19
concurrent connections 37-2
login 37-5
password 10-1
RSA key 37-4
username 37-5
SSL
certificate 74-11
used to access the security appliance 74-6
SSL/TLS encryption protocols
configuring 74-10
WebVPN 74-10
SSL VPN Client
compression 75-16
DPD 75-15
enabling
permanent installation 75-7
installing
order 75-6
keepalive messages 75-16
viewing sessions 75-19
SSMs
loading an image 58-21, 58-23, 60-14
management access 58-4
management defaults 58-6
password reset 58-23, 60-15
reload 58-24, 60-16
reset 58-24, 60-16
routing 58-8
sessioning to 58-10
shutdown 58-24, 60-16
sso-server
group policy attribute for Clientless SSL VPN 67-77
username attribute for Clientless SSL VPN 67-92
Index
IN-26
Cisco ASA 5500 Series Configuration Guide using the CLI
SSO with WebVPN 74-13 to ??
configuring HTTP Basic and NTLM
authentication 74-14
configuring HTTP form protocol 74-20
configuring SiteMinder 74-15, 74-17
startup configuration
copying 81-8
saving 2-16
statd buffer overflow attack 57-11
Stateful Failover
about 61-10
state information 61-10
state link 61-4
stateful inspection 1-27
bypassing 53-3
state information 61-10
state link 61-4
static ARP entry 4-11
static bridge entry 4-15
Static Group pane
description 26-6
static NAT
about 29-3
few-to-many mapping 29-7
many-to-few mapping 29-6, 29-7
network object NAT 30-10
twice NAT 31-15
static NAT with port translation
about 29-4
static routes
configuring 22-3
statistics, QoS 54-15
stealth firewall
See transparent firewall
stuck-in-active 27-2
subcommand mode prompt A-2
subinterfaces, adding 6-30
subnet masks
/bits B-3
about B-2
address range B-4
determining B-3
dotted decimal B-3
number of hosts B-3
Sun Microsystems Java Runtime Environment (JRE)
and WebVPN 74-66
Sun RPC inspection
about 45-3
configuring 45-3
SVC
See SSL VPN Client
switch MAC address table 4-14
switch ports
access ports 7-7
protected 7-8, 7-10
SPAN 7-4
trunk ports 7-9
Sygate Personal Firewall 67-67
SYN attacks, monitoring 5-33
SYN cookies 5-33
syntax formatting A-3
syslogd server program 77-5
syslog messages
analyzing 77-2
syslog messaging for SNMP 79-27
syslog server
designating more than one as output destination 77-5
EMBLEM format
configuring 77-14
enabling 77-8, 77-14
system configuration 5-2
system log messages
classes 77-4
classes of 77-4
configuring in groups
by message list 77-4
by severity level 77-1
device ID, including 77-17
Index
IN-27
Cisco ASA 5500 Series Configuration Guide using the CLI
disabling logging of 77-1
filtering by message class 77-4
managing in groups
by message class 77-16
output destinations 77-1, 77-6
syslog message server 77-6
Telnet or SSH session 77-6
severity levels
about 77-3
changing the severity level of a message 77-1
timestamp, including 77-18
T
TACACS+
command authorization, configuring 37-29
configuring a server 35-11
network access authorization 38-11
support 35-5
tail drop 54-3
TCP
ASA 5505 as Easy VPN client 71-4
connection limits per context 5-17
ports and literal values B-11
sequence number randomization
disabling using Modular Policy
Framework 53-12
TCP Intercept
enabling using Modular Policy Framework 53-12
monitoring 5-33
TCP normalization 53-3
TCP NULL flags attack 57-6, 57-9
TCP state bypass
AAA 53-5
configuring 53-10
failover 53-5
firewall mode 53-5
inspection 53-5
mutliple context mode 53-5
NAT 53-5
SSMs and SSCs 53-5
TCP Intercept 53-5
TCP normalization 53-5
unsupported features 53-5
TCP SYN+FIN flags attack 57-6, 57-9
Telnet
allowing management access 37-1
authentication 37-19
concurrent connections 37-2
login 37-4
password 10-1
template timeout intervals
configuring for flow-export actions 78-7
temporary license 3-21
testing configuration 82-1
threat detection
basic
drop types 56-2
enabling 56-4
overview 56-2
rate intervals 56-2
rate intervals, setting 56-4
statistics, viewing 56-5
system performance 56-3
scanning
attackers, viewing 56-18
default limits, changing 56-17
enabling 56-17
host database 56-15
overview 56-15
shunned hosts, releasing 56-18
shunned hosts, viewing 56-17
shunning attackers 56-17
system performance 56-15
targets, viewing 56-18
scanning statistics
enabling 56-7
system performance 56-6
Index
IN-28
Cisco ASA 5500 Series Configuration Guide using the CLI
viewing 56-9
time exceeded, ICMP message B-15
time ranges, access lists 13-16
timestamp, including in system log messages 77-18
timestamp reply, ICMP message B-15
timestamp request, ICMP message B-15
TLS1, used to access the security appliance 74-6
TLS Proxy
applications supported by ASA 47-3
Cisco Unified Presence architecture 51-1
configuring for Cisco Unified Presence 51-8
licenses 47-4, 49-5, 50-6, 51-7, 52-8
tocken bucket 54-2
toolbar, floating, WebVPN 74-89
traffic flow
routed firewall 4-17
transparent firewall 4-23
traffic shaping
overview 54-4
transform set
creating 69-1, 69-10
definition 64-19
transmit queue ring limit 54-2, 54-3
transparent firewall
about 4-2
ARP inspection
about 4-10
enabling 4-12
static entry 4-11
data flow 4-23
DHCP packets, allowing 34-5
guidelines 4-7
H.323 guidelines 4-4
HSRP 4-4
MAC address timeout 4-15
MAC learning, disabling 4-16
management IP address 9-7
multicast traffic 4-4
packet handling 34-5
static bridge entry 4-15
unsupported features 4-7
VRRP 4-4
transparent mode
NAT 29-13
troubleshooting
H.323 44-9
H.323 RAS 44-10
phone proxy 48-27
SIP 44-24
troubleshooting SNMP 79-24
trunk, 802.1Q 6-30
trunk ports 7-9
Trusted Flow Acceleration
failover 65-7
modes 4-6, 4-10, 4-14, 15-1, 34-7, 63-7, 65-7
trustpoint 41-3
trustpoint, ASA 5505 client 71-7
trust relationship
Cisco Unified Mobility 50-5
Cisco Unified Presence 51-4
tunnel
ASA 5505 as Easy VPN client 71-5
IPsec 64-19
security appliance as a tunnel endpoint 64-2
tunnel group
ASA 5505 as Easy VPN client 71-7
configuring 67-6
creating 67-8
default 64-19, 67-1, 67-2
default, remote access, configuring 67-7
default LAN-to-LAN, configuring 67-17
definition 67-1, 67-2
general parameters 67-3
inheritance 67-1
IPSec parameters 67-4
LAN-to-LAN, configuring 67-17
name and type 67-8
remote access, configuring 69-11
Index
IN-29
Cisco ASA 5500 Series Configuration Guide using the CLI
remote-access, configuring 67-8
tunnel-group
general attributes 67-3
tunnel-group ISAKMP/IKE keepalive settings 67-4
tunneling, about 64-1
tunnel mode 65-2
twice NAT
about 29-17
comparison with network object NAT 29-16
configuring 31-1
dynamic NAT 31-4
dynamic PAT 31-8
examples 31-24
guidelines 31-2
identity NAT 31-20
monitoring 31-24
prerequisites 31-2
static NAT 31-15
tx-ring-limit 54-2, 54-3
U
UDP
connection limits per context 5-17
connection state information 1-28
ports and literal values B-11
unreachable, ICMP message B-15
unreachable messages
required for MTU discovery 37-10
url-list
group policy attribute for Clientless SSL VPN 67-74
username attribute for Clientless SSL VPN 67-89
URLs
context configuration, changing 5-25
context configuration, setting 5-21
filtering 39-1
filtering, about 39-7
filtering, configuration 39-11
user, VPN
definition 67-1
user access, restricting remote 67-84
user authentication, group policy 67-53
user EXEC mode
accessing 2-1
prompt A-2
username
adding 35-20
clientless authentication 70-14
encrypted 35-23
management tunnels 71-9
password 35-23
WebVPN 74-109
Xauth for Easy VPN client 71-4
username attributes
access hours 67-81
configuring 67-79, 67-80
group-lock 67-84
inheritance 67-81
password, setting 67-80
password-storage 67-84
privilege level, setting 67-80
simultaneous logins 67-81
vpn-filter 67-82
vpn-framed-ip-address 67-83
vpn-idle timeout 67-82
vpn-session-timeout 67-82
vpn-tunnel-protocol 67-83
username attributes for Clientless SSL VPN
auto-signon 67-91
customization 67-87
deny message 67-87
filter (access list) 67-88
homepage 67-86
html-content-filter 67-86
keep-alive ignore 67-90
port-forward 67-89
port-forward-name 67-90
sso-server 67-92
Index
IN-30
Cisco ASA 5500 Series Configuration Guide using the CLI
url-list 67-89
username configuration, viewing 67-79
username webvpn mode 67-85
users
SNMP 79-16
U-turn 64-26
V
VeriSign, configuring CAs example 41-4
viewing QoS statistics 54-15
viewing RMS 81-19
virtual cluster 66-6
IP address 66-6
master 66-6
virtual firewalls
See security contexts
virtual HTTP 38-3
virtual reassembly 1-25
virtual sensors 58-15
VLAN mapping 67-44
VLANs 6-30
802.1Q trunk 6-30
allocating to a context 5-20
ASA 5505
MAC addresses 7-4
maximum 7-2
mapped interface name 5-20
subinterfaces 6-30
VoIP
proxy servers 44-19
troubleshooting 44-9
VPN
address pool, configuring (group-policy) 67-62
address range, subnets B-4
parameters, general, setting 66-1
setting maximum number of IPSec sessions 66-3
VPN attributes, group policy 67-42
VPN client
NAT rules 29-20
VPN Client, IPsec attributes 64-2
vpn-filter username attribute 67-82
VPN flex license 3-21
vpn-framed-ip-address username attribute 67-83
VPN hardware client, group policy attributes 67-53
vpn-idle-timeout username attribute 67-82
vpn load balancing
See load balancing 66-6
vpn-session-timeout username attribute 67-82
vpn-tunnel-protocol username attribute 67-83
VRRP 4-4
W
WCCP 40-1
web caching 40-1
web clients, secure authentication 38-6
web e-Mail (Outlook Web Access), Outlook Web
Access 74-80
WebVPN
assigning users to group policies 74-31, 74-32
authenticating with digital certificates 74-28, 74-29
CA certificate validation not done 74-5
client application requirements 74-110
client requirements 74-110
configuring
e-mail 74-79
configuring WebVPN and ASDM on the same
interface 74-7
cookies 74-10
defining the end-user interface 74-88
definition 74-2
e-mail 74-79
e-mail proxies 74-79
end user set-up 74-87
floating toolbar 74-89
group policy attributes, configuring 74-33
hosts file 74-72
Index
IN-31
Cisco ASA 5500 Series Configuration Guide using the CLI
hosts files, reconfiguring 74-73
HTTP/HTTPS proxy, setting 74-11
Java object signing 74-82
PDA support 74-78
security preautions 74-5, 74-13
security tips 74-109
setting HTTP/HTTPS proxy 74-8
SSL/TLS encryption protocols 74-10
supported applications 74-110
troubleshooting 74-72
unsupported features 74-4
use of HTTPS 74-7
usernames and passwords 74-109
use suggestions 74-87, 74-110
WebVPN, Application Access Panel 74-88
webvpn attributes
group policy 67-70
welcome message, group policy 67-48
WINS server, configuring 67-40
X
Xauth, Easy VPN client 71-4
XOFF frames 6-22
Z
Zone Labs firewalls 67-67
Zone Labs Integrity Server 67-64
Index
IN-32
Cisco ASA 5500 Series Configuration Guide using the CLI