Command Reference Guide for Cisco Evolved Programmable Network Manager 8.1

User Accounts and Modes in Cisco EPN Manager CLI

The types of accounts available on the Cisco EPN Manager CLI are:

Admin (administrator)
Network Admin
Security Admin
User

When you power on the Cisco EPN Manager appliance for the first time, you are prompted to run the setup utility to configure the appliances. During this setup process, an administrator user account, also known as an Admin account, is created. After you enter the initial configuration information, the appliance automatically reboots and prompts you to enter the username and the password that you specified for the Admin account. You must use this Admin account to log in to the Cisco EPN Manager CLI for the first time.

An Admin can create and manage user accounts (which have limited privileges and access to the Cisco EPN Manager server). An Admin account also provides the functionality that is needed to use the Cisco EPN Manager CLI.

To create more users (with admin, security-admin, network-admin, and user privileges) with SSH access to the Cisco EPN Manager CLI, you must enter the username command in configuration mode (see Command Modes in the Cisco EPNM CLI).

Note

A user with an admin role can be assigned for user admin role alone and not with any other user role type mentioned above, once the installation is completed.

Logging in to the Cisco EPN Manager server places you in user mode or admin (EXEC) mode, which always requires a username and password for authentication.

You can tell which mode you are in by looking at the prompt. A right angle bracket (>) appears at the end of user mode prompt; a pound sign (#) appears at the end of admin mode prompt, regardless of the submode.

Command Modes in the Cisco EPN Manager CLI

This section describes the command modes supported in the Cisco EPN Manager.

EXEC Commands

EXEC commands primarily include system-level commands such as show and reload (for example, application installation, application start and stop, copy files and installations, restore backups, and display information).

Table 1-2 describes the EXEC commands
Table 1-3 describes the show commands in EXEC mode

For detailed information on EXEC commands, see Understanding Command Modes.

EXEC or System-Level Commands

Table 1-2 describes EXEC mode commands.

Table 1. Summary of EXEC Commands
	Description
application install	Installs a specific application bundle.
application remove	Uninstalls a specific application bundle.
application reset-config	Resets the application configuration to factory defaults.
application start	Starts or enables a specific application.
application stop	Stops or disables a specific application.
application upgrade	Upgrades a specific application bundle.
backup	Performs a backup and places the backup in a repository.
backup-logs	Performs a backup of all the logs on the Cisco EPN Manager to a remote location.
backupui	Performs a backup of the system
banner	Sets messages while logging in to CLI (pre-login).
change-password	Changes the current CLI user password. The running-configuration command is also modified, and the write memory operation is required to save the changes to the startup-configuration.
clock	Sets the system clock on the Cisco EPN Manager server.
configure	Enters configuration mode.
copy	Copies any file from a source to a destination.
debug	Displays any errors or events for various command situations; for example, backup and restore, configuration, copy, resource locking, file transfer, and user management.
delete	Deletes a file in the Cisco EPN Manager server.
dir	Lists the files in the Cisco EPN Manager server.
exit	Disconnects the encrypted session with a remote system. Exits from the current command mode to the previous command mode.
forceout	Forces the logout of all the sessions of a specific Cisco EPN Manager server system user.
halt	Disables or shuts down the Cisco EPN Manager server.
mkdir	Creates a new directory.
ncs	NCS related commands such as start, stop, ha, and so on.
nslookup	Queries the IPv4 address or hostname of a remote system.
patch	Installs System or Application patch.
ping	Determines the IPv4 network connectivity to a remote system.
ping6	Determines the IPv6 network connectivity to a remote system.
reload	Reboots the Cisco EPN Manager server.
restore	Restores a previous backup.
rmdir	Removes an existing directory.
rsakey	Displays a configured RSA key or sets a new RSA public key for user authentication.
sam	SAM top level command.
shell	Executes the root shell.
shell disable	Disables the shell user from restoring admin shell access.
show	Provides information about the Cisco EPN Manager server.
ssh	Starts an encrypted session with a remote system.
ssh delete	Deletes the ssh fingerprint for a specific host.
tech	Provides Cisco Technical Assistance Center (TAC) commands.
telnet	Establishes a Telnet connection to a remote system.
terminal length	Sets terminal line parameters.
terminal session-timeout	Sets the inactivity timeout for all terminal sessions.
terminal session-welcome	Sets the welcome message on the system for all terminal sessions.
terminal terminal-type	Specifies the type of terminal connected to the current line of the current session.
traceroute	Traces the route of a remote IP address.
undebug	Disables the output (display of errors or events) of the debug command for various command situations; for example, backup and restore, configuration, copy, resource locking, file transfer, and user management.
write erase	Erases the startup configuration that forces to run the setup utility and prompt the network configuration, copies the running configuration to the startup configuration, and displays the running configuration on the console.
write memory	Writes running configuration for a startup configuration.
write terminal	Writes running configuration to a console.

show Commands

The show commands are used to display the Cisco EPNM settings and are among the most useful commands. See the table show Commands for a summary of the show commands. The show commands must be followed by a keyword; for example, show application status . Some show commands require an argument or variable after the keyword to function; for example, show application version .

Table 2. Summary of show Commands
	Description
application  (requires keyword)	Displays information about the installed application; for example, status information or version information.
backup (requires keyword)	Displays information about the backup.
banner (requires keyword)	Sets up messages when logging in to CLI.
cdp (requires keyword)	Displays information about the enabled Cisco Discovery Protocol interfaces.
clock	Displays the day, date, time, time zone, and year of the system clock.
cpu	Displays CPU information.
disks	Displays file-system information of the disks.
icmp-status	Displays the Internet Control Message Protocol (ICMP) echo response configuration information.
interface	Displays statistics for all the interfaces that are configured on the Cisco EPNM.
inventory	Displays information about the hardware inventory, including the Cisco EPNM appliance model and serial number.
ip route	Displays the IP route details of the application.
logging	Displays the Cisco EPNM server logging information.
logins (cli - only keyword)	Displays the login history of the Cisco EPNM server.
memory	Displays memory usage by all running processes.
netstat	Displays the netstat and firewall information.
ntp	Displays the status of the Network Time Protocol (NTP) servers.
ports	Displays all the processes listening on the active ports.
process	Displays information about the active processes of the Cisco EPNM server.
repository (requires keyword)	Displays the file contents of a specific repository.
restore (requires keyword)	Displays the restore history in the Cisco EPNM.
running-config	Displays the contents of the configuration file that currently runs in the Cisco EPNM.
security-status	Displays whether the services/ports are enabled or disabled
startup-config	Displays the contents of the startup configuration in the Cisco EPNM.
tech-support file (requires keyword)	Displays system and configuration information that you can provide to the TAC when you report a problem.
terminal	Displays information about the terminal configuration parameter settings for the current terminal line.
timezone	Displays the current time zone in the Cisco EPNM.
timezones	Displays all the time zones available for use in the Cisco EPNM.
udi	Displays information about the unique device identifier (UDI) of the Cisco EPNM.
uptime	Displays how long the system you are logged in to has been up and running.
users	Displays information about the system users.
version	Displays information about the currently loaded software version, along with hardware and device information.

Configuration Commands

Configuration commands include interface and repository . To access configuration mode, run the configure command in EXEC mode.

Some of the configuration commands require that you enter the configuration submode to complete the configuration.

Table 1-4 describes the configuration commands.

Table 3. Summary of Configuration Commands

Description

aaa authentication

Logs in to EPNM server remotely.

backup-staging-url

Specifies a Network File System (NFS) temporary space or staging area for the remote directory for backup and restore operations.

cdp holdtime

Specifies the amount of time the receiving device should hold a Cisco Discovery Protocol packet from the server before discarding it.

cdp run

Enables Cisco Discovery Protocol.

cdp timer

Specifies how often the EPNM server sends Cisco Discovery Protocol updates.

clock timezone

Sets the time zone for display purposes.

Executes an EXEC-level command from configuration mode or any configuration submode.

Note

To initiate, the do command precedes the EXEC command.

end

Returns to EXEC mode.

exit

Exits configuration mode.

hostname

Sets the hostname of the system.

icmp

Configures the ICMP echo requests.

interface

Configures an interface type and enters interface configuration mode.

ip access-list

Configures Access Control Lists (ACL).

ip default-gateway

Defines or sets a default gateway with an IP address.

ip domain-name

Defines a default domain name that a EPNM server uses to complete hostnames.

ip name-server

Sets the Domain Name System (DNS) servers for use during a DNS query.

ip route

Configures the IP routes.

kron occurrence

Schedule one or more Command Scheduler commands to run at a specific date and time or a recurring level.

kron policy-list

Specifies a name for a Command Scheduler policy.

logging

Enables the system to forward logs to a remote system.

logging loglevel

Configures the log level for the logging command.

logging security

Security configuration for the logging command.

logging sync-logs

Configures and enables continuous logs to sync into a repository.

Disables or removes the function associated with the command.

ntp

Synchronizes the software clock through the NTP server for the system.

password-policy

Enables and configures the password policy.

repository

Enters repository submode.

service

Specifies the type of service to manage.

snmp-server community

Sets up the community access string to permit access to the Simple Network Management Protocol (SNMP).

snmp-server contact

Configures the SNMP contact the Management Information Base (MIB) value on the system.

snmp-server host

Sends SNMP traps to a remote system.

snmp-server location

Configures the SNMP location MIB value on the system.

username

Adds a user to the system with a password and a privilege level.

For detailed information on configuration mode and submode commands, see Understanding Command Modes.

Bias-Free Language

Book Title

Command Reference Guide for Cisco Evolved Programmable Network Manager 8.1

Chapter Title

Overview of the Cisco EPN Manager Command-Line Interface

Results

Chapter: Overview of the Cisco EPN Manager Command-Line Interface