Cisco Anomaly Guard Module Configuration Guide (Software Version 5.0) - Initializing the Guard Module [Cisco Services Modules]

Table Of Contents

Initializing the Guard Module

Using the Command Line Interface

Understanding User Priviledge Levels

Understanding Command Modes

Entering CLI Commands

Using the No Form of a Command

show Command Syntax

CLI Error Messages

Tips for Using the CLI

Using Help

Using Tab Completion

Understanding Convention of Operation Direction

Abbreviating a Command

Using Wildcard Characters

Configuring the Guard Module Interfaces

Configuring a Physical Interface

Configuring a VLAN

Configuring a Loopback Interface

Configuring the Default Gateway

Adding a Static Route to the Routing Table

Configuring the Proxy IP Address

Managing the Guard Module

Managing the Guard Module with a Web-Based Manager

Accessing the Guard Module with SSH

Initializing the Guard Module

This chapter describes the basic tasks required to initialize the Cisco Anomaly Guard Module (Guard module) in a network and how to manage it.

This chapter includes the following topics:

•Using the Command Line Interface

•Configuring the Guard Module Interfaces

•Configuring the Guard Module Interfaces

•Configuring the Default Gateway

•Adding a Static Route to the Routing Table

•Configuring the Proxy IP Address

•Managing the Guard Module

Using the Command Line Interface

You can control the Guard module functions by using the Command-Line Interface (CLI). The Guard module user interface is divided into many different command modes and the access to the CLI is mapped according to user privilege levels. The commands that are available to you depend on which mode you are currently in.

This section includes the following topics:

•Understanding User Priviledge Levels

•Understanding Command Modes

•Entering CLI Commands

•Tips for Using the CLI

Understanding User Priviledge Levels

The access to the CLI is mapped according to user privilege levels. Each privilege level has its own group of commands.

Table 3-1 describes the user privilege levels.

Table 3-1 User Privilege Levels

User Privilege Level

Description

Administration (admin)

Provides access to all operations.

Configuration (config)

Provides access to all operations except for operations relating to user definition, deletion, and modification.

Dynamic (dynamic)

Provides access to monitoring and diagnostics operations, protection, and learning-related operations. Users with Dynamic privileges can also configure Flex-Content filters and Dynamic filters.

Show (show)

Provides access to monitoring and diagnostic operations.

Note We recommend that users with Administration and Configuration privilege levels configure all filters. Users with lower privilege levels can add and remove Dynamic filters.

Understanding Command Modes

This section contains summaries of the command and configuration modes used in the Guard module Command-Line Interface (CLI). To obtain a list of commands available for each command mode, enter ? at the system prompt.

Table 3-2 lists and describes the Guard module command modes.
Table 3-2 Guard module Command Configuration Modes
Mode

Description
Global
Allows you to connect to remote devices and list system information.

The Global prompt is the default prompt when you log into the Guard module. The command prompt is as follows:
user@GUARD#
Configuration
Allows you to configure features that affect the Guard module as a whole and have restricted user access.

To enter configuration mode, use the configure command in global mode. The command prompt is as follows:
user@GUARD-conf#
Interface configuration
Allows you to configure the Guard module networking interfaces.

To enter interface configuration mode, use the interface command in configuration mode. The command prompt is as follows:
user@GUARD-conf-if-<interface-name>#
Router configuration
Allows you to configure the Guard module routing configuration.

To enter router configuration mode, use the router command in configuration mode. The command prompt is as follows :
router>
Zone configuration
Allows you to configure the zone attributes.

To enter zone configuration mode, use the zone command in configuration mode or use the configure command in global mode. The command prompt is as follows:
user@GUARD-conf-zone-<zone-name>#
Policy template configuration
Allows you to configure the zone policy templates.

To enter policy template configuration mode, use the policy-template command in zone configuration mode. The command prompt is as follows:
user@GUARD-conf-zone-<zone-name>-policy_template-<policy-template-name>#
Policy configuration
Allows you to configure the zone policies.

To enter policy configuration mode, use the policy command in zone configuration mode. The command prompt is as follows:
user@GUARD-conf-zone-<zone-name>-policy-<policy-path>#
Entering CLI Commands

This sections describes the rules for entering CLI commands.

This section includes the following topics:

•Using the No Form of a Command

•show Command Syntax

•CLI Error Messages

Table 3-3 describes the rules for entering CLI commands.

Table 3-3 CLI Rules

Action

Keyboard Sequence

Scroll through and modify the command history

Use the arrow keys.

Display commands available in a specific command mode

Shift + ?

Display a command completion

Type the beginning of the command and press TAB.

Display a command syntax completion(s)

Type the command and press TAB twice.

Scroll using the more command

Enter the more number-of-lines command.

The more command configures the number of additional lines displayed in the window once you press the SPACE bar. The default is two lines less than the capability of the terminal.

The number-of-lines argument configures the number of additional lines to be displayed once you press the SPACE bar.

Scroll on a single screen (within a command output)

SPACE bar

Scroll back a single screen (within a command output)

b

Stop scroll movement

q

Search forward for a string

/ string

Search backward for a string

? string

Cancel the action or delete a parameter

Use the no form of a specific command.

Display information relating to a current operation

show

Exit from a current command group level to a higher group level

exit

Exit all command group levels and return to the root level

end

Display command output from and including the first line that contains a string

| begin string

Display command output lines that include a string

| include string

Display command output lines that do not include a string

| exclude string

Note If you enter the exit command at the root level, you exit the CLI environment to the operating system login screen.

Using the No Form of a Command

Almost every configuration command also has a no form. In general, use the no form of a command to disable a feature or function. Use the command without the keyword no to enable a disabled feature or function. For example, the event monitor command turns on the event monitor, and the no event monitor command turns it off.

show Command Syntax

You can execute zone-related show commands from the zone configuration mode. Alternatively, you can execute these commands from the global or configuration modes.

The following is the syntax for the show command in global or configuration modes:

show zone zone-name parameters...
The following is the syntax for the show command in zone configuration mode:

show parameters...

Note This publication uses the show command syntax from the zone configuration mode unless explicitly specified.

CLI Error Messages

The Guard module CLI displays error messages in the following situations:

•The syntax of the command is incomplete or incorrect.

•The command does not match the system configuration.

•The operation could not be performed due to a system failure. In this situation, an entry is created in the system log.

Tips for Using the CLI

This section provides tips for using the CLI and includes the following topics:

•Using Help

•Using Tab Completion

•Understanding Convention of Operation Direction

•Abbreviating a Command

•Using Wildcard Characters

Using Help

The CLI provides context-sensitive help at every mode of the command hierarchy. The help information tells you which commands are available at the current command mode and provides a brief description of each command.

To get help, type ?.

To display help for a command, type ? after the command.

To display all commands available in a mode along with a short description, enter ? at the command prompt.

The help displays commands available in the current mode only.

Using Tab Completion

You can use tab completion to reduce the number of characters you need to type for a command. Type the first few characters of a command and press Tab to complete the command.

After entering a command that has a value with multiple options, press Tab twice to display a list of possible input parameters, including system-defined parameters and user-defined parameters. For example, if you press Tab twice after entering the policy-template command in zone configuration mode, the list of policy template names is displayed. If you press Tab twice after entering the zone command in configuration mode, zones that are already defined are displayed.

If multiple commands match for a Tab completion action, nothing is displayed; the system repeats the current line you entered.

The tab completion feature displays only commands available for the current mode.

Understanding Convention of Operation Direction

The oder of keywords in the command syntax define the direction of the operation. When the keyword is entered before the command name, the Guard module copies data from the Guard module to the server. When the command name comes before the keyword, the Guard module copies data from the server to the Guard module. For example, the copy log ftp command copies the log file from the Guard module to the FTP server. The copy ftp new-version command copies the new software version file from the FTP server to the Guard module.

Abbreviating a Command

You can abbreviate commands and keywords to the number of characters that allow a unique abbreviation.

For example, you can abbreviate the show command to sh.

Using Wildcard Characters

You can use an asterisk (*) as a wildcard.

For example, if you enter the learning policy-construction * command, the policy construction phase is activated for all the zones that are configured on the Guard module.

If you enter the learning policy-construction scan* command, the policy construction phase is activated for all the zones that are configured on the Guard module with names that begin with scan (such as scannet, scanserver, and so on).

If you enter the no zone * command, all zones are removed.

Configuring the Guard Module Interfaces

The Guard module has one management port and two data ports on the supervisor engine. Only one data port is used.

Enter configuration mode to configure the Guard module by entering the following command:

configure [terminal]
The following example shows how to enter configuration mode:
user@GUARD# configure 
user@GUARD-conf#
You must configure the Guard module interfaces for proper Guard module functioning. Interface characteristics include, but are not limited to, the IP address and the interface MTU.

Many features are enabled on a per-interface basis. When you enter the interface command, you must specify the interface type and number.

The following guidelines apply to all physical and virtual interface configuration processes:

•Each interface must be configured with an IP address and an IP subnet mask.

•You must activate each interface using the no shutdown command.

To display the configuration of an interface, enter the show or show running-config commands.

Configuring a Physical Interface

To connect the Guard module to a network, configure a physical interface.

Caution Do not configure two physical interfaces on the same subnet or the Guard module routing may not work properly.

To configure a physical interface, perform the following steps:

Step 1 Enter interface configuration mode by entering the following command in configuration mode:
interface if-name
The if-name argument specifies the interface name.

The Guard module supports the following interfaces:

•eth1—Management port

•giga2—Data port

Caution

Step 2 Set the interface IP address by entering the following command:
ip address ip-addr ip-mask 
The ip-addr and ip-mask arguments define the interface IP address. Enter the IP address and subnet mask in dotted-decimal notation (for example, an IP address of 192.168.100.1 and a subnet mask of 255.255.255.0).

Step 3 (Optional) Define the interface MTU by entering the following command:
mtu integer 
The integer argument is an integer between 576 and 16384 bytes for eth1 interface and an integer between 576 and 1824 for giga2 interface.

The default MTU value is 1500 bytes.

Step 4 (Optional) Configure the interface speed and duplex mode by entering the following command:
speed {auto | half speed | full speed}
Table 3-4 provides the arguments and keywords for the speed command.

Table 3-4 Arguments and Keywords for the speed Command

Parameter

Description

auto

Turns on the interface auto-negotiation capability. The interface automatically operates at 10/100/1000 Mbps and half or full duplex, depending on environmental factors, such as the type of media and transmission speeds for the peer routers, hubs, and switches used in the network configuration.

This mode is the default.

half

Specifies half-duplex operation.

full

Specifies full-duplex operation.

speed

Interface speed. Enter 10, 100, or 1000 for 10 Mbps, 100 Mbps, and 1000 Mbps.

Step 5 Activate the interface by entering the following command:
no shutdown
You must reload the Guard module for the configuration change to take effect.

The following example shows how to configure and activate interface eth1:
user@GUARD-conf# interface eth1
user@GUARD-conf-if-eth1# ip address 10.10.10.33 255.255.255.252
user@GUARD-conf-if-eth1# no shutdown
To deactivate a physical interface, enter the shutdown command.

Configuring a VLAN

You can define VLANs on the data port only. You must configure the VLANs on the supervisor engine and assign the VLANs to the Guard module to enable proper functioning. See the "Configuring VLANs" section for more information.

To define a VLAN on the Guard module, perform the following steps:

Step 1 Enter VLAN interface configuration mode, if one exists, or define a new VLAN by entering the following command in configuration mode:
interface giga2.vlan-id
The vlan-id argument is an integer that specifies the VLAN ID number. The VLAN ID is a TAG IEEE 802.1Q number.

Step 2 Set the VLAN IP address by entering the following command:
ip address ip-addr ip-mask 
The ip-addr and ip-mask arguments define the interface IP address. Enter the IP address and subnet mask in dotted-decimal notation (for example, an IP address of 192.168.100.1 and a subnet mask of 255.255.255.0).

Step 3 (Optional) Define the interface MTU by entering the following command:
mtu integer 
The integer argument is an integer between 576 and 1824 bytes.

The default MTU value is 1500 bytes.

Step 4 Activate the interface by entering the following command:
no shutdown
The following example shows how to configure a VLAN on the Guard module:
user@GUARD-conf#interface giga2.2
user@GUARD-conf-if-giga2.2# ip address 192.168.5.8 255.255.255.0
user@GUARD-conf-if-giga2.2# no shutdown
Configuring a Loopback Interface

You can specify a virtual interface called a loopback interface to emulate a physical interface. You can use the loopback interface to configure advanced diversion configurations.

In applications where other routers or access servers attempt to reach this loopback interface, you should configure a routing protocol to distribute the subnet assigned to the loopback address.

To configure the loopback interface, perform the following steps:

Step 1 Enter the loopback interface configuration mode, if one exists, or define a new loopback interface by entering the following command in configuration mode:
interface if-name 
The if-name argument specifies the loopback interface name. The interface name is lo:integer where integer is an integer between 0 and 1023.

Step 2 Set the loopback interface IP address by entering the following command:
ip address ip-addr ip-mask 
The ip-addr and ip-mask arguments define the interface IP address. Enter the IP address and subnet mask in dotted-decimal notation (for example, an IP address of 192.168.100.1 and a subnet mask of 255.255.255.0).

Step 3 Exit the loopback interface configuration mode by entering the following command:
exit
The following example shows how to configure a loopback interface:
user@GUARD-conf# interface lo:0
user@GUARD-conf-if-lo:0# ip address 1.1.1.1 255.255.255.255
user@GUARD-conf-if-lo:0# exit
Configuring the Default Gateway

The default gateway is the IP address of a gateway (for example, a router connected to the network) that receives and forwards packets whose IP addresses are unknown to the local network. In most cases, the Guard module default gateway IP address is the adjacent router, located between the Guard module and the Internet. The default gateway address must be on the same network as one of the IP addresses of the Guard module network interfaces.

Note Do not assign an IP address to a default gateway while zone protection is enabled.

Caution If you do not configure the default gateway IP address, the Guard module may not be accessible to the network.

To assign a default gateway address, enter the following command in configuration mode:

default-gateway ip-addr
The ip-addr argument specifies the default gateway IP address. Enter the IP address in dotted-decimal notation (for example, enter an IP address of 192.168.100.1).

To modify the default gateway address, reenter the command.

The following example shows how to configure the default gateway:
user@GUARD-conf# default-gateway 192.168.100.1
Adding a Static Route to the Routing Table

You can add a static route to the Guard module routing table. Add a a static route to specify routes for servers or networks outside the local networks that are associated with the Guard module IP interfaces.

The static route is added permanently and is not removed after the Guard module is rebooted.

To add a static route to the Guard module routing table, enter the following command in configuration mode:

ip route ip-addr ip-mask nexthop-ip [if-name]
Table 3-5 provides the arguments for the ip route command.

Table 3-5 Arguments for the ip route Command

Parameter

Description

ip-addr

The network destination of the route. The destination can be an IP network address (where the host bits of the network address are set to 0) or an IP address for a host route. Enter the IP address in dotted-decimal notation (for example, enter 192.168.100.1).

ip-mask

The subnet mask associated with the network destination. Enter the subnet mask in dotted-decimal notation (for example, enter 255.255.255.0).

nexthop-ip

The forwarding or the nexthop-IP address over which the set of addresses that are defined by the network destination and subnet mask are reachable. The next-hop IP address should be within the interface subnet. For local subnet routes, the next-hop IP address is the IP address that is assigned to the interface that is attached to the subnet. For remote routes, available across one or more routers, the next-hop IP address is a directly reachable IP address that is assigned to a neighboring router.

if-name

(Optional) The Guard module interface or VLAN over which the destination is reachable. If you do not specify an interface, the next-hop IP address according to the Guard module routing table determines the interface used.

The following example show how to configure a static route:
user@GUARD-conf# ip route 172.16.31.5 255.255.255.255 192.168.100.34
Enter the show ip route command to display the routing table.

Configuring the Proxy IP Address

You must assign a proxy IP address to the Guard module. The Guard module proxy IP address is required for the proxy mode antispoofing protection mechanisms. Do not assign the Guard module with a proxy IP address while zone protection is enabled.

Caution You cannot activate zone protection without defining a proxy IP address.

To configure the Guard module antispoofing proxy IP address, enter the following command in configuration mode:

proxy ip-addr
The ip-addr argument specifies the proxy IP address. Enter the IP address in dotted-decimal notation (for example, enter 192.168.100.1).

You must verify the route between every zone and the Guard module proxy IP address. The Guard module does not answer ping requests to its proxy IP address.

To configure additional proxy IP addresses, reenter the command.

Note We recommend that you configure three to four proxy IP addresses if your network uses load balancing to distribute network overload or if your network requires a high number of concurrent connections.

The Guard module can have a maximum of 10 proxy IP addresses.

Managing the Guard Module

After you establish a session from the supervisor engine and configure the Guard module networking (see "Configuring the Guard Module on the Supervisor Engine" and the "Configuring the Guard Module Interfaces" section), you can access and manage the Guard module using one of the following methods:

•Access using a secured shell (SSH) session.

•Access the Guard module using a Web-Based Manager (WBM).

•Access from a DDoS-sensing network element. Refer to the appropriate documentation for more information.

This section contains the following topics:

•Managing the Guard Module with a Web-Based Manager

•Accessing the Guard Module with SSH

Managing the Guard Module with a Web-Based Manager

You can manage the Guard module from the web with a web based manager (WBM) using a web browser.

To enable the Guard module WBM, perform the following steps:

Step 1 Enable the WBM service by entering the following command in configuration mode:
service wbm
Step 2 Permit access to the Guard module from the remote manager IP address by entering the following command in configuration mode:
permit wbm ip-addr [ip-mask]
The ip-addr and ip-mask arguments define the remote manager IP address. Enter the IP address and subnet mask in dotted-decimal notation.

Step 3 Open the browser and enter the following address:
https://Guard module-ip-address/ 
The Guard module-ip-address argument is the IP address of the Guard module.

The Guard module WBM window appears.

Note HTTPS, not HTTP, is used to enable web-based management control.

Step 4 Enter your username and password and click OK.

After you enter the username and password correctly, the Guard home page is displayed.

If TACACS+ authentication is configured, the TACACS+ user database is used for user authentication rather than the local database.

The following example show how toenable the Guard module WBM:
user@GUARD-conf# service wbm
user@GUARD-conf# permit wbm 192.168.30.32
Accessing the Guard Module with SSH

You can access the Guard module using a secured shell (SSH) connection.

The SSH service is enabled by default.

To enable SSH connection to the Guard module, perform the following steps:

Step 1 Permit access to the Guard module from the remote network IP address by entering the following command in configuration mode:
permit ssh ip-addr [ip-mask]
The ip-addr and ip-mask arguments define the remote network IP address. Enter the IP address and subnet mask in dotted-decimal notation.

Step 2 Establish a connection from the remote network address and enter the login and password.

To enable the SSH connection without entering a login and password, add the remote connection SSH public key to the Guard module SSH key list.

See the "Managing SSH Keys" section for more information.