-
Network Analysis Module Command Reference Guide, 5.0
-
Preface
-
CLI
-
NAM CLI Commands: application - device waas
-
NAM CLI Commands: email - managed device community
-
NAM CLI Commands: metric export host - show certificate request
-
NAM CLI Commands: show clock details - show monitor urlfilter
-
NAM CLI Commands: show patches - web user
-
MPCLI
-
Acronyms
-
Matrix
-
Index
-
Feedback
Table Of Contents
NAM CLI Commands:
application - device waas
NAM CLI Commands:
application - device waas
This chapter contains an alphabetical listing of the commands unique to the Catalyst 6500 series and Cisco 7600 series Network Analysis Module (NAM), Cisco NAM 2200 Series appliances, Cisco Virtual Services Blade on WAAS appliances and Cisco Branch router series NME-NAM modules.
For information about Cisco IOS commands that are used to configure the switch, see the current Cisco IOS documentation including:
•
Catalyst 6500 Series Switch Cisco IOS Software Configuration Guide
http://www.cisco.com/en/US/docs/switches/lan/catalyst6500/ios/12.1E/native/
configuration/guide/swconfig.html•
http://www.cisco.com/en/US/products/hw/switches/ps708/prod_command_reference_list.html
Each command lists whether it is specific to a NAM platform or if a NAM platform is excepted. Unless otherwise noted, commands are valid for all network analysis modules.
For ease of use, NAM CLI Commands, is divided into six different chapters:
•
•
•
•
•
This chapter describes the following commands:
application
To create an application, use the application command. To remove an application match, use the no application command.
application
no application
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
When you enter the application submode, the following commands are available:
•
•
•
•
•
Examples
This example shows how to create an application :
root@NAM# applicationnew application (app tag 268435459)Entering into subcommand mode for this command.Type 'exit' to apply changes and come out of this mode.Type 'cancel' to discard changes and come out of this mode.root@NAM(sub-application)# ?? - display helpcancel - discard changes and exit from subcommand modeexit - exit from the subcommand modehelp - display helpmatch - specify an application matchname - enter the application name (*)no - remove an application match(*) - denotes a mandatory field for this configuration.root@NAM(sub-application)#application group
To enter the application group submode and define an application group, use the application group command. To remove an application group, use the no form of this command.
application group
no application group group-name
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
When you enter the application group submode, the following commands are available:
•
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.
•
•
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.
•
•
•
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 appGrpSample with two protocols in the group:
root@NAM# application groupEntering 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 helpadd - add a protocol to the group (*)cancel - discard changes and exit from subcommand modedelete - remove a protocol from the group (*)exit - exit from subcommand modehelp - display helpname - 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.0root@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.0root@NAM(sub-application-group)# name appGrpSampleroot@NAM(sub-application-group)# exitSucessfully create application group appGrpSample.root@NAM#root@NAM#root@NAM# show application group appGrpSampleApplication Group: appGrpSampleNumber of Protocols: 2- w-ether2.ip.tcp.tcp-83616.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-108416.1.0.0.1.0.0.8.0.0.0.0.17.0.0.4.60.4.0.1.0.0root@NAM#Related Commands
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
Usage Guidelines
This command is supported on all NAM platforms.
Examples
This example shows how to enable an audit trail for GUI and CLI accesses:
root@hostname.cisco.com# audit-trail enableRelated Commands
autocreate data-source
To enable autocreation of the data-source, use the autocreate data-source command. To disable autocreation of data-sources on NAM, use the no form of this command.
autocreate data-source
no autocreate data-source
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 on all NAM platforms..
Examples
This example shows how to enable autocreation of data-sources:
root@nam235Cat6k.cisco.com# autocreate-data-source ?erspan - enable autocreation of ERSPAN data sourcesnetflow - enable autocreation of NDE data sourceswaas - enable autocreation of WAAS data sourceswaas-client - enable autocreation of WAAS Client data sourceswaas-client-wan - enable autocreation of WAAS Client WAN data sourceswaas-passthru - enable autocreation of WAAS Passthru data sourceswaas-passthru-export - enable Passthru export on autocreated WAAS deviceswaas-server - enable autocreation of WAAS Server data sourceswaas-server-wan - enable autocreation of WAAS Server WAN data sourcesroot@nam235Cat6k.cisco.com# autocreate-data-sourcecdp enable
To enable the Cisco Discovery Protocol (CDP) on the NME-NAM, use the cdp enable command. To disable CDP on the NME-NAM, use the no form of this command.
cdp enable
no cdp enable
Note
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 NME-NAM-80S and NME-NAM-120S.
Examples
This example shows how to enable CDP:
root@localhost.cisco.com# cdp enableroot@localhost.cisco.com#Related Commands
cdp hold-time
cdp interval
show cdp settingscdp 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
Note
Syntax Description
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 30root@localhost.cisco.com#Related Commands
autocreate data-source
cdp interval
show cdp settingscdp interval
To set the Cisco Discovery Protocol (CDP) messages interval on the NME-NAM, use the cdp interval command. To return the CDP messages interval on the NME-NAM to the default value, use the no form of this command.
cdp interval time
no cdp interval
Note
Syntax Description
Defaults
60 seconds
Command Modes
Command mode
Examples
This example shows how to set the CDP messages interval:
root@localhost.cisco.com# cdp interval 200root@localhost.cisco.com#Related Commands
autocreate data-source
cdp hold-time
show cdp settingsclear 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
Usage Guidelines
This command is supported on all NAM platforms.
Examples
This example shows how to clear the access log:
root@localhost# clear access-logRelated Commands
clear captured-data-files
To delete all captured files from the NAM local hard drive, use the clear captured-data-files command.
clear captured-data-files
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
Examples
This example shows how to delete all captured files:
root@localhost# clear captured-data-filesclear monitoring-data
To delete both short term and long term monitoring data, use the clear monitoring-data command. This command will also reset NAM to clean up cached data.
clear monitoring-data
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
Examples
This example shows how to clear the access log:
root@localhost# clear monitoring-dataclear 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
Usage Guidelines
This command is supported on all NAM platforms.
Examples
This example shows how to clear the system alerts:
root@localhost# clear system-alertsRelated Commands
clock set
To set the date and time of a Cisco NAM 2200 series appliance, use the clock set command.
clock set <hh:mm:ss:> <mm/dd/yyyy>
Note
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported only on the Cisco NAM 2200 Series appliances.
Examples
The following example shows how to set the clock on the NAM appliance.
root@nam.cisco.com# clock set 06:10:00 08/04/2008config clear
To reset the NAM and return it to the factory-default state, use the config clear command.
config clear [all | ip]
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
Examples
This example shows how to clear the configuration:
root@localhost# config clearThis operation will reset the NAM configuration with the exceptionof NAM IP parameters.This operation will also reboot the NAM to allow the changes totake effect.Do you wish to continue? (y/n) [n]:ySuccessfully 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 or to restore a NAM Virtual Blade license, use the config network command.
config network url [config_filename] [license_filename]
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms. The license_file option is valid only on the Cisco NAM Virtual Blade.
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.configDownloading 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/s9748 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 [config_filename] [license_filename]
Syntax Description
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms. The license_file option is valid only on the Cisco NAM Virtual Blade.
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.configBuilding 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
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
Examples
This example shows how to retrieve a core dump:
root@localhost# coredump ftp://user:passwd@host/full-path/data-source erspan
To create ERSPAN (Encapsulated Remote SPAN) data-source, use the data-source erspan command.
data-source erspan
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
When you enter the data-source erspan submode, the following commands are available:
•
•
•
•
•
•
•
Examples
This example shows how to create an ERSPAN data-source:
root@nam235Cat6k.cisco.com# data-source erspanEntering into subcommand mode for this command.Type 'exit' to apply changes and come out of this mode.Type 'cancel' to discard changes and come out of this mode.root@nam235Cat6k.cisco.com(sub-data-source-erspan)# ?? - display helpcancel - discard changes and exit from subcommand modedevice-id - ERSPAN device ID (*)exit - create data-source and exit from sub-command modehelp - display helpname - data-source name (*)session-id - ERSPAN session IDshow - show current config that will be applied on exit(*) - denotes a mandatory field for this configuration.data-source netflow
To create NetFlow Data Export (NDE) data-source, use the data-source netflow command.
data-source netflow
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
When you enter the data-source netFlow submode, the following commands are available:
•
•
•
•
•
•
•
Examples
This example shows how to create a netFlow data-source:
root@nam235Cat6k.cisco.com# data-source netflowEntering into subcommand mode for this command.Type 'exit' to apply changes and come out of this mode.Type 'cancel' to discard changes and come out of this mode.root@nam235Cat6k.cisco.com(sub-data-source-netflow)# ?? - display helpcancel - discard changes and exit from subcommand modedevice-id - netflow device ID (*)engine-id - netflow Engine IDexit - create data-source and exit from sub-command modehelp - display helpname - data-source name (*)show - show current config that will be applied on exit(*) - denotes a mandatory field for this configuration.data-source waas
To create Wide Area Application Services (WAAS) data-source, use the data-source waas command.
data-source waas
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
When you enter the data-source waas submode, the following commands are available:
•
•
•
•
•
•
•
Examples
This example shows how to create a WAAS data-source:
root@nam235Cat6k.cisco.com# data-source waasEntering into subcommand mode for this command.Type 'exit' to apply changes and come out of this mode.Type 'cancel' to discard changes and come out of this mode.root@nam235Cat6k.cisco.com(sub-data-source-waas)# ?? - display helpcancel - discard changes and exit from subcommand modedevice-id - WAAS device ID (*)exit - create data-source and exit from sub-command modehelp - display helpname - data-source name (*)segment - network segment to be added to data-source (*)show - show current config that will be applied on exit(*) - denotes a mandatory field for this configuration.debug log disable
To disable debug logging, use the debug log disable command.
debug log disable
Syntax Description
This command has no arguments or keywords.
Defaults
This command has no default behavior or settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
Examples
The following example disables all debug logging:
root@nam.cisco.com# debug log disabledebug log enable
To enable debug logging, use the debug log enable command.
debug log enable
Syntax Description
This command has no arguments or keywords.
Defaults
This command has no default behavior or settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
Examples
The following example enables all debug logging:
root@nam.cisco.com# debug log enabledebug log level
To set the debug log level for each module running in NAM system, use the debug log-level command.
show debug log level <log-feature> <log-level>
Syntax Description
Defaults
This command has no default behavior or settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
Examples
The following example shows how to set the automated response time (ART) feature to display all log messages up to log level 2. This command will log all messages generated by the ART module that have log levels set to critical, error, and warning.
root@nam.cisco.com# debug log level ART 2debug log metric-engine
To set debug log metric-engine, use the debug log metric-engine command.
debug log metric-engine
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
Examples
The following example sets the debug log level metric-engine:
root@nam.cisco.com# debug log metric-engine
debug log reset
To reset debug logging level back to default settings, use the debug log reset command.
debug log reset
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
Examples
The following example resets all debug log levels back to default values:
root@nam.cisco.com# debug log resetdevice erspan
To create an ERSPAN (Encapsulated Remote SPAN) device, use the device erspan command.
device erspan
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
When you enter the device erspan submode, the following commands are available:
•
•
•
•
•
Examples
This example shows how to create an ERSPAN device:
root@nam235Cat6k.cisco.com# device erspanEntering into subcommand mode for this command.Type 'exit' to apply changes and come out of this mode.Type 'cancel' to discard changes and come out of this mode.root@nam235Cat6k.cisco.com(sub-device-erspan)# ?? - display helpaddress - device IP address (*)cancel - discard changes and exit from subcommand modeexit - create device and exit from sub-command modehelp - display helpshow - show current config that will be applied on exit(*) - denotes a mandatory field for this configuration.device netflow
To create a NetFlow Data Export (NDE) device, use the device netflow command.
device netflow
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
When you enter the device netFlow submode, the following commands are available:
•
•
•
•
•
•
•
•
•
•
•
•
•
Examples
This example shows how to create a netFlow device:
root@nam235Cat6k.cisco.com# device netflowEntering into subcommand mode for this command.Type 'exit' to apply changes and come out of this mode.Type 'cancel' to discard changes and come out of this mode.root@nam235Cat6k.cisco.com(sub-device-netflow)# ?? - display helpaddress - device IP address (*)cancel - discard changes and exit from subcommand modecommunity - SNMPv2c community stringexit - create device and exit from sub-command modehelp - display helpshow - show current config that will be applied on exitsnmp-version - SNMP version to use to communicate with devicev3-auth-passphrase - SNMPv3 authentication passphrasev3-auth-protocol - SNMPv3 authentication protocolv3-priv-passphrase - SNMPv3 privacy passphrasev3-priv-protocol - SNMPv3 privacy protocolv3-sec-level - SNMPv3 security levelv3-username - SNMPv3 username(*) - denotes a mandatory field for this configuration.device waas
To create Wide Area Application Services (WAAS) device, use the device waas command.
device waas
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported on all NAM platforms.
When you enter the device WAAS submode, the following commands are available:
•
•
•
•
•
•
Examples
This example shows how to create a WAAS device:
root@nam235Cat6k.cisco.com# device waasEntering into subcommand mode for this command.Type 'exit' to apply changes and come out of this mode.Type 'cancel' to discard changes and come out of this mode.root@nam235Cat6k.cisco.com(sub-device-waas)# ?? - display helpaddress - device IP address (*)cancel - discard changes and exit from subcommand modeexit - create device and exit from sub-command modehelp - display helppassthru - enable/disable passthru traffic from WAAS deviceshow - show current config that will be applied on exit(*) - denotes a mandatory field for this configuration.
