- 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-GIR commands
- 09-Target configuration management commands
- 10-Device management commands
- 11-Tcl commands
- 12-Python commands
- Related Documents
-
Title | Size | Download |
---|---|---|
01-CLI commands | 105.28 KB |
Basic CLI commands
abort
Use abort to return to user view without any prompt.
Syntax
abort
Views
Any view in private mode
Any view in exclusive mode
Predefined user roles
network-admin
network-operator
Usage guidelines
To return directly to user view, you can execute the abort or return command or press Ctrl+Z.
· If you execute return or press Ctrl+Z to return from private-mode or exclusive-mode view to user view, the system displays a message to notify you of uncommitted target configuration command lines (if any).
· If you execute abort to return from private-mode or exclusive-mode view to user view, the system discards uncommitted target configuration command lines (if any) without any prompt.
Examples
# Return to user view from private-mode view of interface Ten-GigabitEthernet 3/1/1.
~[Sysname-Ten-GigabitEthernet3/1/1] abort
<Sysname>
Related commands
quit
return
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 need to enter only shinc routing-table Static.
To use an alias for a command that has parameters, you must specify a value for each parameter. If you fail to do so, the system informs you that the command is incomplete and displays the command string represented by the alias.
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 : 15 Routes : 15
Destination/Mask Proto Pre Cost NextHop Interface
0.0.0.0/0 Static 60 0 192.168.2.1 MGE0/0/0
0.0.0.0/32 Direct 0 0 127.0.0.1 InLoop0
10.1.1.0/30 Direct 0 0 10.1.1.2 Loop10
10.1.1.0/32 Direct 0 0 10.1.1.2 Loop10
10.1.1.2/32 Direct 0 0 127.0.0.1 InLoop0
10.1.1.3/32 Direct 0 0 10.1.1.2 Loop10
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
192.168.2.0/24 Direct 0 0 192.168.2.88 MGE0/0/0
192.168.2.0/32 Direct 0 0 192.168.2.88 MGE0/0/0
192.168.2.88/32 Direct 0 0 127.0.0.1 InLoop0
192.168.2.255/32 Direct 0 0 192.168.2.88 MGE0/0/0
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
configuration system-view-mode
Use configuration system-view-mode to specify the mode of the system view that the system will enter by default after the system-view command is executed.
Use undo configuration system-view-mode to restore the default.
Syntax
configuration system-view-mode { immediate | private }
undo configuration system-view-mode
Default
The system enters real-time-mode system view after the system-view command is executed.
Views
System view
Predefined user roles
network-admin
network-operator
Parameters
immediate: Specifies real-time-mode system view.
private: Specifies private-mode system view.
Usage guidelines
By default, the system enters real-time-mode system view after the system-view command is executed. To configure the settings in non-real-time-mode, you must specify the exclusive or private keyword each time the system enters system view. To simplify the configuration, you can execute the configuration system-view-mode command to specify the default mode of the system view that the system will enter after the system-view command is executed.
The configured default mode of the system view takes effect the next time you execute the system-view command.
Examples
# Configure the system to enter private-mode system view after the system-view command is executed.
<Sysname> system-view
[Sysname] configuration system-view-mode private
Related commands
system-view
display | { begin | exclude | include }
Use display | { begin | exclude | include } to filter the output from a display command with a regular expression.
Syntax
display command | { begin | exclude | include } regular-expression
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 ?.
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
Use the | { begin | exclude | include } regular-expression option with a display command to filter the command output. For more information about regular expressions, see Fundamentals Configuration Guide.
Examples
# Display the lines that contain alias in the running configuration.
<Sysname> display current-configuration | include alias
alias shiprt display ip routing-table
display | by-linenum
Use display | by-linenum to number each output line for a display command.
Syntax
display command | by-linenum
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 ?.
Usage guidelines
By numbering each output line from a display command, you can easily identify the lines of interest.
Each line number is displayed as a 5-character string and might be followed by a colon (:) or hyphen (-). If you specify both | by-linenum and | begin regular-expression for a display command, a hyphen is displayed for all lines that do not match the regular expression.
Examples
# Display local user settings, with each output line identified by a number.
<Sysname> display local-user | by-linenum
1: Total 1 local users matched.
2:
3: Device management user admin:
4: State: Active
5: Service type: Telnet
6: User group: system
7: Bind attributes:
8: Authorization attributes:
9: Work directory: flash:
10: User role list: network-admin
# Display the first line that begins with user-group in the running configuration and all of the following 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 the output from the display current-configuration | include telnet command to a separate file named service.txt.
<Sysname> display current-configuration | include telnet > service.txt
# Check the content of the service.txt file.
<Sysname> more service.txt
telnet server enable
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 output from the display current-configuration | include ftp command to the end of the service.txt file.
<Sysname> display current-configuration | include ftp >> service.txt
# Check the content of the service.txt file.
<Sysname> more service.txt
telnet server enable
ftp server enable
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 shinc command alias.
<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
interface ten-gigabitethernet 3/1/1
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/2012 20:03:33 vty0 192.168.1.26 **
Cmd:dis his all
03/16/2012 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 command hotkeys-
CTRL_G display current-configuration
CTRL_L display ip routing-table
CTRL_O undo debugging all
-Undefined command hotkeys-
CTRL_T NULL
CTRL_U NULL
-System-reserved 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_K Abort the connection request.
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.
|
NOTE: If the next or previous command in the command history buffer is a password configuration command, the Ctrl+N or Ctrl+P hotkey skips the command. |
Related commands
hotkey
hotkey
Use hotkey to assign a command to a configurable command hotkey.
Use undo hotkey to restore the default.
Syntax
hotkey { ctrl_g | ctrl_l | ctrl_o | ctrl_t | ctrl_u } command
undo hotkey { ctrl_g | ctrl_l | ctrl_o | ctrl_t | ctrl_u }
Default
· Ctrl+G: display current-configuration (display the running configuration).
· Ctrl+L: display ip routing-table (display the IPv4 routing table information).
· Ctrl+O: undo debugging all (disable all debugging functions).
· Ctrl+T: No command is assigned to this hotkey.
· Ctrl+U: No command is assigned to this hotkey.
Views
System view
Predefined user roles
network-admin
Parameters
ctrl_g: Assigns a command to Ctrl+G.
ctrl_l: Assigns a command to Ctrl+L.
ctrl_o: Assigns a command to Ctrl+O.
ctrl_t: Assigns a command to Ctrl+T.
ctrl_u: Assigns a command to Ctrl+U.
command: Specifies the command to be assigned to the hotkey.
Usage guidelines
The system defines some command hotkeys and provides five configurable command hotkeys. Pressing a command hotkey executes the command assigned to the hotkey.
To display system-defined and configurable command hotkeys, use the display hotkey command.
Examples
# Assign the display tcp statistics command to the Ctrl+T hotkey.
<Sysname> system-view
[Sysname] hotkey ctrl_t display tcp statistics
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.
When you return from private-mode or exclusive-mode system view to user view, the system displays a message to notify you of uncommitted target configuration command lines (if any).
Examples
# Return from Ten-GigabitEthernet 3/1/1 interface view to system view and then to user view.
[Sysname-Ten-GigabitEthernet3/1/1] quit
[Sysname] quit
<Sysname>
# Return from private-mode system view to user view.
<Sysname> system-view private
~[Sysname] quit
Uncommitted changes found. Commit them before exiting? [Y(yes)/N(no)/C(cancel)]:y
Related commands
abort
return
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 256. 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. To display the current escape key, use the display current-configuration | include escape-key command.
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 waits for your interaction when it repeats an interactive command.
The system skips all password configuration commands.
The number of commands to be repeated in the command history buffer is determined by the minimum value of the following:
· Number of the most recently executed commands in the command history buffer specified by the repeat command.
· Size of the command history buffer specified by the history-command max-size command.
· Number of the commands in the command history buffer.
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-usage
Unit CPU usage:
33% in last 5 seconds
32% in last 1 minute
33% in last 5 minutes
<Sysname> display clock
12:20:08 UTC Thu 06/19/2014
<Sysname> display cpu-usage
Unit CPU usage:
33% in last 5 seconds
32% in last 1 minute
33% in last 5 minutes
<Sysname> display clock
12:20:18 UTC Thu 06/19/2014
<Sysname> display cpu-usage
Unit CPU usage:
33% in last 5 seconds
32% in last 1 minute
33% in last 5 minutes
<Sysname> display clock
12:20:28 UTC Thu 06/19/2014
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 Python shell.
Syntax
return
Views
Any view except user view, Tcl configuration view, and Python shell
Predefined user roles
network-admin
network-operator
Usage guidelines
In any view except user view, Tcl configuration view, and Python shell, pressing Ctrl+Z 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 Ten-GigabitEthernet 3/1/1 interface view.
[Sysname-Ten-GigabitEthernet3/1/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
Related commands
abort
return
system-view
Use system-view to enter system view from user view.
Syntax
system-view [ exclusive | immediate | private ]
Views
User view
Predefined user roles
network-admin
network-operator
Parameters
exclusive: Specifies exclusive-mode system view.
immediate: Specifies real-time-mode system view.
private: Specifies private-mode system view.
Usage guidelines
You can enter real-time-mode system view, exclusive-mode system view, or private-mode system view.
· In real-time-mode system view and its lower-level views, settings are written to the running configuration and take effect immediately.
· In exclusive-mode system view, private-mode system view, and their lower-level views, settings are saved to the target configuration, which takes effect after being committed by using the commit command.
Only one user can enter exclusive-mode system view or its lower-level views.
· When a user is in an exclusive-mode view, users in private-mode views cannot commit their target configuration command lines.
· When no user is in an exclusive-mode view, users in private-mode views can commit their respective target configuration command lines. However, only one user in a private-mode view can commit target configuration command lines at a time.
Unless otherwise stated, entering system view refers to entering real-time-mode system view.
If you do not specify any keywords for the command, you enter real-time-mode system view.
Private-mode views and exclusive-mode views have a leading tilde sign (~) in their prompts as compared to their counterpart real-time-mode views.
Examples
# Enter exclusive-mode system view.
<Sysname> system-view exclusive
Info: The current configuration is locked.
~[Sysname]
Related commands
configuration system-view-mode