Table of Contents

1 CLI Configuration· 1-1

What Is CLI?· 1-1

Entering the CLI 1-2

Entering CLI Through the Console Port 1-2

Entering the CLI Through Telnet 1-6

CLI Description· 1-7

Command Conventions· 1-7

CLI View Description· 1-8

Using the CLI 1-9

Using the CLI Online Help· 1-9

Command Line Error Information· 1-10

Typing and Editing Commands· 1-11

Displaying and Executing History Commands· 1-11

Undo Form of a Command· 1-12

Controlling CLI Display· 1-12

Configuring the CLI 1-15

Configuring CLI Hotkeys· 1-15

Configuring Command Aliases· 1-16

Synchronous Information Output 1-17

Configuring Command Levels· 1-18

Saving Configurations· 1-19

 

 

This chapter includes these sections:

l          What Is CLI?

l          Entering the CLI

l          CLI Description

l          Using the CLI

l          Configuring the CLI

What Is CLI?

The command line interface (CLI) enables you to interact with your access point (AP) by typing text commands. At the CLI, you can instruct your AP to perform a given task by typing a text command and then pressing Enter to submit it to your AP. Compared with the graphical user interface (GUI) where you can use a mouse to perform configurations, the CLI allows you to input more information in one command line. The CLI of APs is as shown in Figure 1-1.

Figure 1-1 CLI

 

Entering the CLI

The WA series WLAN access points provide multiple methods of entering the CLI, as follows:

l          Through the console port. For more information, see Entering CLI Through the Console Port.

l          Through Telnet. For more information, see Entering the CLI Through Telnet.

l          Through SSH with encryption. For more information, see SSH2.0 in the Security Configuration Guide.

Entering CLI Through the Console Port

When you use the CLI of an AP for the first time, you can log in to the AP and enter the CLI through the console port only. Follow these steps to log in to your AP and enter the CLI through the console port:

1)        Use a console cable to connect your PC to your AP. Plug the DB-9 (female) connector of the console cable into the 9-pin serial port of your PC. Then plug the RJ-45 connector of the console cable into the console port of your AP.

Figure 1-2 Use a console cable to connect your PC to your AP

 

 

 

2)        Launch a terminal emulation utility on your PC. In this chapter, the HyperTerminal in Windows XP is used as an example. Click Start > All Programs > Accessories > Communications > HyperTerminal to enter the HyperTerminal window. The Connection Description window as shown in Figure 1-3 appears. Type a connection name (test, for example) in the Name input box, and click OK.

Figure 1-3 Connection description

 

3)        Then, the Connect To window as shown in Figure 1-4 appears. Select the serial port you want to use from the Connect using drop-down list, and then click OK.

Figure 1-4 Specify the serial port used to establish the connection

 

4)        The COM1 Properties window as shown in Figure 1-5 appears. On the window, set Bits per second to 9600, Data bits to 8, Parity to None, Stop bits to 1, and Flow control to None. Click OK.

Figure 1-5 Set the properties of the serial port

 

5)        The HyperTerminal window as shown in Figure 1-6 appears.

Figure 1-6 The HyperTerminal window

 

Select File > Properties on the HyperTerminal window, and the test Properties window appears. Select the Settings tab as shown in Figure 1-7, select VT100 from the Emulation drop-down list, and then click OK.

Figure 1-7 Select the emulation terminal on the test Properties window

 

6)        Press Enter on the HyperTerminal window. Then the CLI of your access point appears on the window, as shown in Figure 1-8, indicating that you have logged in to your access point successfully.

Figure 1-8 Schematic diagram for successful login through the console port

 

Entering the CLI Through Telnet

After you log in to your access point through the console port for the first time, it is recommended that you configure Telnet login as soon as possible, so that you can use a remote terminal to configure and manage your access point.

Telnet login authentication methods

To restrict the login to your access point, three Telnet login authentication methods are provided. Select a proper method according to your network conditions.

Table 1-1 Telnet login authentication methods

Authentication method	Description	Application scenarios	Configuration
None	l      Easy to configure l      Allows any user to telnet to your access point l      Least secure	Lab environments and extremely secure network environments	For more information, see Login in the Fundamentals Configuration Guide.
Password	l      Easy to configure l      Allows any user knowing the password to telnet to your access point l      Secure, but incapable of assigning different privilege levels to different users	Environments that do not need granular privilege management
Username and password	l      Complex to configure l      Allows users inputting the correct username and password to telnet to your access point l      Most secure, and capable of assigning different privilege levels to different users	Environments where multiple operators cooperate to manage the AP

 

An access point provides multiple VTY user interfaces. At one time, only one user can telnet to a VTY user interface. Because a remote terminal cannot select the VTY user interface through which it logs in to the access point, it is recommended that you configure all VTY user interfaces with the same authentication method. The following example is configured in this way.

Telnet login configuration example

# Enter system view.

<Sysname> system-view

# Enable the telnet service.

[Sysname] telnet server enable

# Create VLAN-interface 1.

[Sysname] interface vlan-interface 1

# Assign an IP address to VLAN-interface 1, 192.168.0.72 for example.

[Sysname-Vlan-interface1] ip address 192.168.0.72 24

[Sysname-Vlan-interface1] quit

# Enter the view of VTY user interfaces 0 through 4.

[Sysname] user-interface vty 0 4

[Sysname-ui-vty0-4]

# Configure the authentication method for the VTY user interfaces as needed.

Omitted. For more information, see Login in the Fundamentals Configuration Guide.

# Configure command level 3 for users that log in through VTY user interfaces 0 through 4.

[Sysname-ui-vty0-4]user privilege level 3

CLI Description

Command Conventions

Commands in Command Reference comply with the following conventions.

Table 1-2 Command conventions

Convention	Description
Boldface	The keywords of a command line are in Boldface. Keep keywords unchanged when typing them in the CLI.
Italic	Command arguments are in italic. Replace arguments with actual values in the CLI.
[ ]	Items (keywords or arguments) in square brackets [ ] are optional.
{ x | y | ... }	Alternative items are grouped in braces and separated by vertical bars. One is selected.
[ x | y | ... ]	Optional alternative items are grouped in square brackets and separated by vertical bars. One or none is selected.
{ x | y | ... } *	Alternative items are grouped in braces and separated by vertical bars. A minimum of one or a maximum of all can be selected.
[ x | y | ... ] *	Optional alternative items are grouped in square brackets and separated by vertical bars. Many or none can be selected.
&<1-n>	The argument(s) before the ampersand (&) sign can be entered 1 to n times.
#	A line starting with the # sign is comments.

 

 

Take the clock datetime time date command as an example to understand the command meaning according to Table 1-2.

Figure 1-9 Read command line parameters

 

For example, you can type the following command line at the CLI of your AP and press Enter to set the switch system time to 10 o’clock 30 minutes 20 seconds, February 23, 2010.

<Sysname> clock datetime 10:30:20 2/23/2010

You can read any command that is more complicated according to Table 1-2.

CLI View Description

CLI views are designed to meet various configuration requirements.

The following describes the most commonly used view operations: entering system view, exiting the current view, and returning to user view.

Entering system view

After logging in to the AP, you are in user view and the prompt is <device name>.

In user view, only a few operations are allowed, for example, display operations, file operations, FTP and Telnet operations. To further configure the AP, you need to enter system view.

Follow these steps to enter system view:

To do…	Use the command…	Remarks
Enter system view.	system-view	Required Available in user view

 

Exiting the current view

The AP’s CLI views are multi-layered, for example, user view > system view > interface view, VLAN view, etc.

Use the following command to exit the current view after finishing configuration in the current view:

Follow these steps to exit the current view:

To do…	Use the command…	Remarks
Exit the current view to return to the previous view	quit	Required Available in any view

 

 

Returning to user view

To return to user view from any non-user view, you do not have to execute the quit command repeatedly. Instead, you can use the return command or press Ctrl+Z.

Follow these steps to return to user view directly:

To do…	Use the command…	Remarks
Return to user view directly	return	Required Available in any view except user view

 

Using the CLI

Using the CLI Online Help

At the CLI, you can type a question mark (?) to obtain detailed online help. See the following examples.

Type ? in any view to display all commands available in this view and brief descriptions about these commands.

<Sysname> ?

User view commands:

  archive           Specify archive settings

  backup            Backup next startup-configuration file to TFTP server

  boot-loader       Set boot loader

  bootrom           Update/read/backup/restore bootrom

  cd                Change current directory

  clock             Specify the system clock

......omitted......

Type part of a command and ? separated by a space.

If ? is at the position of a keyword, the CLI displays all possible keywords with a brief description about each of these keywords.

<Sysname> terminal ?

  debugging  Send debug information to terminal

  logging    Send log information to terminal

  monitor    Send information output to current terminal

  trapping   Send trap information to terminal

If ? is at the position of an argument, the CLI displays a description about this argument.

<Sysname> system-view

[Sysname] interface vlan-interface ?

  <1-4094>  VLAN interface number

[Sysname] interface vlan-interface 1 ?

  <cr>

[Sysname] interface vlan-interface 1

The string <cr> indicates that the command is already complete, and you can execute the command by pressing Enter.

Type a character string followed by a ?. The CLI displays all commands starting with this string.

<Sysname> c?

   cd

   clock

   copy

Type part of a keyword followed by ?. The CLI displays all keywords starting with the character string you typed.

<Sysname> display cl?

   clipboard

   clock

Command Line Error Information

If a command you typed contains syntax errors, the CLI reports error information. Table 1-3 lists some common command line errors.

Table 1-3 Common command line errors

Error information	Cause
% Unrecognized command found at '^' position.	The command was not found.
	The keyword was not found.
	The parameter type is wrong.
	The parameter value is beyond the allowed range.
% Incomplete command found at '^' position.	Incomplete command
% Ambiguous command found at '^' position.	Ambiguous command
% Too many parameters found at '^' position.	Too many parameters
% Wrong parameter found at '^' position.	Wrong parameters

 

Typing and Editing Commands

Fuzzy match

The access point support fuzzy match for efficient input of commands.

If in the current view, the character string you have typed can already uniquely identify a keyword, you do not need to type the complete keyword.

For example, in user view, commands starting with an s include save, startup saved-configuration, and system-view.

To save the current configuration, type sa.

To set the configuration file for next startup, type st s.

To enter system view, type sy.

You can also press Tab to have a partial keyword automatically completed, and check that the keyword is the one you intended to use.

Editing command lines

Table 1-4 lists some shortcut keys you can use to edit command lines.

Table 1-4 Editing functions

Key	Function
Common keys	If the edit buffer is not full, insert the character at the position of the cursor and move the cursor to the right.
Backspace	Deletes the character to the left of the cursor and move the cursor back one character.
Left arrow key or Ctrl+B	The cursor moves one character space to the left.
Right arrow key or Ctrl+F	The cursor moves one character space to the right.
Tab	If you press Tab after entering part of a keyword, the system automatically completes the keyword: l      If finding a unique match, the system substitutes the complete keyword for the incomplete one and displays it in the next line. l      If there is more than one match, you can press  Tab repeatedly to display in cycles all the keywords starting with the character string that you typed. l      If there is no match, the system does not modify the incomplete keyword and displays it again in the next line.

 

 

Displaying and Executing History Commands

The CLI automatically saves the commands recently used in the history command buffer. You can access commands in the history command buffer and execute them again.

Table 1-5 Access history commands

To do…	Use the key/command…	Result
Display history commands	display history-command	Displays valid history commands you used
Access the previous history command	Up arrow key or Ctrl+P	Displays the previous history command, if any
Access the next history command	Down arrow key or Ctrl+N	Displays the next history command, if any

 

 

l          The commands saved in the history command buffer are in the same format in which you typed the commands. If you typed an incomplete command, the command saved in the history command buffer is also an incomplete one.

l          If you execute the same command repeatedly, the AP saves only the earliest record. However, if you execute the same command in different formats, the system saves them as different commands. For example, if you execute the display cu command repeatedly, the system saves only one command in the history command buffer. If you execute the command in the format of display cu and display current-configuration respectively, the system saves them as two commands.

l          By default, the CLI can save up to 10 commands for each user. You can use the history-command max-size command to set the capacity of the history command buffer for the current user interface (For more information about the history-command max-size command, see Logging In to the AP in the Fundamentals Configuration Guide.

Undo Form of a Command

The undo form of a command typically restores the default, disables a function, or removes a configuration.

Almost every configuration command has its undo form.

For example, the info-center enable command is used to enable the information center, while the undo info-center enable command is used to disable the information center.

Controlling CLI Display

Controlling multi-screen display

If the output information spans multiple screens, each screen pauses after displayed. Then, you can perform one of the following operations to proceed.

Action	Function
Press Space	Displays the next screen.
Press Enter	Displays the next line.
Press Ctrl+C	Stops the display and the command execution.
Press <Ctrl+E>	Moves the cursor to the end of the current line.
Press <PageUp>	Displays the previous page.
Press <PageDown>	Displays the next page.

 

Configuring multi-screen display settings

By default, each screen displays 24 lines at most. You can use the screen-length command to change the maximum number of lines displayed on the next screen. For more information about  this command, see Logging In to the AP in the Fundamentals Configuration Guide.

You can use the following command to disable the multi-screen display function. After that, all the output information is displayed at one time and the screen is refreshed continuously until the last screen is displayed.

To do…	Use the command…	Remarks
Disable the multi-screen display function	screen-length disable	Required By default, a login user uses the settings of the screen-length command. The default settings of the screen-length command are: multiple-screen display is enabled and up to 24 lines are displayed on the next screen. This command is executed in user view, and takes effect for the current user only. When the user re-logs into the access point, the default configuration is restored.

 

Filtering output information

You can use regular expressions in display commands to filter output information.

There are two ways to filter output information.

l          Input the begin, exclude, or include keyword plus a regular expression in the display command to filter the output information.

l          When the system displays the output information in multiple screens, use /, - or + plus a regular expression to filter subsequent output information. / equals the keyword begin, - equals the keyword exclude, and + equals the keyword include.

The following describes the begin, exclude, and include keywords:

l          begin: Displays the line that matches the regular expression and all the subsequent lines.

l          exclude: Displays the lines that do not match the regular expression.

l          include: Displays the lines that match the regular expression.

A regular expression is a case sensitive string of 1 to 256 characters. It also supports the following special characters.

Character	Meaning	Remarks
^string	Starting sign. string appears only at the beginning of a line.	For example, regular expression “^user” only matches a string beginning with “user”, not “Auser”.
string$	Ending sign. string appears only at the end of a line.	For example, regular expression "user$” only matches a string ending with “user”, not “userA”.
.	Matches any single character, such as a single character, a special character, and a blank.	For example, “.l” matches both “vlan” and “mpls”.
*	Matches the preceding character or character group zero or multiple times.	For example, “zo*” matches “z” and “zoo”; “(zo)*” matches “zo” and “zozo”.
+	Matches the preceding character or character group one or multiple times	For example, “zo+” matches “zo” and “zoo”, but not “z”.
|	Matches the preceding or succeeding character string	For example, “def|int” only matches a character string containing “def” or “int”.
_	If it is at the beginning or the end of a regular expression, it equals ^ or $. In other cases, it equals comma, space, round bracket, or curly bracket.	For example, “a_b” matches “a b” or “a(b”; “_ab” only matches a line starting with “ab”; “ab_” only matches a line ending with “ab”.
-	It connects two values (the smaller one before it and the bigger one after it) to indicate a range together with [ ].	For example, “1-9” means 1 to 9 (inclusive); “a-h” means a to h (inclusive).
[ ]	Matches a single character contained within the brackets.	For example, [16A] matches a string containing any character among 1, 6, and A; [1-36A] matches a string containing any character among 1, 2, 3, 6, and A (- is a hyphen). “]” can be matched as a common character only when it is put at the beginning of characters within the brackets, for example [ ]string]. There is no such limit on “[”.
( )	A character group. It is usually used with “+” or “*”.	For example, (123A) means a character group “123A”; “408(12)+” matches 40812 or 408121212. But it does not match 408.
\index	Repeats the character string specified by the index. A character string refers to the string within () before \. index refers to the sequence number (starting from 1 from left to right) of the character group before \. If only one character group appears before \, index can only be 1; if n character groups appear before index, index can be any integer from 1 to n.	For example, (string)\1 repeats string, and thus a matching string must contain stringstring. (string1)(string2)\2 repeats string2, and thus a matching string must contain string1string2string2. (string1)(string2)\1\2 repeats string1 and string2 respectively, and thus a matching string must contain string1string2string1string2.
[^]	Matches a single character not contained within the brackets.	For example, [^16A] means to match a string containing any character except 1, 6 or A, and the matching string can also contain 1, 6 or A, but cannot contain these three characters only. For example, [^16A] matches “abc” and “m16”, but not 1, 16, or 16A.
\<string	Matches a character string starting with string.	For example, “\<do” matches word “domain” and string “doa”.
string\>	Matches a character string ending with string.	For example, “do\>” matches word “undo” and string “abcdo”.
\bcharacter2	Matches character1character2. character1 can be any character except number, letter or underline, and \b equals [^A-Za-z0-9_].	For example, “\ba” matches “-a” with “-“ being character1, and “a” being character2, but it does not match “2a” or “ba”.
\Bcharacter	Matches a string containing character, and no space is allowed before character.	For example, “\Bt” matches “t” in “install”, but not “t” in “big top”.
character1\w	Matches character1character2. character2 must be a number, letter, or underline, and \w equals [^A-Za-z0-9_].	For example, “v\w” matches “vlan”, with “v” being character1, and “l” being character2. v\w also matches “service”, with “i” being character2.
\W	Equals \b.	For example, “\Wa” matches “-a”, with “-” being character1, and “a” being character2, but does not match “2a” or “ba”.
\	Escape character. If a special character listed in this table follows \, the specific meaning of the character is removed.	For example, “\\” matches a string containing “\”, “\^” matches a string containing “^”, and “\\b” matches a string containing “\b”.

 

Configuring the CLI

Configuring CLI Hotkeys

The system provides five hotkeys that you can customize for common operations. After your configuration, you can press the hotkeys to perform corresponding operations.

Follow these steps to configure CLI hotkeys:

To do…	Use the command…	Remarks
Enter system view	system-view	—
Configure CLI hotkeys	hotkey { CTRL_G | CTRL_L | CTRL_O | CTRL_T | CTRL_U } command	Optional For details about the defaults, refer to the Note below.
Display hotkeys	display hotkey	Available in any view. Refer to Table 1-6 for hotkeys reserved by the system.

 

 

Table 1-6 Hotkeys reserved by the system

Hotkey	Function
<Ctrl+A>	Moves the cursor to the beginning of the current line.
<Ctrl+B>	Moves the cursor one character to the left.
<Ctrl+C>	Stops performing a command.
<Ctrl+D>	Deletes the character at the current cursor position.
<Ctrl+E>	Moves the cursor to the end of the current line.
<Ctrl+F>	Moves the cursor one character to the right.
<Ctrl+H>	Deletes the character to the left of the cursor.
<Ctrl+K>	Terminates an outgoing connection.
<Ctrl+N>	Displays the next command in the history command buffer.
<Ctrl+P>	Displays the previous command in the history command buffer.
<Ctrl+R>	Redisplays the current line information.
<Ctrl+V>	Pastes the content in the clipboard.
<Ctrl+W>	Deletes all the characters in a continuous string to the left of the cursor.
<Ctrl+X>	Deletes all the characters to the left of the cursor.
<Ctrl+Y>	Deletes all the characters to the right of the cursor.
<Ctrl+Z>	Returns to user view.
<Ctrl+]>	Terminates an incoming connection or a redirect connection.
<Esc+B>	Moves the cursor to the leading character of the continuous string to the left.
<Esc+D>	Deletes all the characters of the continuous string at the current cursor position and to the right of the cursor.
<Esc+F>	Moves the cursor to the front of the next continuous string to the right.
<Esc+N>	Moves the cursor down by one line (available before you press Enter)
<Esc+P>	Moves the cursor up by one line (available before you press Enter)
<Esc+<>	Specifies the cursor as the beginning of the clipboard.
<Esc+>>	Specifies the cursor as the ending of the clipboard.

 

 

Configuring Command Aliases

You can replace the first keyword of a command with your preferred keyword by configuring the command alias function. For example, if you configure show as the replacement of the display keyword for each display command, you can input the command alias show xx to execute the display xx command.

Note the following when you configure command aliases:

l          When you type a command alias, the system displays and saves the command in its original format instead of its alias. That is, you can define and use a command alias but the command is not saved and restored in its alias.

l          When you define a command alias, the cmdkey and alias arguments must be in complete form.

l          With the command alias function enabled, when you type an incomplete keyword, which partially matches both a defined alias and the keyword of a command, the alias wins; to execute the command whose keyword partially matches your input, you must type the complete keyword. When you input a character string that matches multiple aliases partially, the system prompts you for various matching information.

l          If you press Tab after you type the keyword of an alias, the original format of the keyword is displayed.

l          You can replace only the first keyword of a non-undo command instead of the complete command; and you can replace only the second keyword of an undo command.

Follow these steps to configure command aliases:

To do…	Use the command…	Remarks
Enter system view	system-view	—
Enable the command alias function	command-alias enable	Required Disabled by default, that is, you cannot configure command aliases.
Configure command aliases	command-alias mapping cmdkey alias	Required Not configured by default.

 

To display the configured command aliases, use the display command-alias command.

Synchronous Information Output

Synchronous information output refers to the feature that if your input is interrupted by system output, then after the completion of system output the system displays a command line prompt and your input so far, and you can continue your operations from where you were stopped.

Follow these steps to enable synchronous information output:

To do…	Use the command…	Remarks
Enter system view	system-view	—
Enable synchronous information output	info-center synchronous	Required Disabled by default

 

 

For information about the info-center synchronous command, see Information Center in the Network Management and Monitoring Configuration Guide.

Configuring Command Levels

Introduction

The AP uses user privilege levels and command levels to block unauthorized users. User privilege levels correspond to command levels. When users at different privilege levels log in, they can only use commands at their own level, or lower levels.

All the commands are categorized into four levels, which are visit, monitor, system, and manage from low to high, and identified respectively by 0 through 3. Table 1-7 describes the levels of the commands.

Table 1-7 Default command levels

Level	Privilege	Description
0	Visit	Involves commands for network diagnosis and commands for accessing an external device. Configuration of commands at this level cannot survive a device restart. Upon device restart, the commands at this level will be restored to the default settings. Commands at this level include ping, tracert, telnet and ssh2.
1	Monitor	Involves commands for system maintenance and service fault diagnosis. Commands at this level are not allowed to be saved after being configured. After the switch is restarted, the commands at this level will be restored to the default settings. Commands at this level include debugging, terminal, refresh, reset, and send.
2	System	Provides service configuration commands, including routing configuration commands and commands for configuring services at different network levels. By default, commands at this level include all configuration commands except for those at manage level.
3	Manage	Involves commands that influence the basic operation of the system and commands for configuring system support modules. By default, commands at this level involve the configuration commands of file system, FTP, TFTP, Xmodem download, user management, level setting, and parameter settings within a system (which are not defined by any protocols or  RFCs).

 

For how to configure the user privilege level, see Logging In to the AP in the Fundamentals Configuration Guide.

Modifying the Command Level

All the commands are defaulted to different levels. The administrator can modify the default command level to improve management flexibility.

Follow these steps to change the command level:

To do…	Use the command…	Remarks
Enter system view	system-view	—
Configure the command level of a specified command in a specified view	command-privilege level level view view command	Required Refer to Table 1-7 for the default settings.

 

 

Saving Configurations

Some commands in the CLI of APs are one-time commands, such as display commands, which display specified information, and the reset commands, which clear specified information. These commands are executed one-time only and are not saved when the AP reboots.

For other commands, after executing them, input the save command in any view to save all the submitted and executed commands into the configuration file. All saved commands are not lost after the AP reboots.