Table Of Contents

Command-Line Interface

Logging in to the NAM

Getting Help

Command Mode

Subcommand Mode

Creation and Edit Modes

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

•Getting Help

•Command Mode

•Subcommand Mode

•Creation and Edit Modes

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

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

For information about supported platforms, Cisco IOS releases, and Catalyst operating system releases, refer to this URL:

http://www.cisco.com/en/US/products/sw/cscowork/ps5401/index.html

Logging in to the NAM

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, 3.6(1)

Copyright (c) 1999-2007 by Cisco Systems, Inc.

root@localhost.cisco.com#

Getting Help

When you have successfully logged in, type 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, 3.6(1)

Copyright (c) 1999-2003 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.