Table Of Contents
NAM CLI Commands:
email - managed device community
email
entity alias
entity assetid
exit
exsession
help
ip address
ip broadcast
ip domain
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 port
ip http secure server
ip http server
ip http tacacs+
ip interface
ip nameserver
license install
logout
managed-device address
managed-device community
NAM CLI Commands:
email - managed device community
This chapter provides information about the following commands:
•
email
•
entity alias
•
entity assetid
•
exit
•
exsession
•
help
•
ip address
•
ip broadcast
•
ip domain
•
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 port
•
ip http secure server
•
ip http server
•
ip http tacacs+
•
ip interface
•
ip nameserver
•
license install
•
logout
•
managed-device address
•
managed-device community
email
To set up an e-mail server that sends both alarm and report data through e-mail, enable or disable alarm messages sent through e-mail, and to enter the subcommand mode, use the email command. To remove the e-mail server, use the no email server command. To stop sending out both scheduled report data and alarm messages through e-mail, 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
This command is supported on all NAM platforms.
Note
Recipients are the alarm message recipients. Report data recipients are not supported on CLI.
When you enter the e-mail 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 e-mail server name.
•
alarm enable— Enables sending alarm messages through e-mail.
•
alarm disable—Disables sending alarm messages through e-mail.
•
alarm recipients space-seperated-list-of-email-addresses— List of email addresses like admin@domain.com, user@domain.com.
Examples
This example shows how to set up the NAM to send scheduled reports through e-mail to abc@example.com and xyz@example.com:
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 debug metric-engine
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
This command is supported on all NAM platforms.
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
This command is supported on all NAM platforms.
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
This command is supported on all NAM platforms.
To leave a subcommand mode, use the exit command. The exit command saves any changes before leaving the submode.
To exit from the NAM and go back to the Branch Router console, enter $ and then quit. There is no command to exit from NAM and go back to the WAE/WAVE console. You need to issue virtual-blade 1 session clear (1 denotes slot 1) on another WAE/WAVE connection to terminate the session.
Examples
This example shows how to log out of the NAM:
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
This command is supported on all NAM platforms.
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
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
Usage Guidelines
This command is supported on all NAM platforms.
Examples
This example shows how to display help:
application - configure an application [group]
audit-trail - enable logging Web GUI and CLI accesses
autocreate-data-source - enable data source autocreation feature
clear - clear access log / system alerts
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
This command is supported on all NAM platforms.
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
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 secure server: Disabled
Related Commands
ip broadcast
ip domain
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
Usage Guidelines
This command is supported on all NAM platforms.
Examples
This example shows how to set the system broadcast address:
root@localhost# ip broadcast 172.20.104.127
Related Commands
ip address
ip domain
ip host
ip interface
show ip
ip domain
To set the system domain name, use the ip domain command.
ip domain name
Syntax Description
name
|
Sets the system domain name.
|
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 set the IP domain name:
root@nam# ip domain cisco.com
Related Commands
ip address
ip domain
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
Usage Guidelines
This command is supported on all NAM platforms.
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 hostname, use the ip host command.
ip host name
Syntax Description
name
|
Sets the IP hostname.
|
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 set the IP hostname:
root@NAM.cisco.com# ip host orion
Related Commands
ip address
ip domain
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 hostname which can be a 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
This command is supported on all NAM platforms.
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
This command is supported on all NAM platforms.
Examples
This example shows how to delete a specific IP host:
root@localhost# ip hosts delete 30.50.68.10 orion
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.
|
Not all ports are available to be assigned. Most browsers block ports that are used for other applications. Table 3-1 lists the commonly blocked ports.
Table 3-1 Commonly-Blocked Ports
Port
|
Application
|
|
Port
|
Application
|
|
Port
|
Application
|
|
Port
|
Application
|
1
|
tcpmux
|
|
43
|
nicname
|
|
117
|
uucp-path
|
|
531
|
chat
|
7
|
echo
|
53
|
domain
|
119
|
NNTP
|
532
|
netnews
|
9
|
discard
|
77
|
priv-rjs
|
123
|
NTP
|
540
|
uucp
|
11
|
systat
|
79
|
finger
|
135
|
loc-srv / epmap
|
556
|
remotefs
|
13
|
daytime
|
87
|
ttylink
|
139
|
netbios
|
563
|
NNTP+SSL
|
15
|
netstat
|
95
|
supdup
|
143
|
IMAP2
|
587
|
submission
|
17
|
qotd
|
101
|
hostriame
|
179
|
LDAP
|
601
|
syslog
|
19
|
chargen
|
102
|
iso-tsap
|
389
|
LDAP
|
636
|
LDAP+SSL
|
20
|
ftp data
|
103
|
gppitnp
|
465
|
SMTP+SSL
|
993
|
IMAP+SSL
|
21
|
ftp control
|
104
|
acr-nema
|
512
|
print / exec
|
995
|
POP3+SSL
|
22
|
ssh
|
109
|
POP2
|
513
|
login
|
2049
|
nfs
|
23
|
telnet
|
110
|
POP3
|
514
|
shell
|
4045
|
lockd
|
25
|
smtp
|
111
|
sunrpc
|
515
|
printer
|
6000
|
X11
|
37
|
time
|
113
|
auth
|
526
|
tempo
|
|
|
42
|
name
|
115
|
sftp
|
530
|
courier
|
|
|
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 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
Usage Guidelines
This command is supported on all NAM platforms.
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
Usage Guidelines
This command is supported on all NAM platforms.
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 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.
|
Not all ports are available to be assigned. Most browsers block ports that are used for other applications. Table 3-1 lists the commonly blocked ports.
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 set up a secure server port:
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 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
This command is supported on all NAM platforms.
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 server
To enable a 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
Usage Guidelines
This command is supported on all NAM platforms.
Examples
This example shows how to enable a 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
This command is supported on all NAM platforms.
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
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 secure server: Disabled
TACACS+ primary server: 10.0.0.1
TACACS+ backup server : 10.0.0.2
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 secure server: Disabled
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 NME-NAM, use the ip interface command.
ip interface external | internal
Note
This command is not valid for NAM-1 or NAM-2 devices, the Cisco NAM 2200 Series appliances, or the Cisco NAM Virtual Blades.
Syntax Description
external
|
Selects the RJ-45 Fast Ethernet connector on the NME-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 NME-NAM.
|
Defaults
This command has no default settings.
Command Modes
Command mode
Usage Guidelines
This command is supported only on the NME-NAM.
Examples
This example shows how to specify an interface port for the NME-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
Usage Guidelines
This command is supported on all NAM platforms.
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
license install
To install a license file on a WAE device that has installed NAM Virtual Blade software, use the license install command.
license install url
Syntax Description
url
|
Specifies the location of the license file to install; ftp://<username>@<host>/<path>/<license_filename>
|
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 valid only on NAM WAAS Virtual Blade platform.
Examples
This example shows how to install the license file on the WAE device that has NAM installed on it:
root@localhost# license install ftp://joseph@host_name/usr/
logout
To log out of the system, use the logout command.
logout
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.
To exit from the NAM and go back to the Branch Router console, enter $ and then quit. There is no command to exit from NAM and go back to the WAE/WAVE console. You need to issue virtual-blade 1 session clear (1 denotes slot 1) on another WAE/WAVE connection to terminate the session.
Examples
This example shows how to log out of the NAM:
managed-device address
To configure the managed device address, use the managed-device address command.
managed-device address <ip-address>
Note
This command is not supported on NAM-1, NAM-2, NME-NAM-80S, NME-NAM-120S and the NAM Virtual Blade devices.
Syntax Description
ip-address
|
Specifies the IP address of the managed device.
|
Defaults
No default behavior or values.
Command Modes
Command mode
Usage Guidelines
This command is supported only on Cisco NAM 2200 Series appliances.
Examples
The following example sets the managed device IP address, and then shows the managed device:
root@nam.cisco.com# managed-device address 10.0.0.1
root@nam.cisco.com# show managed-device
root@nam.cisco.com# 10.0.0.1
managed-device community
To configure the managed device SNMP community, use the managed-device community command.
managed-device community <rw-community>
Note
This command is not supported on NAM-1, NAM-2, NME-NAM-80S, NME-NAM-120S and the NAM Virtual Blade devices.
Syntax Description
rw-community
|
Specifies the SNMP community for read/write operations.
|
Defaults
None.
Command Modes
Command mode
Usage Guidelines
This command is supported only on Cisco NAM 2200 Series appliances.
Examples
The following example sets the managed-device community:
root@nam.cisco.com# managed-device community