Network Analysis Module Command Reference Guide, 4.2
Command-Line Interface
Downloads: This chapterpdf (PDF - 621.0KB) The complete bookPDF (PDF - 4.3MB) | Feedback

Command-Line Interface

Table Of Contents

Command-Line Interface

Logging in to the NAM

Catalyst 6500 Switch

Getting Help

Command Mode

Subcommand Mode

Creation and Edit Modes

Branch Routers

WAAS Virtual Services Blade

Nexus 1010 Virtual Services Appliance


Command-Line Interface


This chapter provides information for understanding and using the Network Analysis Module (NAM) software by using the command-line interface (CLI). This chapter includes the following sections:

Logging in to the NAM

Catalyst 6500 Switch

Branch Routers

WAAS Virtual Services Blade

Nexus 1010 Virtual Services Appliance

For an overview of the Catalyst 6500 series Cisco IOS configuration, see the Catalyst 6500 Series Switch Cisco IOS Software Configuration Guide. For Catalyst 6500 series switch Cisco IOS commands, see the Catalyst 6500 Series Switch Cisco IOS Command Reference.

For an overview of the Catalyst 6500 series operating system software configuration, see the Catalyst 6500 Series Switch Configuration Guide. For Catalyst 6500 series switch operating system software commands, see the Catalyst 6500 Series Switch Command Reference.

Logging in to the NAM

Catalyst 6500 Switch

There are two levels of access on the Network Analysis Module, each with different privileges:

Guest—Read-only access (default password is guest)

Root—Full read-write access (default password is root)


Note The root account uses the # prompt; the guest account uses the > prompt.


To log into the NAM, perform these steps:


Step 1 Log into the Catalyst 6500 series switch using the Telnet connection or the console port connection.

Step 2 Establish a console session with the NAM at the CLI prompt, using the session command:

Cisco IOS Software:

switch> session slot 4 processor 1
The default escape character is Ctrl-^, then x.
You can also type 'exit' at the remote prompt to end the session
Trying 209.165.200.225 ... Open

Cisco Network Analysis Module (WS-SVC-NAM-2)

login: 

Catalyst Operating System Software:

switch> session 3
Trying NAM-3...
Connected to NAM-3.
Escape character is '^]'.

Cisco Network Analysis Module (WS-SVC-NAM-1)

login:

Step 3 Log into the NAM by typing root to log in as the root user or guest to log in as a guest user at the login prompt.

login: root

Step 4 At the password prompt, enter the password for the account. The default password for the root account is "root," and the default password for the guest account is "guest."

Password: 

After a successful login, the command-line prompt appears as follows:

Cisco Network Analysis Module (WS-SVC-NAM-2) Console, 4.2(1)
Copyright (c) 1999-2010 by Cisco Systems, Inc.

root@localhost.cisco.com#


Getting Help

When you have successfully logged in, enter a ? and press Return or enter the help command for a list 
of commands used to configure the NAM. For example:

Cisco Network Analysis Module (WS-SVC-NAM-2) Console, 4.2(1)
Copyright (c) 1999-2010 by cisco Systems, Inc.

root@localhost.cisco.com# ?
?                         - display help
alarm                     - configure NAM MIB/voice alarms
application               - configure a protocol group
audit-trail               - enable logging Web GUI and CLI accesses
autostart                 - enable/disable autostart collections
cdp                       - set cdp settings
clear                     - clear access log / system alerts
config                    - configure NAM
coredump                  - retrieve the coredump file
custom-filter             - configure capture/decode custom filters
diffserv                  - differentiated service related configurations
email                     - set email server and sending alarm via email
entity                    - entity related configurations
exit                      - log out of system
exsession                 - enable/disable outside logins
ftp                       - set FTP server and directory for storing schedule exports
help                      - display help
import                    - import file to NAM
ip                        - set ip parameters
logout                    - log out of system
monitor                   - enable collections
mpls                      - MPLS related configuration
netflow                   - netflow related configuration
no                        - delete various configurations
nslookup                  - query nameservers
password                  - set new password
patch                     - download and install new patch
ping                      - ping a network device
preferences               - configure web interface preferences for all users
protocol                  - set parsing protocol features
reboot                    - reboot the system
remote-storage            - set network storage target for capture data
rmon                      - configure RMON collections
rmwebusers                - remove all web users from local web user database
show                      - show system parameters
shutdown                  - shut down the system
snmp                      - set snmp parameters
supervisor                - set supervisor address
syslog                    - configure NAM syslog
terminal                  - set terminal parameters
time                      - configure NAM system time settings
traceroute                - traceroute to a network device
trap-dest                 - create/edit NAM trap destination
upgrade                   - download and install new maintenance image
web-publication           - set web publication settings for monitoring webs
web-user                  - create/edit local web user 

Command Mode

The Network Analysis Module provides a configurable command mode accessible when you log into the NAM as "root." Certain commands enter into a subcommand mode. In all command and subcommand modes, the asterisk (*) specifies that the subcommand is mandatory.

Subcommand Mode

Some commands enter into a subcommand mode, which provides additional configuration commands that you can use in that mode. For example:

root@localhost.cisco.com# monitor host
Entering into subcommand mode for this command.
Type 'exit' to come out of this mode.
Type 'cancel' to discard changes and to come out of this mode.
root@localhost.cisco.com(sub-monitor-host)# 

When you have entered the subcommand mode, type a ? or enter the help command for a list of commands available in that subcommand mode. For example:

root@localhost.cisco.com(sub-monitor-host)# ? 
? - display help 
cancel - discard changes and exit from sub-command mode 
control-index - specify the collection control index 
data-source - specify the collection data source (*) 
exit - exit from the sub-command mode 
help - display help 
owner - specify the collection owner 


Note For the commands that enter into a subcommand mode, the actual configuration is completed only when you enter the exit command.


Creation and Edit Modes

Some commands run in a creation mode and an edit mode, which alternate depending on whether you are creating or changing (editing) a configuration. For example, if you are configuring an RMON buffer collection and you specify an index using the index command, if the index already exists, you will be in the edit mode. If the index does not exist, you will be in the creation mode. If you specify an index in creation mode, the index will be used. If you do not specify an index, or the index did not exist, a random index is used.

Branch Routers

This section describes how to open a session on a branch router (includes the 2800, 2900, 3700, 3800, and 3900 series multi-services and integrated services routers).


Note You can conduct only one session at a time.


SUMMARY STEPS

From the Router CLI

1. enable

2. service-module integrated-service-engine slot/0 session clear

3. service-module integrated-service-engine slot/0 session

DETAILED STEPS

 
Command or Action
Purpose

Step 1 

enable

Example:

Router> enable

Enters privileged EXEC mode on the host router. Enter your password if prompted.

Step 2 

service-module integrated-service-engine slot/0 session clear

Example:

Router# service-module integrated-Service-Engine 1/0 session clear

[confirm]

[OK]

Router#


Make sure there is not an existing session which will prevent this session to login successfully.

Step 3 

service-module integrated-service-engine slot/0 session

Example:

Router# service-module integrated-Service-Engine 1/0 session

Trying 172.20.98.151, 2066 ... Open


Cisco Network Analysis Module (NME-NAM-120S)


NAM.domain.name login:


Begins a session on the specified module.

WAAS Virtual Services Blade

For additional configuration instructions, see the Cisco Wide Area Application Services online help included with the software application.

SUMMARY STEPS

From the Host-Router CLI

1. enable

2. service-module integrated-service-engine slot/0 status

3. service-module integrated-service-engine slot/0 session

From the Network Module Interface

4. Log in to the network module.

5. Perform configuration or other procedures by using the CLI.

6. Press Control-Shift-6 x.

From the Host-Router CLI

7. service-module integrated-service-engine slot/0 session clear

DETAILED STEPS

 
Command or Action
Purpose
 
From the Host-Router CLI

Step 1 

enable

Example:

Router> enable

Enters privileged EXEC mode on the host router. Enter your password if prompted.

Step 2 

service-module integrated-service-engine slot/0 status

Example:

Router# service-module integrated-service-engine 2/0 status

Displays the status of the specified module so that you can ensure that the module is running (that is, in the steady state).

Step 3 

service-module integrated-service-engine slot/0 session


or

telnet module-ip-address port

Example:

Router# service-module integrated-service-engine 1/0 session


Trying 10.10.10.1, 2066 ... Open


or

Router# telnet 10.10.10.1 2066

Begins a service module session on the specified module. Do one of the following:

To interrupt the auto-boot sequence and access the bootloader, quickly type ***.

To start a configuration session, press Enter.

To use telnet to access the network module, use the second form of the command.

 
From the Network-Module Interface

Step 4 

Cisco Wide Area Application Services Engine Console


Username: admin

Password:


System Initialization Finished.


SE-Module#

Log in to the network module. The default username is admin and the default password is default.

Step 5 

Example (Configuration):

SE-Module# configure terminal

SE-Module(config)#

.

.

.

SE-Module(config)# exit

SE-Module# write

Enter configuration commands on the module as needed. Configuration command choices are similar to those commands that are available on the router. Access global configuration mode by using the configure terminal command. Enter configuration commands. Then exit global configuration mode with the exit command and save your new configuration with the write command.

Step 6 

Press Ctrl-Shift-6 x.

Closes the service module session and returns to the router CLI.

Note The service module session stays up until you clear it in the next step. While it remains up, you can return to it from the router CLI by pressing Enter.

 
From the Host-Router CLI

Step 7 

service-module integrated-service-engine slot/0 session clear

Example:

Router# service-module integrated-service-engine 1/0 session clear

Clears the service module session for the specified module. When prompted to confirm this command, press Enter.

Nexus 1010 Virtual Services Appliance

DETAILED STEPS


Step 1 Power on the VM, choose Install Cisco Nexus 1000V, and bring up the new image.

One of the following screens displays.


Note It may take up to 5 minutes for the VM to power on.


Step 2 When asked, enter and confirm the Administrator password.

Example:

---- System Admin Account Setup ----
Enter the password for "admin":
Confirm the password for "admin":

Step 3 When asked, enter the domain ID.

Example:

Enter the domain id<1-4095>: 152

Step 4 When asked, enter the HA role.

If you do not specify a role, standalone is assigned by default.

Example: standalone or primary

Enter HA role[standalone/primary/secondary]: primary

[#########################################] 100%

---- Basic System Configuration Dialog ----

This setup utility will guide you through the basic configuration of

the system. Setup configures only enough connectivity for management

of the system.

*Note: setup is mainly used for configuring the system initially,

when no configuration is present. So setup always assumes system

defaults and not the current system configuration values.

Press Enter at anytime to skip a dialog. Use ctrl-c at anytime

to skip the remaining dialogs.


Would you like to enter the basic configuration dialog (yes/no): 



Example: Secondary
Enter HA role[standalone/primary/secondary]: secondary


  Setting HA role to secondary will cause a system reboot. Are you sure (yes/no) ? :