- Table of Contents
-
- 01-Fundamentals Command Reference
- 00-Preface
- 01-CLI commands
- 02-RBAC commands
- 03-Login management commands
- 04-FTP and TFTP commands
- 05-File system management commands
- 06-Configuration file management commands
- 07-Software upgrade commands
- 08-ISSU commands
- 09-GIR commands
- 10-Automatic configuration commands
- 11-Device management commands
- 12-Tcl commands
- 13-Python commands
- Related Documents
-
Title | Size | Download |
---|---|---|
01-CLI commands | 100.57 KB |
Basic CLI commands
alias
Use alias to configure a command alias.
Use undo alias to delete a command alias.
Syntax
alias alias command
undo alias alias
Default
The device has a set of system-defined command aliases, as listed in Table 1.
Table 1 System-defined command aliases
Command alias |
Command or command keyword |
access-list |
acl |
end |
return |
erase |
delete |
exit |
quit |
hostname |
sysname |
logging |
info-center |
no |
undo |
show |
display |
write |
save |
Views
System view
Predefined user roles
network-admin
Parameters
alias: Specifies an alias, a case-sensitive string of 1 to 20 characters. An alias cannot be alias or contain spaces or quotation marks (").
command: Specifies a command string. Make sure the command string meets the syntax requirements.
Usage guidelines
System-defined command aliases cannot be deleted.
You can configure one or more aliases for a command or the starting keywords of commands. Then, you can use the aliases to execute the command or commands. If the command or commands have undo forms, you can also use the aliases to execute the undo command or commands.
For example, if you configure the alias shiprt for display ip routing-table, you can enter shiprt to execute the display ip routing-table command. If you configure the alias ship for display ip, you can use ship to execute all commands that start with display ip:
· Enter ship routing-table to execute the display ip routing-table command.
· Enter ship interface to execute the display ip interface command.
The command string can include up to nine parameters. Each parameter starts with the dollar sign ($) and a sequence number in the range of 1 to 9. For example, you can configure the alias shinc for the display ip $1 | include $2 command. Then, to execute the display ip routing-table | include Static command, you only need to enter shinc routing-table Static. To execute the display ip interface | include GigabitEthernet1/0/1 command, you only need to enter shinc interface GigabitEthernet1/0/1.
Examples
# Configure shiprt as the alias for the display ip routing-table command and verify the configuration.
<Sysname> system-view
[Sysname] alias shiprt display ip routing-table
[Sysname] shiprt
Destinations : 13 Routes : 13
Destination/Mask Proto Pre Cost NextHop Interface
0.0.0.0/32 Direct 0 0 127.0.0.1 InLoop0
3.3.3.3/32 Static 60 0 192.168.1.62 Vlan1
127.0.0.0/8 Direct 0 0 127.0.0.1 InLoop0
127.0.0.0/32 Direct 0 0 127.0.0.1 InLoop0
127.0.0.1/32 Direct 0 0 127.0.0.1 InLoop0
127.255.255.255/32 Direct 0 0 127.0.0.1 InLoop0
169.254.0.0/24 Direct 0 0 169.254.0.188 Vlan1
169.254.0.0/32 Direct 0 0 169.254.0.188 Vlan1
169.254.0.188/32 Direct 0 0 127.0.0.1 InLoop0
169.254.0.255/32 Direct 0 0 169.254.0.188 Vlan1
224.0.0.0/4 Direct 0 0 0.0.0.0 NULL0
224.0.0.0/24 Direct 0 0 0.0.0.0 NULL0
255.255.255.255/32 Direct 0 0 127.0.0.1 InLoop0
# Configure shinc as the alias for display ip $1 | include $2.
[Sysname] alias shinc display ip $1 | include $2
# Use alias shinc to display all static routes.
[Sysname] shinc routing-table Static
3.3.3.3/32 Static 60 0 192.168.1.62 Vlan1
Related commands
display alias
display [ | [ by-linenum ] { begin | exclude | include } ]
Use display [ | [ by-linenum ] { begin | exclude | include } ] to filter the output from a display command with regular expressions.
Syntax
display command [ | [ by-linenum ] { begin | exclude | include } regular-expression ]&<1-128>
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
command: Specifies the keywords and arguments of a display command. To display available keywords and arguments, enter display ?.
[ | [ by-linenum ] { begin | exclude | include } regular-expression ]&<1-128>: Specifies a maximum of 128 filter conditions.
· by-linenum: Numbers the output lines. You need to specify this keyword in only one filter condition.
· begin: Displays the first line matching the specified regular expression and all subsequent lines.
· exclude: Displays all lines not matching the specified regular expression.
· include: Displays all lines matching the specified regular expression.
· regular-expression: Specifies a regular expression, a case-sensitive string of 1 to 256 characters.
Usage guidelines
To quickly locate certain lines in the output from a display command, you can use regular expressions to filter the output, and display a number before each output line. For more information about regular expressions, see Fundamentals Configuration Guide.
If you specify multiple filter conditions, the system displays the output lines that meet all the conditions.
A line number is a 5-character string and is typically followed by a colon (:). If you specify both the by-linenum and begin regular-expression options, a line number might be followed by a colon or a hyphen (-).
· Colon—The line matches the regular expression.
· Hyphen—The line does not match the regular expression.
Examples
# Display the lines that contain vlan in the running configuration.
<Sysname> display current-configuration | include vlan
vlan 1
vlan 999
port access vlan 999
# Display log entries in the log buffer that contain both SHELL and VTY.
<Sysname> display logbuffer | include SHELL | include VTY
%Sep 6 10:38:12:320 2018 Sysname SHELL/5/SHELL_LOGIN: VTY logged in from 169.254.100.171.
%Sep 6 10:52:32:576 2018 Sysname SHELL/5/SHELL_LOGOUT: VTY logged out from 169.254.100.171.
%Sep 6 16:03:27:100 2018 Sysname SHELL/5/SHELL_LOGIN: VTY logged in from 169.254.100.171.
%Sep 6 16:44:18:113 2018 Sysname SHELL/5/SHELL_LOGOUT: VTY logged out from 169.254.100.171.
# Display the running configuration, starting from the first line that contains user-group and numbering the output lines.
<Sysname> display current-configuration | by-linenum begin user-group
114: user-group system
115- #
116- return
display >
Use display > to save the output from a display command to a separate file.
Syntax
display command > filename
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
command: Specifies the keywords and arguments of a display command. To display available keywords and arguments, enter display ?.
filename: Specifies the name of the file that is used to save the output, a string of 1 to 63 characters.
Usage guidelines
The display commands show the configuration, statistics, and states of the device. You can use the display > command to save the output to a file.
If the specified file does not exist, the system creates the file and saves the output to the file. If the file already exists, the system overwrites the file.
Examples
# Save VLAN 1 settings to a separate file named vlan.txt.
<Sysname> display vlan 1 > vlan.txt
# Check the content of the vlan.txt file.
<Sysname> more vlan.txt
VLAN ID: 1
VLAN type: Static
Route interface: Not configured
Description: VLAN 0001
Name: VLAN 0001
Tagged ports: None
Untagged ports:
GigabitEthernet1/0/2
display >>
Use display >> to append the output from a display command to the end of a file.
Syntax
display command >> filename
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
command: Specifies the keywords and arguments of a display command. To display available keywords and arguments, enter display ?.
filename: Specifies the name of the file that is used to save the output, a string of 1 to 63 characters.
Usage guidelines
The display commands show the configuration, statistics, and states of the device. You can use display >> to save the output to a file.
If the specified file does not exist, the system creates the file and saves the output to the file. If the file already exists, the system appends the output to the end of the file.
Examples
# Append the VLAN 999 settings to the end of the vlan.txt file.
<Sysname> display vlan 999 >> vlan.txt
<Sysname>
# Check the content of the vlan.txt file.
<Sysname> more vlan.txt
VLAN ID: 1
VLAN type: Static
Route interface: Not configured
Description: VLAN 0001
Name: VLAN 0001
Tagged ports: None
Untagged ports:
GigabitEthernet1/0/2
VLAN ID: 999
VLAN type: Static
Route interface: Configured
IPv4 address: 192.168.2.1
IPv4 subnet mask: 255.255.255.0
Description: For LAN Access
Name: VLAN 0999
Tagged ports: None
Untagged ports:
GigabitEthernet1/0/2
display alias
Use display alias to display command aliases.
Syntax
display alias [ alias ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
alias: Specifies a command alias. If you do not specify this argument, the command displays all command aliases.
Examples
# Display all command aliases.
<Sysname> display alias
Index Alias Command key
1 access-list acl
2 end return
3 erase delete
4 exit quit
5 hostname sysname
6 logging info-center
7 no undo
8 shinc display $1 | include $2
9 show display
10 sirt display ip routing-table
11 write save
# Display the command alias shinc.
<Sysname> display alias shinc
Alias Command key
shinc display ip $1 | include $2
Related commands
alias
display history-command
Use display history-command to display all commands that are saved in the command history buffer for the current CLI session.
Syntax
display history-command
Views
Any view
Predefined user roles
network-admin
network-operator
Usage guidelines
The system automatically saves commands you have successfully executed to the command history buffer for the current CLI session. You can view them and execute them again.
By default, the system can save up to 10 commands in the buffer. You can use the history-command max-size command to change the buffer size. To buffer a new command when the buffer is full, the system deletes the oldest command entry in the buffer.
All commands in the command history buffer for the current CLI session will be cleared when you log out.
The system displays passwords as asterisks (*) to ensure device security if the command history buffer has password configuration commands.
Examples
# Display all commands saved in the command history buffer for the current CLI session.
<Sysname> display history-command
system-view
vlan 2
quit
Related commands
history-command max-size
display history-command all
Use display history-command all to display all commands that are saved in the command history buffer for all CLI sessions.
Syntax
display history-command all
Views
Any view
Predefined user roles
network-admin
Usage guidelines
The system automatically saves commands successfully executed by users to the command history buffer for all CLI sessions. Users can view them but cannot recall them from the buffer.
Up to 1024 commands can be saved in the command history buffer. To buffer a new command when the buffer is full, the system deletes the oldest command entry in the buffer.
A user logout does not cause the system to delete commands from the history buffer for all CLI sessions.
The system displays passwords as asterisks (*) to ensure device security if the command history buffer has password configuration commands.
Examples
# Display all commands saved in the command history buffer for all CLI sessions.
<Sysname> display history-command all
Date Time Terminal Ip User
03/16/2017 20:03:33 vty0 192.168.1.26 **
Cmd:dis his all
03/16/2017 20:03:29 vty0 192.168.1.26 **
Cmd:sys
Table 2 Command output
Field |
Description |
Date |
Date when the command was executed. |
Time |
Time when the command was executed. |
Terminal |
User line used by the user. |
Ip |
IP address of the terminal used by the user. |
User |
Username used by the user if the user login authentication mode is scheme. If the login authentication mode is none or password, this field displays **. |
Cmd |
Command string entered by the user. |
Related commands
display hotkey
Use display hotkey to display hotkey information.
Syntax
display hotkey
Views
Any view
Predefined user roles
network-admin
network-operator
Examples
# Display hotkey information.
<Sysname> display hotkey
----------------- Hotkeys -----------------
-Defined function hotkeys-
CTRL_A Move the cursor to the beginning of the line.
CTRL_B Move the cursor one character to the left.
CTRL_C Stop the current command.
CTRL_D Erase the character at the cursor.
CTRL_E Move the cursor to the end of the line.
CTRL_F Move the cursor one character to the right.
CTRL_H Erase the character to the left of the cursor.
CTRL_N Display the next command in the history buffer.
CTRL_P Display the previous command in the history buffer.
CTRL_R Redisplay the current line.
CTRL_W Delete the word to the left of the cursor.
CTRL_X Delete all characters from the beginning of the line to the cursor.
CTRL_Y Delete all characters from the cursor to the end of the line.
CTRL_Z Return to the User View.
CTRL_] Kill incoming connection or redirect connection.
ESC_B Move the cursor back one word.
ESC_D Delete all characters from the cursor to the end of the word.
ESC_F Move the cursor forward one word.
-Defined command hotkeys-
CTRL_G display current-configuration
CTRL_L display ip routing-table
CTRL_O undo debugging all
-Undefined hotkeys-
CTRL_T NULL
CTRL_U NULL
Related commands
hotkey
hotkey
Use hotkey to configure a hotkey.
Use undo hotkey to restore the default.
Syntax
hotkey hotkey { command | function function | none }
undo hotkey hotkey
Default
Table 3 shows the default definitions for hotkeys.
Table 3 Default definitions for hotkeys
Function or command |
|
Ctrl+A |
move_the_cursor_to_the_beginning_of_the_line: Moves the cursor to the beginning of a line. |
Ctrl+B |
move_the_cursor_one_character_to_the_left: Moves the cursor one character to the left. |
Ctrl+C |
stop_the_current_command: Stops the current command. |
Ctrl+D |
erase_the_character_at_the_cursor: Deletes the character at the cursor. |
Ctrl+E |
move_the_cursor_to_the_end_of_the_line: Moves the cursor to the end of a line. |
Ctrl+F |
move_the_cursor_one_character_to_the_right: Moves the cursor one character to the right. |
Ctrl+G |
display current-configuration: Displays the running configuration. |
Ctrl+H |
erase_the_character_to_the_left_of_the_cursor: Deletes the character to the left of the cursor. |
Ctrl+L |
display ip routing-table: Displays the IPv4 routing table information. |
Ctrl+N |
display_the_next_command_in_the_history_buffer: Displays the next command in the history buffer. Password configuration commands, if any, are skipped. |
Ctrl+O |
undo debugging all: Displays all debugging functions. |
Ctrl+P |
display_the_previous_command_in_the_history_buffer: Displays the previous command in the history buffer. Password configuration commands, if any, are skipped. |
Ctrl+R |
redisplay_the_current_line: Redisplays the current line. |
Ctrl+T |
N/A |
Ctrl+U |
N/A |
Ctrl+W |
delete_the_word_to_the_left_of_the_cursor: Deletes the word to the left of the cursor. |
Ctrl+X |
delete_all_characters_from_the_beginning_of_the_line_to_the_cursor: Deletes all characters to the left of the cursor. |
Ctrl+Y |
delete_all_characters_from_the_cursor_to_the_end_of_the_line: Deletes all characters from the cursor to the end of the line. |
Ctrl+Z |
return_to_the_User_View: Returns to user view. |
Ctrl+] |
kill_incoming_connection_or_redirect_connection: Terminates the current connection. |
Esc+B |
move_the_cursor_back_one_word: Moves the cursor back one word. |
Esc+D |
delete_all_characters_from_the_cursor_to_the_end_of_the_word: Deletes all characters from the cursor to the end of the word. |
Esc+F |
move_the_cursor_forward_one_word: Moves the cursor forward one word. |
Views
System view
Predefined user roles
network-admin
Parameters
hotkey: Specifies a hotkey. To display the supported hotkeys, enter hotkey ? or see Table 3.
command: Specifies the command to be assigned to the hotkey.
function function: Specifies the function to be assigned to the hotkey. To display the supported functions, enter hotkey hotkey function ? or see Table 3.
none: Removes the command or function assignment for the hotkey. After you remove the assignment for a hotkey, pressing the hotkey does not execute any command or function.
Usage guidelines
The device supports a set of hotkeys. Pressing a hotkey executes the command or function assigned to the hotkey. You can configure all the hotkeys except Ctrl+].
A hotkey can correspond to only one command or function. If you assign multiple commands or functions to the same hotkey, the most recently assigned command or function takes effect.
A command or function can be assigned to multiple hotkeys. You can use any of those hotkeys to execute the command or function.
If a hotkey is also defined by the terminal software you are using to interact with the device, the terminal software definition takes effect.
Examples
# Assign the display tcp statistics command to hotkey Ctrl+T.
<Sysname> system-view
[Sysname] hotkey ctrl_t display tcp statistics
# Assign move_the_cursor_to_the_beginning_of_the_line function to hotkey Ctrl+U.
<Sysname> system-view
[Sysname] hotkey ctrl_u function move_the_cursor_to_the_beginning_of_the_line
# Disable the configurable command or function assigned to hotkey Ctrl+A.
<Sysname> system-view
[Sysname] hotkey ctrl_a none
Related commands
display hotkey
quit
Use quit to return to the upper-level view.
Syntax
quit
Views
Any view
Predefined user roles
network-admin
network-operator
Usage guidelines
Executing this command in user view disconnects you from the device.
Examples
# Return from GigabitEthernet 1/0/1 interface view to system view and then to user view.
[Sysname-GigabitEthernet1/0/1] quit
[Sysname] quit
<Sysname>
repeat
Use repeat to repeat commands in the command history buffer for the current CLI session.
Syntax
repeat [ number ] [ count times ] [ delay seconds ]
Views
Any view
Predefined user roles
network-admin
Parameters
number: Specifies the number of the most recently executed commands in the command history buffer for the current CLI session that you want to execute. The value range is 1 to 10. The default is 1.
count times: Specifies the number of times that you want to execute the commands. The value range is 0 to 4294967295. The default is 0. If you do not specify this option, the system keeps executing the commands until you press the escape key to terminate the execution.
delay seconds: Specifies the time (in seconds) for the system to wait before executing the commands again. The value range is 0 to 4294967295. The default is 1.
Usage guidelines
To repeat a command, first enter the view for the command. To repeat multiple commands, first enter the view for the first command.
The repeat command executes commands in the order they were executed.
The system starts a timer and waits for your interaction when it repeats an interactive command. If you do not provide the required information at prompt before the timer expires, the system skips the interactive command.
The system skips all password configuration commands.
Examples
# Configure the system to execute the two most recently executed commands (display cpu-usage and display clock) three times at an interval of 10 seconds.
<Sysname> repeat 2 count 3 delay 10
<Sysname> display cpu
Slot 1 CPU 0 CPU usage:
33% in last 5 seconds
32% in last 1 minute
33% in last 5 minutes
<Sysname> display clock
07:02:18.230 UTC Thu 06/19/2017
<Sysname> display cpu-usage
Slot 1 CPU 0 CPU usage:
33% in last 5 seconds
32% in last 1 minute
33% in last 5 minutes
<Sysname> display clock
07:02:28.263 UTC Thu 06/19/2017
<Sysname> display cpu-usage
Slot 1 CPU 0 CPU usage:
33% in last 5 seconds
32% in last 1 minute
33% in last 5 minutes
<Sysname> display clock
07:02:38.293 UTC Thu 06/19/2017
Related commands
display history-command
escape-key
history-command max-size
return
Use return to return to user view from any other view except Tcl configuration view and the Python shell.
Syntax
return
Views
Any view except user view, Tcl configuration view, and the Python shell
Predefined user roles
network-admin
network-operator
Usage guidelines
To return directly to user view from any other view except Tcl configuration view and the Python shell, use the return command. Or, you can press Ctrl+Z, which has the same effect as the return command.
To return to user view from Tcl configuration view, use the tclquit command.
To return to user view from the Python shell, use the exit() command.
Examples
# Return to user view from GigabitEthernet 1/0/1 interface view.
[Sysname-GigabitEthernet1/0/1] return
<Sysname>
screen-length disable
Use screen-length disable to disable pausing between screens of output for the current CLI session.
Use undo screen-length disable to enable pausing between screens of output for the current CLI session.
Syntax
screen-length disable
undo screen-length disable
Default
The default depends on the configuration of the screen-length command in user line view.
The following are the default settings for the screen-length command:
· Pausing between screens of output.
· Displaying up to 24 lines on a screen.
Views
User view
Predefined user roles
network-admin
Usage guidelines
If you disable pausing between screens of output, all output is displayed. The screen is refreshed continuously until the final screen is displayed.
This command takes effect only for the current CLI session. When you are logged out, the default is restored.
Examples
# Disable pausing between screens of output for the current CLI session.
<Sysname> screen-length disable
Related commands
screen-length
system-view
Use system-view to enter system view from user view.
Syntax
system-view
Views
User view
Predefined user roles
network-admin
network-operator
Examples
# Enter system view from user view.
<Sysname> system-view
System View: return to User View with Ctrl+Z.
[Sysname]