Common Command Views

The command line prompt HUAWEI is the default host name (sysname), and the prompt indicates the current view. For example, <> indicates the user view and [] indicates all other views.

To add comments, enter ! or # followed by a character string in any view. All the entered content (including ! and #) is displayed as comments and no corresponding configuration will be generated.

• Some commands can be executed in multiple views, while their functions depend on the views these commands are executed.

• In the system view, you can run the diagnose command to enter the diagnostic view. Diagnostic commands are used for device fault diagnosis, and running certain commands in this view may cause the device unable to work properly or interrupt services. To use these diagnostic commands, contact technical support.

Exiting Command Views

To return from the current view to an upper-level view, run the quit command.

[~HUAWEI-aaa] quit
[~HUAWEI] quit
<HUAWEI>

To return from the AAA view directly to the user view, press Ctrl+Z or run the return command.

[~HUAWEI-aaa]           //Enter Ctrl+Z.
<HUAWEI> 

[~HUAWEI-aaa] return
<HUAWEI> 

Immediate Mode

system-view immediately

In immediate mode, the command line prompt is as follows:

<HUAWEI> system-view immediately
Enter system view, return user view with return command.
[HUAWEI]

Two-Stage Mode

1. Enable the two-stage mode.

   system-view

2. (Optional) Display all uncommitted configurations.

   display configuration candidate [ merge | changes ]

   If you do not specify the merge and changes keywords, the command displays uncommitted configurations only. If you specify the merge keyword, the command displays both uncommitted and committed configurations. The changes keyword is specified to display the differences between the uncommitted configurations and current running configurations.

   You can edit uncommitted configurations.

   If the system displays a message indicating that the current running configurations are changed when you run the display configuration candidate changes command, run the refresh configuration candidate command to resolve the configuration conflict so that you can continue to view the configuration differences.

3. (Optional) Delete all uncommitted configurations.

   clear configuration candidate

4. (Optional) Enable a trial run of system configurations.

   commit trial [ time ] [ persist persistId ]

   This command enables a trial run of new functions and services without interrupting those running on the live network, which improves network reliability. When the trial running period elapses, the configurations in trial running state are automatically rolled back. If the persist parameter is not specified, the configuration trial run takes effect only in the current session. If the persist parameter is specified, the configuration trial run does not stop when the session ends.

   To disable the trial run of configurations before the trial run times out, run the abort trial command to roll the system configurations back to those used before the trial run. To view the trial run status of system configurations, run the display configuration trial status command.

5. Commit configurations.

   commit [ persist persistId ]

   Before the persistent trial run is rolled back due to timeout, you can specify the persist keyword in any session to commit the configurations in trial run.

In two-stage mode, if the user modifies but not commits configurations, the system prompt ~ is changed to *, notifying the user that the configurations are not committed. After the user runs the commit command to commit the configurations, the system prompt * is restored to ~.

For example:

<HUAWEI> system-view
Enter system view, return user view with return command.
[~HUAWEI] sysname HUAWEIA
[*HUAWEI] commit
[~HUAWEI]

Function Overview

You can edit command lines in a CLI. Each command can contain a maximum of 3100 characters. The keywords in the commands are case insensitive, and whether a command parameter is case sensitive depends on the parameter.

Table 1-4 lists keys that are frequently used for editing command lines

How to Edit Command Lines

Incomplete Keyword

You are not required to enter complete keywords on the device, as long as entered characters can match a unique keyword. This function improves operating efficiency.

If the current input keyword matches multiple commands, you need to type more of the keyword until it can match a unique command. Then the command can be successfully delivered.

For example, to execute the display current-configuration command, you can enter d cu, di cu, or dis cu, but you cannot enter d c or dis c because they do not match unique keywords.

The maximum length of a command (including an incomplete command) is 3100 characters. If an incomplete command is configured, the system saves this command to the configuration file in its complete format, which may cause the command to have more than 3100 characters. In this case, the incomplete commands cannot be restored after the system restarts. As such, you must pay attention to the length of a command when configuring it in incomplete format.

Tab

Full Help

When entering a command, you can use the full help function to obtain all the keywords and parameters of the command. Use any of the following methods to obtain full help for commands.

• Enter a question mark (?) in any command view to obtain all the commands and their simple descriptions in this command view. For example:

  <HUAWEI> ?
  Current view commands:
    activate        Activate locked user
    cd              Change current directory
    clear           Clear operation
    clock           Clock status and configuration information
    copy            Copy from one file to another
  ...

• Enter some keywords of a command and a question mark (?) separated by a space to display all the keywords associated with this command, as well as simple descriptions. For example:

  <HUAWEI> system-view
  [~HUAWEI] user-interface vty 0 4
  [~HUAWEI-ui-vty0-4] authentication-mode ?
    aaa       AAA authentication
    password  Authentication through the password of a user terminal interface

  In the preceding command output, the description of the aaa keyword is AAA authentication, and the description of the password is Authentication through the password of a user terminal interface.

• Enter some keywords of a command and a question mark (?) separated by a space to display all the parameters associated with this keyword, as well as simple descriptions. For example:

  <HUAWEI> system-view
  [~HUAWEI] ssh server timeout ?
    INTEGER<1-35791>  Set the authentication timeout, the default value is 60 seconds 
  [~HUAWEI] ssh server timeout 35 ?
   <cr>
  [~HUAWEI] ssh server timeout 35

  INTEGER<1-35791> describes the value range of the parameter. Set the authentication timeout, the default value is 60 briefly describes the function of this parameter. <cr> indicates that there is no keyword or parameter in this position. You can press Enter to run this command.

Partial Help

If you enter one or more of the first few characters of a command keyword, partial help provides all the keywords that begin with this character or character string. Use any of the following methods to obtain partial help for commands.

• Enter a character string followed directly by a question mark (?) to display all keywords that begin with this character string. For example:

  <HUAWEI> d?
    debugging                               delete
    dir                                     display
  <HUAWEI> d

• Enter a command and a string followed directly by a question mark (?) to display all the keywords that begin with this character string. For example:

  <HUAWEI> display b?
    bfd                                     bgp  

• Enter the first several letters of a keyword in a command and press Tab to display a complete keyword. However, the first several letters must uniquely identify the keyword. Otherwise, keep pressing Tab to display different keywords and select the required one.

User-defined Shortcut Keys

If a user frequently uses a specific command or selection of commands, the user can use shortcut keys to define them. Only management-level users have the rights to define shortcut keys. The configurations are as follows:

1. Enter the system view.

   system-view

2. Configure a shortcut key for a command.

   hotkey { CTRL_G | CTRL_L | CTRL_O | CTRL_U } command-text

   The system supports four user-defined shortcut keys and the default values are as follows:

   • Ctrl+G: display current-configuration

   • Ctrl+L: display ip routing-table

   • Ctrl+O: undo debugging all

   • Ctrl+U: Null

3. Commit the configuration.

   commit

• When defining shortcut keys, use double quotation marks to surround a command that contains several keywords separated by spaces, for example, hotkey ctrl_l "display tcp status". Do not use double quotation marks to surround a command that contains only one keyword.

• Run the display hotkey command to view the status of the defined, undefined, and system-defined shortcut keys.

• Run the undo hotkey command to restore the default values of the configured shortcut keys.

• Entering shortcut keys is equivalent to command execution. The device records the commands corresponding to the entered shortcut keys in the command buffer and logs for fault detection and query.

• The user-defined shortcut keys are available to all users. However, if a user does not have the rights to use the command defined by a shortcut key, the system displays an error message when the user uses this shortcut key.

System-defined Shortcut Keys

Command Output Display

When the displayed information cannot be completely output on one screen, you can use the pause function to view the information on that screen, before moving onto the next screen. Table 1-9 describes the display functions.

Regular Expressions

A regular expression is a mode matching tool that consists of common characters (such as letters from a to z) and special characters (also called meta-characters). It functions as a template to match a character pattern with the searched character string.

A regular expression consists of the following characters:

• Common characters

  A regular expression matches a string against the defined common characters. Common characters include all uppercase and lowercase letters, digits, punctuations, and special characters. For example, a matches the letter "a" in "abc", 10 matches the digits "10" in "10.113.25.155", and @ matches the symbol "@" in "xxx@xxx.com".

• Special characters

  Special characters, together with common characters, match complicated or special character strings. Table 1-10 describes special characters and their syntax.

  Table 1-10 Special characters and their functions

  Special Character	Function	Example
  \	Defines an escape character. It converts a special or common character next to it into a common character.	\* matches *.
  ^	Matches the start of the string.	^10 matches 10.10.10.1 instead of 172.16.1.1.
  $	Matches the end of the string.	1$ matches 10.10.10.1 instead of 10.10.10.2.
  *	Matches a sub-regular expression that it follows for zero or multiple times.	10* matches 1, 10, 100, 1000, and so on. (10)* matches null, 10, 1010, 101010, and so on.
  +	Matches a sub-regular expression that it follows once or for multiple times.	10+ matches 10, 100, 1000, and so on. (10)+ matches 10, 1010, 101010, and so on.
  ?	Matches a sub-regular expression that it follows for zero times or once. NOTE: When regular expressions with a question mark (?) are entered on Huawei datacom devices, the command help information is displayed. However, if the command output is displayed on more than one screen and filter criteria followed by a question mark (?) are entered, this question mark is considered a special character of a regular expression.	10? matches 1 or 10. (10)? matches null or 10.
  .	Matches any single character.	a.b matches any string of three characters that starts with a and ends with b. 0.0 matches 0x0, 020, and so on. .oo matches book, look, tool, and so on.
  ()	Matches and captures a sub-regular expression within the parentheses. If there is no value within the parentheses, the string is equivalent to a null string. If a pattern string has only (), it can match any string. If the right parenthesis in a pattern string has no matching left parenthesis, the right parenthesis is used as a common character. If the left parenthesis in a pattern string has no matching right parenthesis, the pattern string is invalid.	100(200)+ matches 100200, 100200200, and so on. (ab) matches abcab. () can match any string. a()b matches 12ab12. a)b matches za)bc. a(b is an invalid pattern string.
  _	Matches regular expressions with a sign, such as a comma (,), left brace ({), right brace (}), left parenthesis ((), right parenthesis ()), or space. In addition, the underscore (_) can be used at the beginning of a regular expression with the same function as the caret (^) or at the end of a regular expression with the same function as the dollar sign ($).	_65001_ matches 20 65001 30, 20 65001, 65001 30, 65001, and so on.
  x|y	Matches x or y.	100|200 matches 100 or 200. 1(2|3)4 matches 124 or 134, rather than 1234, 14, 1224, and 1334.
  [xyz]	Matches any character contained in a regular expression. It cannot simultaneously match multiple characters or match the same character multiple times.	[123] matches 2 in 255. [abc] matches characters a, b, and c.
  [^xyz]	Matches characters excluding x, y, and z in a character string. That is, it matches any string with at least one character that is not x, y, or z.	[^123] matches any character except 1, 2, and 3. [^abc] matches any character except a, b, and c.
  [a-z]	Matches any character within a specified range. It cannot simultaneously match multiple characters or match the same character multiple times.	[0-9] matches any digit within the range of 0 to 9. [a-z] matches any letter from a to z. [z-a] is an invalid pattern string.
  [^a-d]	Matches all characters except a, b, c, and d in a character string. That is, it matches any string with at least one character that is beyond the range of a to d.	[^0-9] matches all non-digit characters. [^a-z] matches all non-letter characters. [^z-a] is an invalid pattern string.

  Unless otherwise specified, all the characters in the preceding table must be printable characters.

• Degeneration of special characters

  Certain special characters, when placed at certain positions in a regular expression, degenerate to common characters.

  • The special characters following escape character \ match themselves.

  • Special characters * and + placed at the beginning of a regular expression. For example, +45 matches "+45" and abc(*def) matches "abc*def".

  • Special character ^ placed in a non-start position of a regular expression For example, abc^ matches "abc^".

  • Special character $ placed in a non-end position of a regular expression For example, 12$2 matches "12$2".

  • A right parenthesis ) or right bracket ] alone. For example, abc) matches "abc)" and 0-9] matches "0-9]".

  Unless otherwise specified, degeneration rules also apply when the preceding regular expressions are sub-regular expressions within parentheses.

• Combination of common and special characters

  In actual usage, regular expressions combine multiple common and special characters to match certain strings.

Specifying a Filtering Mode in a Command

When a character string is used to filter command output information, the first line of the output starts from the line where certain information matches the character string, not from the matched information.

The system allows you to use | count to display the number of lines, | section to display the command output by section, | ignore-case to match a string of case-insensitive characters, and | no-more to display filtered output information on only one screen. | count and | section can be used with the following filtering modes or used independently. | ignore-case and | no-more must be used with the following filtering modes.

Three filtering modes are provided for commands that support regular expressions.

• | begin regular-expression: displays all the lines beginning with the line that matches the regular expression.

  Filter the command output information until the information matches the specified case-sensitive character string is displayed. The output following the certain information that matches the character string will be displayed on the screen.

• | exclude regular-expression: displays all the lines that do not match the regular expression.

  If the character strings to be output do not contain the specified case-sensitive character string, they are displayed on the screen; otherwise, they are filtered.

• | include regular-expression: displays all the lines that match the regular expression.

  If the character strings to be output contain the specified case-sensitive character string, they are displayed on the screen; otherwise, they are filtered.

The value of regular-expression is a string of 1 to 255 characters.

The command output can be filtered by multiple regular expressions, which take effect in configuration sequence. A maximum of 32 regular expressions can be configured to filter the command output.

| section is used to display only the commands with section information in the output, such as the display current-configuration and display this commands.

The following examples describe how to specify a filter mode in a command.

Example 1: Run the display pm brief command to display all the lines that do not match the regular expression Directory|Files. Directory|Files matches directories or files.

<HUAWEI> display pm brief | exclude Directory|Files 
Statistics Status                   : disable                                                                                       
Statistics Start Time               : -                                                                                             
Current Statistics Cycles           : -                                                                                             
Number of Statistics Tasks          : 0                                                                                             
Number of Statistics Objects        : 0                                                                                             
Number of Configured Pm Servers     : 0 

Example 2: Use the vlan regular expression to filter the display current-configuration command output.

<HUAWEI> display current-configuration | include vlan
vlan batch 7 10 18 to 19 30 60 66 70 77 100 105
vlan batch 200 1024
 port default vlan 77
 port default vlan 19
 port hybrid pvid vlan 10
 port hybrid untagged vlan 10
 port hybrid pvid vlan 60
 undo port hybrid vlan 1
 port hybrid tagged vlan 60
 port trunk allow-pass vlan 60
 port hybrid pvid vlan 10
 port hybrid tagged vlan 7
 port hybrid untagged vlan 10

Example 3: Use the vlan regular expression to filter the display current-configuration command output.

<HUAWEI> display current-configuration | include vlan | count
Total lines: 14.

The preceding information is used for reference only.

| refresh can be used to update the query results at a specific interval. The default interval is 5 seconds.

• If the interval is too short, the CPU usage will increase. Set the interval to a proper value.
• If the number of available VTY channels on a device is less than 3, | refresh cannot be used.
• Only display commands can be queried using | refresh.