Network Analysis Module Command Reference Guide, 3.6
A-I Commands
Downloads: This chapterpdf (PDF - 617.0KB) The complete bookPDF (PDF - 2.52MB) | Feedback

Network Analysis Module Commands

Table Of Contents

Network Analysis Module Commands

alarm event

alarm mib

alarm voice

application group

audit-trail enable

autostart

cdp enable

cdp hold-time

cdp interval

clear access log

clear system-alerts

config clear

config network

config upload

coredump

custom-filter capture

custom-filter decode

diffserv aggregate

diffserv profile

email

entity alias

entity assetid

exit

exsession

ftp

help

ip address

ip broadcast

ip gateway

ip host

ip hosts add

ip hosts delete

ip http port

ip http secure generate

ip http secure install certificate

ip http secure server

ip http secure port

ip http server

ip http tacacs+

ip interface

ip nameserver


Network Analysis Module Commands


This chapter contains an alphabetical listing of the commands unique to the Catalyst 6500 series and Cisco 7600 series Network Analysis Module (NAM) and the NM-NAM network module.

For information about Cisco IOS commands that are used to configure the switch, refer to the current Cisco IOS documentation including:

Catalyst 6500 Series Switch Cisco IOS Software Configuration Guide

Catalyst 6500 Series Switch Cisco IOS Software Command Reference

For information about Catalyst operating system commands that are used to configure the switch, refer to the current Catalyst operating system documentation including:

Catalyst 6500 Series Switch Configuration Guide

Catalyst 6500 Series Switch Command Reference

For information about the NM-NAM network module, refer to this URL:

http://lbj.cisco.com/targets/ucdit/cc/td/doc/product/software/ios123/123newft/123limit/123x/123xd/nm_nam.htm

alarm event

To enter the alarm event configuration subcommand mode, and then configure alarm NAM events, use the alarm event command. To remove an alarm event, use the no form of this command.

alarm event

no alarm event 1-65535

Syntax Description

1-65535

Specifies the event control index.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

When you enter the alarm event submode, the following commands are available:

cancel—Discards changes and exits from the subcommand mode.

community community_string—(Optional) Sets the community string.

description description-string—Sets the alarm description.

exit—Saves changes and exits from the subcommand mode; see the "exit" command section.

index index(Optional) Sets the alarm index. Range is from 1 to 65535.

owner owner-string—(Optional) Specifies the collection owner. Default is monitor.


Note The collections that are configured in the CLI will not be visible in the GUI. For collections that use a GUI screen, you can make them visible in the GUI by using the owner string "LocalMgr."


type [both | log | none | trap](Optional) Sets the event to both log and trap, log, none, or trap.

Examples

This example shows how to configure an alarm event:

root@hostname.cisco.com# alarm event
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@hsotname.cisco.com(sub-alarm-event)# ?
?                         - display help
cancel                    - discard changes and exit from subcommand mode
community                 - set community string
description               - set description
exit                      - exit from subcommand mode
help                      - display help
index                     - set index
owner                     - set owner string
type                      - set type
root@hostname.cisco.com(sub-alarm-event)# community public
root@hostname.cisco.com(sub-alarm-event)# description test-event
root@hostname.cisco.com(sub-alarm-event)# index 100
root@hostname.cisco.com(sub-alarm-event)# owner monitor
root@hostname.cisco.com(sub-alarm-event)# type both
root@hostname.cisco.com(sub-alarm-event)# exit
Successfully created the event.
root@hostname.cisco.com# show alarm event
Index:      100
Description:test-event
Type:       Log and trap
Community:  public
Owner:      monitor
root@hostname.cisco.com#

Related Commands

alarm mib
alarm voice
show alarm event
show alarm mib
show alarm voice

alarm mib

To enter the alarm MIB configuration subcommand mode, and then configure NAM MIB alarms, use the alarm mib command. To remove an alarm MIB entry, use the no form of this command.

alarm mib

no alarm mib 1-65535

Syntax Description

1-65535

Specifies the event control index.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

When you enter the alarm MIB submode, the following commands are available:

cancel—Discards changes and exits from the subcommand mode.

exit—Saves changes and exits from the subcommand mode; see the "exit" command section.

falling-event 1-65535Sets the falling event index. Range is from 1 to 65535.

falling-threshold number (Optional) Sets the number of packets for the falling event threshold. Default is 0 packets.

index 1-65535(Optional) Sets the alarm index. Range is from 1 to 65535.

interval seconds(Optional) Sets the polling interval in seconds. Default is 60 seconds.

owner string(Optional) Sets the owner string. Default is monitor.


Note The collections that are configured in the CLI will not be visible in the GUI. For collections that use a GUI screen, you can make them visible in the GUI by using the owner string "LocalMgr."


rising-event 1-65535Sets the rising event index. Range is from 1 to 65535.

rising-threshold number(Optional) Sets the number of packets for the rising event threshold. Default is 0 packets.

sample-type absolute | deltaSets the sample type to absolute or delta.

startup-alarm both | falling | risingSets the startup alarm to both rising and falling, falling, or rising.

variable OIDSets the object identifier (OID) variable.

Examples

This example shows how to set a MIB alarm:

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@hostname.cisco.com(sub-alarm-mib)# ?
?                         - display help
cancel                    - discard changes and exit from subcommand mode
exit                      - exit from subcommand mode
falling-event             - set falling event index (*)
falling-threshold         - set number of pkts for falling threshold
help                      - display help
index                     - set alarm index
interval                  - set polling interval
owner                     - set owner string
rising-event              - set rising event index (*)
rising-threshold          - set number of pkts for rising threshold
sample-type               - set sample type (*)
startup-alarm             - set startup alarm (*)
variable                  - set variable (*)
 
(*) - denotes a mandatory field for this configuration.
root@hostname.cisco.com(sub-alarm-mib)# falling-event 100
root@hostname.cisco.com(sub-alarm-mib)# rising-event 100
root@hostname.cisco.com(sub-alarm-mib)# sample-type delta
root@hostname.cisco.com(sub-alarm-mib)# startup-alarm both
root@hostname.cisco.com(sub-alarm-mib)# variable nlHostInPkts.29673.0.1.4.10.77.201.68
root@hostname.cisco.com(sub-alarm-mib)# exit
Successfully created the NAM MIB alarm.
root@hostname.cisco.com# show alarm mib
Index:               19967
Polling interval:    60 secs
Variable:            nlHostInPkts.29673.0.1.4.10.77.201.68
Sample type:         Delta
Startup:             Rising & falling
Rising threshold:    0 Pkts
Falling threshold:   0 Pkts
Rising event index:  100
Falling event index: 100
Owner:               monitor

root@hostname.cisco.com#

Related Commands

alarm mib
alarm voice
show alarm event
show alarm mib
show alarm voice

alarm voice

To enter the alarm voice configuration subcommand mode, and then configure NAM voice alarms, use the alarm voice command. To disable voice alarm, use the jitter-alarm disable or the pkt-loss-alarm disable subcommands.

alarm voice

Syntax Description

This command has no arguments or keywords.

Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

When you enter the alarm voice submode, the following commands are available:

cancel—Discards changes and exits from the subcommand mode.

exit—Saves changes and exits from the subcommand mode; see the "exit" command section.

jitter-alarm enable | disable(Optional) Enables or disables the jitter alarm.

jitter-threshold int(Optional) Sets the jitter threshold in milliseconds. Default for SCCP is 30 milliseconds, H.323 is 150 milliseconds, and MGCP is 30 milliseconds.

pkt-loss-alarm enable | disable(Optional) Enables or disables the packet loss alarm.

pkt-loss-threshold int(Optional) Sets the packet loss threshold in percentage(%). Default is 5 percent for all three protocols, SCCP, H.323, and MGCP.

protocol H.323 | SCCP | MGCPSets the voice protocol to H323, SCCP, or MGCP.

The MGCP protocol option is specific to the Network Analysis Module (NAM) software release running on network modules in the Cisco 2600, 3600, 3700 routers.

Examples

This example shows how to set a voice alarm:

root@localhost# alarm voice 
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@hostname.cisco.com(sub-alarm-voice)# ?
?                         - display help
cancel                    - discard changes and exit from subcommand mode
exit                      - exit from subcommand mode
help                      - display help
jitter-alarm              - enable/disable jitter alarm
jitter-threshold          - set jitter threshold
pkt-loss-alarm            - enable/disable packet loss alarm
pkt-loss-threshold        - set packet loss threshold
protocol                  - set protocol (*)
 
(*) - denotes a mandatory field for this configuration.
root@hostname.cisco.com(sub-alarm-voice)# protocol SCCP
root@hostname.cisco.com(sub-alarm-voice)# jitter-alarm enable
root@hostname.cisco.com(sub-alarm-voice)# jitter-threshold 50
root@hostname.cisco.com(sub-alarm-voice)# exit
Successfully updated the SCCP configuration.
root@hostname.cisco.com# show alarm voice
SCCP:
        Jitter alarm:         Disabled
        Packet lost alarm:    Disabled
        Jitter threshold:     30 msecs
        Packet lost threshold:5%
H.323:
        Jitter alarm:         Disabled
        Packet lost alarm:    Disabled
        Jitter threshold:     150 msecs
        Packet lost threshold:5%
MGCP:
        Jitter alarm:         Enabled
        Packet lost alarm:    Enabled
        Jitter threshold:     31 msecs
        Packet lost threshold:6%

Related Commands

alarm mib
show alarm event
show alarm mib
show alarm voice

application group

To enter the application group submode and define an application group, use the application group command.

application group

no application group group-name

Syntax Description

group-name

Application group name.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

When you enter the application group submode, the following commands are available:

add protocol-specifierAdds a protocol to the group. You only can add one protocol to a group at a time (for example, HTTPS). This command allows you to group statistics for more than one specified protocol into one counter.

To add two or more protocols to an application group, repeat the add command for each protocol. The protocols are added only when you exit application group subcommand mode.

cancel—Discards changes and exits from the subcommand mode; see the "cdp enable" command section.

delete protocol-specifierRemoves a protocol from the group. You only can remove one protocol from a group at a time.

To remove two or more existing protocols from an existing application group, repeat the delete command for each protocol. The protocol is removed only when you exit the application group subcommand mode.

exit—Saves changes and exits from the subcommand mode; see the "exit" command section.

help—Displays help and keeps you in the application group subcommand mode; see the "help" command section.

name string—Sets the the application group name.

You must provide protocol specifiers in the add or delete parameters, or both the add and delete parameters.

Examples

This example shows how to create an application group named appBrpSample with two protocols in the group:

root@NAM# application group
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@NAM(sub-application-group)# ?
?                         - display help
add                       - add a protocol to the group (*)
cancel                    - discard changes and exit from subcommand mode
delete                    - remove a protocol from the group (*)
exit                      - exit from subcommand mode
help                      - display help
name                      - set application group name (*)

(*) - denotes a mandatory field for this configuration.
root@NAM(sub-application-group)# add 16.1.0.0.1.0.0.8.0.0.0.0.6.0.0.3.68.4.0.1.0.0
root@NAM(sub-application-group)# add 16.1.0.0.1.0.0.8.0.0.0.0.17.0.0.4.60.4.0.1.0.0
root@NAM(sub-application-group)# name appGrpSample
root@NAM(sub-application-group)# exit
Sucessfully create application group appGrpSample.
root@NAM#
root@NAM#
root@NAM# show application group appGrpSample
Application Group: appGrpSample
    Number of Protocols: 2
      - w-ether2.ip.tcp.tcp-836
        16.1.0.0.1.0.0.8.0.0.0.0.6.0.0.3.68.4.0.1.0.0
      - w-ether2.ip.udp.udp-1084
        16.1.0.0.1.0.0.8.0.0.0.0.17.0.0.4.60.4.0.1.0.0

root@NAM#

Related Commands

show application group

audit-trail enable

To enable and audit trail of GUI and CLI accesses, use the audit-trail enable command. To disable audit trail of GUI and CLI accesses, use the no form of this command:

audit-trail enable

no audit-trail enable

Defaults

Audit trail of the CLI and GUI accesses is enabled.

Command Modes

Command mode

Examples

This example shows how to enable an audit trail for GUI and CLI accesses:

root@hostname.cisco.com# audit-trail enable

Related Commands

show audit-trail

autostart

To enable or disable autostart collections, use the autostart command.

autostart collection {enable | disable}

Syntax Description

collection

Specifies a collection. Valid collections are etherstats, addressmap, priostats, vlanstats, and art.

enable

Enables autostart.

disable

Disables autostart.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to enable autostart collections on the NAM:

root@hostname.cisco.com# autostart ?
addressmap                - enable/disable autostart address map
art                       - enable/disable autostart art
etherstats                - enable/disable autostart ether stats
priostats                 - enable/disable autostart prio stats
vlanstats                 - enable/disable autostart vlan stats
root@hostname.cisco.com# autostart etherstats enable 
root@hostname.cisco.com# show autostart 
etherstats enable
addressmap disable
priostats disable
vlanstats disable
art disable
root@hostname.cisco.com# 

Related Commands

show autostart

cdp enable

To enable the Cisco Discovery Protocol (CDP) on the NM-NAM, use the cdp enable command. To disable CDP on the NM-NAM, use the no form of this command.

cdp enable

no cdp enable

Syntax Description

This command has no arguments or keywords.

Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

This command is supported only on the NM-NAM. This command is disabled on the NAM-1 and NAM-2.

Examples

This example shows how to enable CDP:

root@localhost.cisco.com# cdp enable
root@localhost.cisco.com#

Related Commands

cdp hold-time
cdp interval
show cdp settings

cdp hold-time

To set the Cisco Discovery Protocol (CDP) messages hold time, use the cdp hold-time command. To return the CDP messages hold time to the default value, use the no form of this command.

cdp hold-time time

no cdp hold-time

Syntax Description

time

Specifies the CDP hold time. Range is from 10 to 255 seconds.


Defaults

180 seconds.

Command Modes

Command mode

Examples

This example shows how to set the CDP messages hold time:

root@localhost.cisco.com# cdp hold-time 30
root@localhost.cisco.com#

Related Commands

cdp enable
cdp interval
show cdp settings

cdp interval

To set the Cisco Discovery Protocol (CDP) messages interval on the NM-NAM, use the cdp interval command. To return the CDP messages interval on the NM-NAM to the default value, use the no form of this command.

cdp interval time

no cdp interval

Syntax Description

time

Specifies the CDP messages interval. Range is from 5 to 254 seconds.


Defaults

60 seconds

Command Modes

Command mode

Examples

This example shows how to set the CDP messages interval:

root@localhost.cisco.com# cdp interval 200
root@localhost.cisco.com#

Related Commands

cdp enable
cdp hold-time
show cdp settings

clear access log

To clear the access log, use the clear access log command.

clear access-log

Syntax Description

This command has no arguments or keywords.

Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to clear the access log:

root@localhost# clear access-log

Related Commands

clear system-alerts
config clear

clear system-alerts

To clear the system alerts, use the clear system-alerts command.

clear system-alerts

Syntax Description

This command has no arguments or keywords.

Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to clear the system alerts:

root@localhost# clear system-alerts

Related Commands

clear access log
config clear

config clear

To reset the NAM and return it to the factory-default state, use the config clear command.

config clear [all | ip]

Syntax Description

all

(Optional) Resets the NAM to the factory-default state including the NAM IP parameters configuration. The NAM reboots automatically for the changes to take effect.

ip

(Optional) Resets the NAM IP parameters to the manufacturing-default state. The NAM reboots automatically, and you must session into the NAM from the switch supervisor engine to configure the NAM IP parameters so that the module can come online.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to clear the configuration:

root@localhost# config clear
This operation will reset the NAM configuration with the exception
of NAM IP parameters.

This operation will also reboot the NAM to allow the changes to
take effect.

Do you wish to continue? (y/n) [n]:y
Successfully updated the SCCP configuration.
Successfully updated the H.323 configuration.
NAM syslog settings updated successfully.
NAM web interface preferences updated successfully.

Successfully modified the configuration.
NAM will be rebooted now, for the changes to take effect ...

config network

To import a NAM configuration into the NAM from a specified location, use the config network command.

config network url

Syntax Description

url

Specifies the NAM configuration location.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to download a configuration file to a NAM named kluu-test.config, which is located at the FTP server namlab-pc1 in the user home directory named /home/kluu directory.

root@NAM #
root@NAM # config network ftp://kluu@namlab-pc1//home/kluu/kluu-test.config
Downloading ftp://kluu@namlab-pc1//home/kluu/kluu-test.config, please wait ...

Password for kluu@namlab-pc1:
ftp://kluu@namlab-pc1//home/kluu/kluu-test.config (9K)
/tmp/lrcfile.txt.1007     [########################]       9K | 4916.90K/s
9748 bytes transferred in 0.00 sec (4274.44k/sec)

Download completed.

Configuring the NAM. This may take few minutes, please wait ...

NAM configuration completed.
To view the results, use the command 'show log config'.
root@NAM #

config upload

To upload the running NAM configuration to a specified location, use the config upload command.

config upload url [filename]

Syntax Description

url

Specifies the configuration location.

filename

(Optional) Specifies the filename for the configuration.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to upload the NAM running configuration to the FTP server named namlab-pc1 with a filename of example.config:

root@NAM# config upload ftp://kluu@namlab-pc1.cisco.com example.config
Building configuration, please wait... Done.

Uploading the configuration to 'example.config'
on 'ftp://kluu@namlab-pc1.cisco.com', This may take few minutes ...

Password:

Successfully uploaded the NAM configuration.
root@NAM#

coredump

To retrieve the core dump file, use the coredump command.

coredump ftp://user:passwd@host/full-path/

Syntax Description

ftp://user:passwd@host/full-path/

Sets the path to the core dump file.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to retrieve a core dump:

root@localhost# coredump ftp://user:passwd@host/full-path/

custom-filter capture

To enter the custom filter capture subcommand mode, and then configure custom filter capture settings, use the custom-filter capture command. To remove custom filter capture, use the no capture-filter filtername command.

custom-filter capture

no capture-filter filtername

Syntax Description

filtername

Specifies the filter to remove.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

When you enter the custom filter capture submode, the following commands are available:

base OID(Optional) Sets the base object identifier (OID) variable.

cancel—Discards changes and exits from the subcommand mode.

data hex-string(Optional) Sets the data.

data-mask hex-string(Optional) Sets the data mask.

data-not-mask hex-string(Optional) Sets the data-not mask.

description string(Optional) Sets the filter description.

exit—Saves changes and exits from the subcommand mode; see the "exit" command section.

filter-name stringSets the filter name.

offset 0-65535(Optional) Sets the offset. Range is 0 to 65535.

protocol OID Sets the protocol object identifier (OID) variable.

status 0-65535 (Optional)Sets the status. Range is 0 to 65535.

status-mask 0-65535(Optional) Sets the status mask. Range is 0 to 65535.

status-not-mask 0-65535(Optional) Sets the status-not mask. Range is 0 to 65535.

Examples

This example shows how to configure custom filter settings:

root@localhost# custom-filter capture
Entering into sub-command 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-custom-filter-capture)# 

Related Commands

custom-filter capture
custom-filter decode
show custom-filter capture
show custom-filter decode

custom-filter decode

To enter the custom-filter decode subcommand mode, and then configure custom filter decode settings, use the custom-filter decode command. To remove custom filter decode, use the no decode-filter filtername command.

custom-filter decode

no decode-filter filtername

Syntax Description

filtername

Specifies the filter to remove.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

When you enter the custom-filter decode submode, the following commands are available:

address-type ip | mac(Optional) Sets the address type to IP or MAC.

base OID(Optional) Sets the base object identifier (OID) variable.

cancel—Discards changes and exits from the subcommand mode.

data hex-string(Optional) Sets the data.

description string(Optional) Sets the filter description.

direction both | single(Optional) Applies the filter to both directions or a single direction.

dst-address address(Optional) Sets the traffic destination address.

exit—Saves changes and exits from the subcommand mode; see the "exit" command section.

filter-expression expression-string(Optional) Sets the filter expression.

filter-name stringSets the filter name.

offset 0-1518(Optional) Sets the offset. Range is 0 to 1518.

protocol string Sets the protocol.

src-address address (Optional)Sets the data stream source address.

Examples

This example shows how to custom filter decode settings:

root@localhost<sub># custom-filter decode
Entering into sub-command 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-custom-filter-decode)# filter-name 12345

Related Commands

custom-filter capture
custom-filter decode
show custom-filter capture
show custom-filter decode

diffserv aggregate

To enter the differentiated services aggregate configuration subcommand mode, and then configure differentiated services aggregation, use the diffserv aggregate command. To remove differentiated services aggregation, use the no form of this command.

diffserv aggregate

no diffserv aggregate control-index

Syntax Description

control-index

Specifies the collection control index. Range is from 1 to 65535.


Defaults

The control index is random.

Command Modes

Command mode

Usage Guidelines

When you enter the differentiated services aggregation submode, the following commands are available:

cancel—Discards changes and exits from the subcommand mode.

control-index control-index—(Optional) Specifies the collection control index. Range is from 1 to 65535. Default is random.

description description—Specifies the aggregate description.

exit—Saves changes and exits from the subcommand mode; see the "exit" command section.

owner owner-string—(Optional) Specifies the collection owner. Default is monitor.


Note The collections that are configured in the CLI will not be visible in the GUI. For collections that use a GUI screen, you can make them visible in the GUI by using the owner string "LocalMgr."


Examples

This example shows how to configure differentiated services aggregation:

root@localhost# diffserv aggregate
Entering into sub-command mode for this command.
Type 'cancel' to discard changes and to come out of this mode.
root@localhost(sub-diffserv-aggregate)# descr test1
root@localhost(sub-diffserv-aggregate)# exit
Successfully created a diffserv aggregate.
root@localhost# show diffserv aggregate
Control index:                25013
Description:                  test1
Owner:                        monitor
Status:                       1
root@localhost# no diffserv aggregate 25013
Successfully removed the diffserv aggregate. 

Related Commands

diffserv profile
show diffserv aggregate

diffserv profile

To enter the differentiated services profile configuration subcommand mode, and then configure differentiated services profile, use the diffserv profile command. To remove differentiated services aggregation, use the no form of this command.

diffserv profile

no diffserv profile profile-index

Syntax Description

profile-index

Specifies a differentiated services aggregate control index. Range is from 1 to 65535.

Note Use the diffserv aggregate command to first create the differentiated services control index, and then use the show diffserv aggregate command to obtain a differentiated services aggregate control index.


Defaults

The profile index is random.

Command Modes

Command mode

Usage Guidelines

When you enter the differentiated services profile submode, the following commands are available:

cancel—Discards changes and exits from the subcommand mode.

descripton DSCP-value | description—(Optional) Specifies the aggregate description.

exit—Saves changes and exits from the subcommand mode; see the "exit" command section.

profile-index profile-index— Specifies the entry control index for an existing differentiated services aggregate. Range is from 1 to 65535. Default is random.


Note To create a new differentiated services profile entry, you must obtain a new differentiated services aggregate control index by using the diffserv aggregate command to create a new differentiated services aggregate entry before using the diffserv profile command.


Examples

This example shows how to configure a differentiated services profile:

root@localhost# show diffserv aggregate
Control index:                25013
Description:                  test1
Owner:                        monitor
Status:                       1
root@localhost.cisco.com# diffserv profile
Entering into sub-command 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-diffserv-profile)# profile-index 25013
root@localhost.cisco.com(sub-diffserv-profile)# descr 0 dscpA
root@localhost.cisco.com(sub-diffserv-profile)# descr 1 dscpB
root@localhost.cisco.com(sub-diffserv-profile)# exit
Successfully updated the differentiated service profile. 
root@localhost.cisco.com# show diffserv profile 25013
Aggregate Profile Index:25013
DSCP Value     Description
0            dscpA
1            dscpB
root@localhost.cisco.com# no diffserv profile 25013
Successfully removed the diffserv profile. 

Related Commands

show diffserv aggregate
show diffserv profile

email

To set up an email server that sends both alarm and report data through email, enable or disable alarm messages sent through email, and enter the subcommand mode, use the email command. To remove the email server, use the no email server command. To stop sending out both scheduled report data and alarm messages through email, use the no email alarm command.

email

no email server

no email alarm

Syntax Description

This command has no arguments or keywords.

Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

(Note: the recipients are alarm messages recipients. Report data recipients are not supported on CLI because there is not any CLI command for setting up a scheduled report.)

When you enter the email subcommand mode, the following commands are available:

? or help—Displays help; see the "help" command section.

cancel—Discards changes and exits from the subcommand mode.

exit—Saves changes and exits from the subcommand mode; see the "exit" command section.

server email-server—Specifies the email server name.

alarm enable Enables sending alarm messages through email.

alarm disable—Disables sending alarm messages through email.

alarm recipients space-seperated-list-of-email-addresses

Examples

This example shows how to set up the NAM to send scheduled reports through email to abc@example.com and xyz@example.com:

root@localhost# email
proot@localhost(sub-email)# server example-email.domain.com
root@localhost(sub-email)# alarm enable
root@localhost(sub-email)# alarm recipients admin@domain.com another_admin@domain.com 
root@localhost(sub-email)# exit
Successfully set email configuration settings.

Related Commands

show email

entity alias

To configure an entity alias for the entity MIB, use the entity alias command.

entity alias string

Syntax Description

string

Specifies the entity string used to configure the entPHysicalAlias.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

The entity MIB makes the entPhysicalTable and entLastChangeTime available through SNMP.

The clear configuration command deletes the entity alias and asset ID by setting them to an empty string.

Examples

This example shows how to log out of the NAM:

root@localhost# entity alias 123456

Related Commands

show entity

entity assetid

To configure an entity MIB asset ID, use the entity assetid command.

entity assetid string

Syntax Description

string

Specifies the entity string used to configure the entPHysicalAssetID.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

The entity MIB makes the entPhysicalTable and entLastChangeTime available through SNMP.

The clear configuration command deletes the entity alias and asset ID by setting them to an empty string.

Examples

This example shows how to log out of the NAM:

root@localhost# entity assetid 1234566

Related Commands

show entity

exit

To log out of the system or to leave a subcommand mode, use the exit command.

exit

Syntax Description

This command has no arguments or keywords.

Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

To leave a subcommand mode, use the exit command. The exit command saves any changes before leaving the submode.

Examples

This example shows how to log out of the NAM:

root@localhost# exit

exsession

To enable or disable outside logins, use the exsession command.

exsession on [ssh]

exsession off

Syntax Description

on

Enables outside logins.

off

Disables outside logins.

ssh

(Optional) Sets the outside logins to SSH.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

A strong crypto patch is required if you use the ssh option.

Examples

This example shows how to allow outside logins to the NAM:

root@localhost# exsession on

ftp

To set the FTP server and directory for storing scheduled reports, use the ftp command. To disable FTP scheduled reports, use the no form of this command.

ftp

no ftp

Syntax Description

This command has no arguments or keywords.

Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

When you enter the FTP subcommand mode, the following commands are available:

? or help—Displays help; see the "help" command section.

cancel—Discards changes and exits from the subcommand mode.

directory WORD—Specifies the FTP location on the FTP server.

exit—Saves changes and exits from the subcommand mode; see the "exit" command section.

password WORD—Specifies the user password on the FTP server.

user WORD—Specifies the user name on the FTP server.

server WORD—Specifies the FTP server name or IP address.

Examples

This example shows how to set the FTP server for storing scheduled reports:

root@localhost<sub-email># ftp
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@namlab-kom7.cisco.com(sub-ftp)# ?

Related Commands

show ftp

help

To display help, use the help command or ?. You must press the Enter key after entering the ?.

help | ?

Syntax Description

This command has no arguments or keywords.

Defaults

This command has no default settings.

Command Modes

Command mode or subcommand mode

Examples

This example shows how to display help:

root@localhost# help
?                         - display help
alarm                     - configure NAM MIB/voice alarms
autostart                 - enable/disable autostart collections
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
exit                      - log out of system
exsession                 - enable/disable outside logins
help                      - display help
ip                        - set ip parameters
logout                    - log out of system
mfgtest                   - Manufacturing only tests
monitor                   - enable collections
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
reboot                    - reboot the system
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
syslog                    - configure NAM syslog
time                      - configure NAM timezone/time sync settings
traceroute                - traceroute to a network device
trap-dest                 - create/edit NAM trap destination
upgrade                   - download and install new maintenance image
voice                     - enable/disable voice collections
web-user                  - create/edit local web user

ip address

To set the system IP address, use the ip address command.

ip address ip-address subnet-mask

Syntax Description

ip-address

Sets the system IP address.

subnet-mask

Sets the subnet mask.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

After setting the IP address, the gateway address may be set to 0.0.0.0. When this situation occurs, use the ip gateway command to set the gateway address.

The broadcast address is automatically set with an address that is created using the new IP address and network mask. To select a different broadcast address, use the ip broadcast command

Examples

This example shows how to set the system IP address:

root@localhost# ip address 172.20.104.74 255.255.255.192
IP address and netmask configured successfully.
NOTE: Default gateway address has been reset to 0.0.0.0
Please use 'ip gateway' command to configure it.
root@localhost# ip gateway 172.20.104.66
root@localhost# show ip
IP address:             172.20.104.74
Subnet mask:            255.255.255.192
IP Broadcast:           172.20.255.255
DNS Name:               namlab-kom8.cisco.com
Default Gateway:        172.20.104.66
Nameserver(s):          171.69.2.133     
HTTP server:            Enabled
HTTP secure server:     Disabled
HTTP port:              80
HTTP secure port:       443
TACACS+ configured:     No
Telnet:                 Enabled
SSH:                    Disabled
root@localhost#

Related Commands

ip broadcast
ip gateway
ip host
show ip

ip broadcast

To set the system broadcast address, use the ip broadcast command.

ip broadcast broadcast-address

Syntax Description

broadcast-address

Sets the system broadcast address.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to set the system broadcast address:

root@localhost# ip broadcast 172.20.104.127
root@localhost# 

Related Commands

ip address
ip gateway
ip host
ip interface
show ip

ip gateway

To set the system default gateway address, use the ip gateway command.

ip gateway default-gateway

Syntax Description

default-gateway

Sets the default gateway address.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to set the IP gateway address:

root@localhost# ip gateway 123.34.56.0

Related Commands

ip address
ip broadcast
ip host
ip interface
show ip

ip host

To set the system host name, use the ip host command.

ip host name

Syntax Description

name

Sets the IP host name.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to set the IP host name:

root@localhost# ip host orion

Related Commands

ip address
ip gateway
ip interface
show ip

ip hosts add

To add or replace host entries, use the ip hosts add command.

ip hosts add ip-address host-name [alias1] [alias2]

ip hosts add ftp://user:passwd@host/full-path/filename

Syntax Description

ip-address

Sets the host IP address.

host-name

Sets the host name which can be an FTP URL with a filename.

alias1 alias2

(Optional) Sets the host alias.

ftp://user:passwd@host/full-path/filename

Sets the path to the host parameters file location.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

Use the ip hosts add ftp://user:passwd@host/full-path/filename command to import host entries to the NAM. A maximum of 1,000 entries can exist on the NAM.

Examples

This example shows how to add a specific IP host:

root@localhost# ip hosts add 30.50.68.10 orion

Related Commands

ip hosts delete
show hosts

ip hosts delete

To delete host entries, use the ip hosts delete command.

ip hosts delete ip-address

ip hosts delete ftp://user:passwd@host/full-path/filename

Syntax Description

ip-address

Sets the host IP address.

ftp://user:passwd@host/full-path/filename

Sets the path to the host parameters file location.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

Use the ip hosts delete ftp://user:passwd@host/full-path/filename command to remove host entries from the NAM.

Examples

This example shows how to delete a specific host:

root@localhost# ip hosts delete 172.20.98.129 

Related Commands

ip hosts add
show hosts

ip http port

To set the HTTP port, use the ip http port command.

ip http port 1-65535

Syntax Description

1-65535

Specifies a port number in the range of 1 through 65535.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to specify an HTTP port for the NAM:

root@localhost# ip http port 233

Related Commands

ip http secure generate
ip http server
ip http tacacs+
show ip

ip http secure generate

To generate a certificate request, use the ip http secure generate command.

ip http secure generate {certificate-request | self-signed-certificate}

Syntax Description

certificate-request

Generates a certificate request.

self-signed-certificate

Generates a self-signed certificate.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to set up a secure server:

root@localhost# ip http secure generate certificate-request

Related Commands

ip http port
ip http secure install certificate
ip http server
ip http tacacs+
show ip

ip http secure install certificate

To install a certificate, use the ip http secure install certificate command.

ip http secure install certificate

Syntax Description

This command has no arguments or keywords.

Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to set up a secure server:

root@localhost# ip http secure install certificate

Related Commands

ip http port
ip http secure generate
ip http server
ip http tacacs+
show ip

ip http secure server

To set up a secure server, use the ip http secure server command.

ip http secure server {enable | disable}

Syntax Description

server enable | disable

Enables or disables the HTTP server.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

A strong crypto patch is required before applying this command.

Examples

This example shows how to set up a secure server:

root@localhost# ip http secure server enable

Related Commands

ip http port
ip http secure generate
ip http secure install certificate
ip http server
ip http tacacs+
show ip

ip http secure port

To set up a secure server port, use the ip http secure port command.

ip http secure port port

Syntax Description

port

Sets the HTTP secure port.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to set up a secure server:

root@localhost# ip http secure port 30

Related Commands

ip http port
ip http secure generate
ip http secure install certificate
ip http server
ip http tacacs+
show ip

ip http server

To enable an HTTP server, use the ip http server command.

ip http server {enable | disable}

Syntax Description

enable

Enables the HTTP server.

disable

Disables the HTTP server.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how enable an HTTP server:

root@localhost# ip http server enable

Related Commands

ip http port
ip http secure generate
ip http tacacs+
show ip

ip http tacacs+

To enable a TACACS+ server, use the ip http tacacs+ command.

ip http tacacs+ enable primary-srv [backup-srv] [en-secret-key encrypted-secret-key]

ip http tacacs+ disable

Syntax Description

disable

Disables the TACACS+ server.

enable

Enables the TACACS+ server.

primary-srv

Specifies the primary TACAC+ server.

backup-srv

(Optional) Specifies the backup TACACS+ server.

en-secret-key

(Optional) Argument name to enable the secret key.

encrypted-secret-key

(Optional) Argument value.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

The en-secret-key keyword is used only during the importing of NAM configurations. This key cannot be used unless you can specify a DES-encrypted string as the argument to this keyword, as in this example:

root@localhost# ip http tacacs+ enable 10.0.0.1 10.0.0.2 en-secret-key "dEAF="

Examples

These examples show how to enable and disable TACACS+.

To enable TACACS+, enter this command:

root@hostname.cisco.com# ip http tacacs+ enable 10.0.0.1 10.0.0.2
Secret key:
Repeat secret key:
Successfully enabled Tacacs+
root@hostname.cisco.com# show ip
IP address:             172.20.98.177
Subnet mask:            255.255.255.192
IP Broadcast:           172.20.255.255
DNS Name:               hostname.cisco.com
Default Gateway:        172.20.98.129
Nameserver(s):          171.69.2.133
HTTP server:            Enabled
HTTP secure server:     Disabled
HTTP port:              80
HTTP secure port:       443
TACACS+ configured:     Yes
TACACS+ primary server: 10.0.0.1
TACACS+ backup server : 10.0.0.2
Telnet:                 Enabled
SSH:                    Disabled
root@hostname.cisco.com#

To disable TACACS+, enter this command:

root@hostname.cisco.com# ip http tacacs+ disable
TACACS+ disabled successfully.
root@hostname.cisco.com# show ip
IP address:             172.20.98.177
Subnet mask:            255.255.255.192
IP Broadcast:           172.20.255.255
DNS Name:               hostname.cisco.com
Default Gateway:        172.20.98.129
Nameserver(s):          171.69.2.133
HTTP server:            Enabled
HTTP secure server:     Disabled
HTTP port:              80
HTTP secure port:       443
TACACS+ configured:     No
Telnet:                 Enabled
SSH:                    Disabled
root@hostname.cisco.com#

Related Commands

ip http port
ip http secure generate
ip http server
show ip

ip interface

To select the external port or the internal ports for the NM-NAM, use the ip interface command.

ip interface external | internal

Syntax Description

external

Selects the RJ-45 Fast Ethernet connector on the NM-NAM.

internal

Selects the internal LAN segment to the router through the PCI interface for IP communication (for example Telnet, SNMP, HTTP, and so forth) to the NM-NAM.


Defaults

This command has no default settings.

Command Modes

Command mode

Usage Guidelines

This command is supported only on the NM-NAM.

Examples

This example shows how to specify an interface port for the NM-NAM:

root@localhost# ip interface external

Related Commands

ip address
show ip

ip nameserver

To set or disable system name server entries, use the ip nameserver command.

ip nameserver ip-addr ip-addr ip-addr

or

ip nameserver disable

Syntax Description

ip-addr

Sets the name server address.

disable

Disables the name server entries.


Defaults

This command has no default settings.

Command Modes

Command mode

Examples

This example shows how to set a system name server:

root@localhost# ip nameserver 171.69.2.133


Related Commands

ip address
show ip