Using the Command-Line Interface : Understanding the CLI Structure

Understanding the CLI Structure
This section describes the following topics:
n
n
n
n
n
n
n
CLI Modes
This section describes the following three command modes that the CLI uses for the Silver Peak NX Series appliances:
n
n
n
Being in a particular command mode determines which commands you may execute. To display a list of the command that are available to you, enter that command mode and type ?.
User EXEC Mode
When you first log in to a Silver Peak appliance, you are in the User EXEC mode. The User EXEC mode provides access to commands for non-configuration tasks, such as checking the appliance status. When you are in this mode, the following prompt displays:
<appliance> >
where appliance is the name of the appliance on which you logged in.
In the User EXEC mode, you have access to the following commands:
Privileged EXEC Mode
The Privileged EXEC mode provides access to all the commands you could execute in User EXEC mode, as well as several additional commands. Also, from this mode, you can enter Global Configuration mode. Most of the commands that the Privileged EXEC mode makes available are one-time commands, such as show commands, which show the current configuration status, and clear commands, which clear counters or interfaces.
To enter the Privileged EXEC mode, type enable to log in as privileged user, which displays the following prompt:
<appliance> #
where appliance is the name of the appliance on which you logged in.
In the Privileged EXEC mode, you access to the following commands:
Global Configuration Mode
The Global Configuration mode allows you to make changes to the running configuration. If you later save the configuration, these commands are stored across appliance reboots. To enter the Global Configuration mode, you must first enter the Privileged EXEC mode and then type configure terminal at the prompt. When you press Enter, the following prompt displays:
<appliance> (config) #
where appliance is the name of the appliance on which you logged in.
The Global Configuration mode provides access to all CLI commands, including those available to the User EXEC and Privileged EXEC modes.
You must have an Administrator user privilege level to access the Global Configuration mode.
To leave Global Configuration mode, you can use the command:
<appliance> (config) # no configure
User Privilege Levels
The CLI has two user privilege levels, which determine the CLI modes you may enter and the commands you can execute. You can log in to one of the following user privilege levels:
n
n
To execute a CLI command at the prompt, you must be logged in at the required user privilege level for that command. For example, most configuration commands require you to have the Administrator privilege level.
Monitor
The Monitor user privilege level is the default privilege level for the CLI. This privilege level provides access to the both the User EXEC and Privileged EXEC modes. The Monitor user privilege level does not have access to most configuration commands.
Note You cannot delete user IDs in the CLI; you can only change the password for a user.
Administrator
The Administrator user privilege level has full access to all modes and commands in the CLI.
User Names
When you create a user name, ensure that the first character of the name is alphebetical (a-z or A‑Z). The remaining characters must include one of the following:
n
n
n
n
n
No spaces are allowed.
Passwords
You can establish passwords for a user to enter the Privilege EXEC or Global Configuration modes. The CLI provides no restrictions on the password you create for a user. You may enter a clear-text password or use a utility to create an encrypted password for a user. There are also no restrictions on the use of, or requirement for, special characters in the password.
Object Names
When you create a name for an object, such as a tunnel, access control list, or a route map, you can use one of the following characters:
n
n
n
n
n
Understanding the Command Structure
The following information is provided for each command:
Note The Silver Peak command line interface (CLI) supports only the US character set.
Understanding the Command Syntax
The following symbols are used in the CLI documentation to describe the command syntax. When you execute commands in the CLI, do not type these characters:
Enclose a variable or a value that you must specify in the command. For example, in the syntax: configure vlan <vlan name> ip address <ip_address>, you must supply a VLAN name for the variable <vlan name> and an IP address for the variable <ip_address> when you enter the command.
Separate mutually exclusive items in a list, one of which must be entered. For example, in the syntax file upload <filename> | cancel you must specify either the file name variable or the word, cancel, when you enter the command.
Enclose a required value or list of required arguments. One or more values or arguments can be specified in square brackets. For example, in the syntax configure snmp community {read-only | read-write} <string>, you must include either the read-only or read-write argument in the command.
Enclose an optional value or a list of optional arguments. You can specify in curly brackets one or more values or arguments that are not required to execute the command. For example, in the syntax reboot [<date> <time> | cancel] you can choose to use the reboot command without any arguments. Alternately, you can specify either a particular date and time combination or the keyword cancel to cancel a previously scheduled reboot.
Syntax Helper
The CLI has a built-in Syntax Helper. If you are not sure of the complete syntax for a particular command, enter the first three letters of the command and press the Tab key. The Syntax Helper provides a list of options for the remainder of the command, and places the cursor at the end of the command you have entered so far, ready for the next option.
The Syntax Helper also provides assistance by informing you if you have entered an incorrect command.
Command History
The Silver Peak operating system keeps the last commands you entered in its memory. You can “walk” through these commands one at a time by using the Up and Down arrows on your keyboard.

Please send comments or suggestions regarding user documentation to techpubs@silver-peak.com.