Basic Configuration Commands

1. Command Line Interface Commands

2. Basic Configuration Management Commands

3. LINE Commands

4. Password Policy Commands

5. File System Commands

6. LICENSING Commands

7. PKG_MGMT Commands

8. CWMP Commands

9. Syslog Commands

10. LED Commands

11. Exception Alarm Commands

12. HTTP Service Commands

13. Patch Upgrade Commands

14. Web Upgrade Commands

Command Reference Command Line Interface Commands

1 Command Line Interface Commands

alias

Use this command to configure a command alias in global configuration mode. Use the no form of
this command to restore the default setting.
alias mode command-alias original-command
no alias mode command-alias

Parameter
Parameter Description
Description
mode Mode of the command represented by the alias
command-alias Command alias
original-command Syntax of the command represented by the alias

Defaults Some commands in user or privileged EXEC mode have default alias.

Command Global configuration mode.

Mode

Usage Guide The following table lists the default alias of the commands in privileged EXEC mode.

Alias Actual Command

h help

p ping

s show

u undebug

un undebug

The default alias cannot be removed by the no alias exec command.

After configuring the alias, you can use a word to replace a command. For example, you can create
an alias to represent the first part of a command, and then type the rest part of the command.
The mode of the command represented by the alias is the command mode existing in the current
system. In the global configuration mode, you can use the alias ? command to list all the modes
under which you can configure alias for commands.
Ruijie(config)# alias ?
aaa-gs AAA server group mode
acl acl configure mode
config globle configure mode
......
The alias also has its help information that is displayed after * in the following format:

1-1
Command Reference Command Line Interface Commands

*command-alias=original-command
For example, in the privileged EXEC mode, the default alias s stands for show. You can enter s? to
query the key words beginning with s and the help information of the alias.
Ruijie#s?
*s=show show start-chat start-terminal-service
If an alias represents more than one word, the command will be displayed in brackets. For example, if
you set sv stand for show version in the privileged EXEC mode, then:
Ruijie#s?
*s=show *sv="show version" show start-chat
start-terminal-service
The alias must begin with the first letter of the command. The first letter of the command cannot be a
space. The space before the command cannot be used as a valid alias.
Ruijie# s?
show start-chat start-terminal-service
The command alias also has its help information. For example, if the alias ia represents ip address in
the interface configuration mode, then:
Ruijie(config-if)#ia ?
A.B.C.D IP address
dhcp IP Address via DHCP
Ruijie(config-if)# ip address
The above help information lists the parameters of ip address and shows the actual command name.
You must enter an entire alias; otherwise it cannot be recognized.
Use the show aliases command to show the aliases setting in the system.

Configuration The following example uses def-route to represent the default route setting of ip route 0.0.0.0 0.0.0.0
Examples 192.168.1.1 in the global configuration mode:
Ruijie# configure terminal
Ruijie(config)# alias config def-route ip route 0.0.0.0 0.0.0.0 192.168.1.1
Ruijie(config)#def-route?
*def-route="ip route 0.0.0.0 0.0.0.0 192.168.1.1"
Ruijie(config)# end
Ruijie# show aliases config
globle configure mode alias:
def-route ip route 0.0.0.0 0.0.0.0
192.168.1.1

Related
Command Description
Commands
show aliases Displays the aliases settings.

Notifications If the length of a command alias exceeds 19 characters, the following message is displayed.

% Overly long alias name truncated after 19 characters.

If the length of an command represented by the alias cannot exceed 255 characters, the following

1-2
Command Reference Command Line Interface Commands

message is displayed.

% Command alias string too long.

Up to 100 command aliases can be configured in each command mode. If the number of alias in a
command mode exceeds 100, the following message is displayed.

% Can't add more than 100 command aliases in single mode.

When the alias failed to be added due to some unexpected reasons such as insufficient memory, the
following message is displayed.
% Adding command alias fail.

Platform N/A
Description

privilege

Use this command to attribute the execution rights of a command to a command level in global
configuration mode. Use the no form of this command to restore the default setting.
privilege mode [ all ] [ level level | reset ] command-string
no privilege mode [ all ] [ level level ] command-string

Parameter
Parameter Description
Description
mode CLI mode of the command to which the execution rights are
attributed.
all Command alias
level level Specifies the execution right levels (0–15) of a command or
sub-commands
reset Restores the command execution rights to its default level
command-string: Command string to be authorized

Defaults N/A

Command Global configuration mode.

Mode

Usage Guide The following table lists some key words that can be authorized by the privilege command in CLI
mode. The number of command modes that can be authorized may vary with different devices. In the
global configuration mode, you can use the privilege ? command to list all CLI command modes that
can be authorized.
Mode Descripton
config Global configuration mode.
exec Privileged EXEC mode
interface Interface configuration mode

1-3
Command Reference Command Line Interface Commands

ip-dhcp-pool DHCP address pool configuration mode

ip-dhcp-pool DHCP address pool configuration mode
keychain KeyChain configuration mode
keychain-key KeyChain-key configuration mode
time range Time range configuration mode

Configuration The following example sets the password of CLI level 1 as test and attribute the reload rights to reset
Examples the device:
Ruijie(config)#privilege exec level 1 reload
You can access the CLI window as level-1 user to usef the reload command:
Ruijie>reload ?
LINE Reason for reload
<cr> You can use the key word all to attribute all sub-commands of reload to level-1 users:
Ruijie(config)# privilege exec all level 1 reload
After the above setting, you can access the CLI window as level-1 user to use all sub commands of the
reload command:
Ruijie>reload ?
LINE Reason for reload
at reload at a specific time/date
cancel cancel pending reload scheme
in reload after a time interval
<cr>

Related
Command Description
Commands
enable secret Sets the CLI-level password.

Platform N/A.
Description

show aliases

Use this command to show all the command aliases or aliases in special command modes.
show aliases [ mode ]

Parameter
Parameter Description
Description
mode Mode of the command represented by the alias.

Defaults N/A.

Command Privileged EXEC mode.

Mode

1-4
Command Reference Command Line Interface Commands

Usage Guide This command displays the configuration of all aliases if no command mode is input.

Configuration The following example displays the command alias in privileged EXEC mode:
Examples Ruijie#show aliases exec
exec mode alias:
h help
p ping
s show
u undebug
un undebug

Related
Command Description
Commands
alias Sets a command alias.

Platform N/A.
Description

1-5
Command Reference Basic Configuration Management Commands

2 Basic Configuration Management Commands

<1-99>

Use this command to restore the suspended Telnet Client session.

<1-99>

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command User EXEC mode

Mode

Usage Guide This command is used to restore the suspended Telnet Client session. Hot keys (ctrl+shift+6 x) are
used to exit the Telnet Client session creation. The <1-99> command is used to restore the session. If
the session is created, you can use the show sessions command to display the session.

Configuration The following example restores the suspended Telnet Client session.
Examples Ruijie# 1

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

banner exec

Use this command to configure a message to welcome the user entering user EXEC mode through
the line. Use the no form of this command to restore the default setting.
banner exec c message c
no banner exec

Parameter
Parameter Description
Description
Separator of the message. Delimiters are not allowed in the
c
message.

2-1
Command Reference Basic Configuration Management Commands

message Contents of the message.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide This command is used to configure the welcome message. The system discards all the characters
next to the terminating symbol.
When you are logging in to the device, the MOTD message is displayed at first, and then the banner
login message. After you have logged in, the EXEC message or the incoming message is displayed.
If it’s a reverse Telnet session, the incoming message is displayed. Otherwise, the EXEC message is
displayed.
The messages are for all lines. If you want to disable display the EXEC message on a specific line,
configure the no exec-banner command on the line.

Configuration The following example configures a welcome message.

Examples Ruijie(config)# banner exec $ Welcome $

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

banner incoming

Use this command to configure a prompt message for reverse Telnet session. Use the no form of this
command to remove the setting.
banner incoming c message c
no banner incoming

Parameter
Parameter Description
Description
Separator of the message. Delimiters are not allowed in the
c
message.
message Contents of the message.

Defaults N/A

Command Global configuration mode

Mode

2-2
Command Reference Basic Configuration Management Commands

Usage Guide This command is used to configure a prompt message. The system discards all the characters next to
the terminating symbol.
When you are logging in to the device, the MOTD message is displayed at first, and then the banner
login message. After you have logged in, the welcome message or the prompt message is displayed.
If it’s a reverse Telnet session, the prompt message is displayed. Otherwise, the welcome message is
displayed.

Configuration The following example configures a prompt message for reverse Telnet session.
Examples Ruijie(config)# banner incoming $ Welcome $

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

banner login

Use this command to configure a login banner. Use no form of this command to r remove the setting.
banner login c message c
no banner login

Parameter
Parameter Description
Description
Separator of the message contained in the login banner. Delimiters
c
are not allowed in the MOTD.
message Contents of the login banner

Defaults N/A

Command Global configuration mode

Mode

Usage Guide This command sets the login banner message, which is displayed at login. The system discards all
the characters next to the terminating symbol.

Configuration The following example configures a login banner.

Examples Ruijie(config)# banner login $ enter your password $

Related
Command Description
Commands

2-3
Command Reference Basic Configuration Management Commands

N/A N/A

Platform
N/A
Description

banner motd

Use this command to set the Message-of-the-Day ( MOTD ) . Use the no form of this command to
remove the setting.
banner [ motd ] c message c
no banner [ motd ]

Parameter
Parameter Description
Description
c Separator of the MOTD. Delimiters are not allowed in the MOTD.
message Contents of an MOTD

Defaults N/A

Command Global configuration mode

Mode

Usage Guide This command sets the MOTD, which is displayed at login. The letters that follow the separator will
be discarded.

Configuration The following example configures the MOTD.

Examples Ruijie(config)# banner motd $ hello,world $

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

banner prompt-timeout

Use this command to configure the prompt-timeout message to notify timeout. Use the no form of this
command to remove the setting.
banner prompt-timeout c message c
no banner prompt-timeout

Parameter Parameter Description

2-4
Command Reference Basic Configuration Management Commands

Description
Separator of the message. Delimiters are not allowed in the
c
message.
message Contents of the message.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide The system discards all the characters next to the terminating symbol.
When authentication times out, the banner prompt-timeout message is displayed.

Configuration The following example configures the prompt-timeout message to notify timeout.
Examples Ruijie(config)# banner exec $ authentication timeout $

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

banner slip-ppp

Use this command to configure the slip-ppp message for the SLIP/PPP session. Use the no form of
this command to remove the setting.
banner slip-ppp c message c
no banner slip-pp

Parameter
Parameter Description
Description
Separator of the message. Delimiters are not allowed in the
c
message.
message Contents of the message.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide This command is used to configure the slip-ppp message for the SLIP/PPP session. The system
discards all the characters next to the terminating symbol.

2-5
Command Reference Basic Configuration Management Commands

When the SLIP/PPP session is created, the slip-ppp message is displayed on the corresponding
terminal.

Configuration The following example configures the banner slip-ppp message for the SLIP/PPP session.
Examples Ruijie(config)# banner slip-ppp $ Welcome $

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

configure

Use this command to enter global configuration mode.

configure [ terminal ]

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example enters global configuration mode.

Examples Ruijie# configure
Ruijie(config)#

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

2-6
Command Reference Basic Configuration Management Commands

disable

Use this command to switch from privileged EXEC mode to user EXEC mode or lower the privilege
level.
disable [ privilege-level ]

Parameter
Parameter Description
Description
privilege-level Privilege level

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide Use this command to switch to user EXEC mode from privileged EXEC mode. If a new privilege level
is added, the current privilege level will be lowered.

The privilege level that follows the disable command must be lower than the current level.

Configuration The following example lowers the current privilege level of the device to level 10.
Examples Ruijie# disable 10

Related
Command Description
Commands
Moves from user EXEC mode enter to
enable privileged EXEC mode or reaches a higher
level of authority.

Platform
N/A
Description

disconnect

Use this command to disconnect the Telnet Client session.

disconnect session-id

Parameter
Parameter Description
Description
session-id Telnet Client session ID.

Defaults N/A

2-7
Command Reference Basic Configuration Management Commands

Command User EXEC mode

Mode

Usage Guide This command is used to disconnect the Telnet Client session by setting the session ID.

Configuration The following example disconnects the Telnet Client session by setting the session ID.
Examples Ruijie# disconnect 1

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

do telnet

Use this command to login to Telnet server.

do telnet [ oob ] host [ port ] [ /source { ip A.B.C.D | ipv6 X:X:X:X::X | interface interface-name } ]

Parameter
Parameter Description
Description
Connects to Telnet server through oob channel. This parameter is
oob
available only when the device has a MGMT port.
host IPv4 or host name of Telnet server.
port Configures TCP port ID. The default is 23.
/source Specifies source IP or source port for Telnet client.
ip A.B.C.D Specifies source IPv4 address for Telnet client.
ipv6 X:X:X:X::X Specifies source IPv6 address for Telnet client.
interface interface-name Specifies source port for Telnet client.

Defaults N/A

Command User EXEC mode/Privileged EXEC mode/Interface configuration mode

Mode

Usage Guide N/A

Configuration
Examples

Related
Command Description
Commands

2-8
Command Reference Basic Configuration Management Commands

N/A N/A

Platform MGMT ports are supported on NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2 and
Description NBR6215-E but not on NBR6120-E.

enable

Use this command to enter privileged EXEC mode.

enable

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command N/A
Mode

Usage Guide N/A

Configuration N/A
Examples

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

enable password

Use this command to configure passwords for different privilege levels. Use the no form of this
command to restore the default setting.
enable password [ level level ] { password | [ 0 | 7 ] encrypted-password }
no enable password [ level leve l ]

Parameter
Parameter Description
Description
password Password for the user to enter the EXEC configuration layer
level User's level.
0|7 Password encryption type, "0" for no encryption, "7" for simple

2-9
Command Reference Basic Configuration Management Commands

encryption
(Optional) Ruijie’s private algorithm will be used for password
encryption. If the password type is 0, the password is in plain text. If
the type is 7, the password is encrypted by a Ruijie device.
encrypted-password Password text.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide No encryption is required in general. The encryption type must be specified for copying and pasting a
encrypted password for the device.
A valid password is defined as follows:

 Consists of 1-26 upper/lower case letters and numbers

 Leading spaces are allowed but usually ignored. Spaces in between or at the end are regarded
as part of the password.

If an encryption type is specified and a plaintext password is entered, you cannot enter
privileged EXEC mode. A lost password that has been encrypted using any method cannot be
restored. In this case, you can only reconfigure the device password.

Configuration The following example configures the password as pw10.

Examples Ruijie(config)# enable password pw10

Related
Command Description
Commands
enable secret Sets the security password

Platform
N/A
Description
enable secret Sets the security password

enable secret

Use this command to configure a security password for different privilege levels. Use the no form of
this command to restore the default setting.
enable secret [ level level ] { secret | [ 0 | 5 ] encrypted-secret }
no enable secret [ level level ]

Parameter Parameter Description

2-10
Command Reference Basic Configuration Management Commands

Description
secret Password for the user to enter the EXEC configuration layer
level User's level.
Password encryption type, "0" for no encryption, "5" for security
0|5
encryption
encrypted-password Password text

Defaults N/A

Command Global configuration mode

Mode

Usage Guide A password comes under two categories: "password" and "security". "Password" indicates a simple
password, which can be set only for level 15. "Security" means a security password, which can be set
for levels 0-15. If both types of passwords coexist in the system, no "password" type is allowed. If a
"password" type password is set for a level other than 15, the system gives an alert and the password
is automatically converted into a "security" password. If a "password" type password is set for level 15
and the same as a "security" password, an alert is given. The password must be encrypted, with
simple encryption for "password" type passwords and security encryption for "security" type
passwords.

Configuration The following example configures the security password as pw10.

Examples Ruijie(config)# enable secret 0 pw10

Related
Command Description
Commands
enable password Sets passwords for different privilege levels.

Platform
N/A
Description

enable service

Use this command to enable or disable a specified service such as SSH Server/Telnet Server/Web
Server/SNMP Agent.
enable service { ssh-sesrver | telnet-server | web-server [ http | https | all ] | snmp-agent }

Parameter
Parameter Description
Description
ssh-server Enables SSH Server.
telnet-server Enables Telnet Server.
web-server [ http | https |
Enables HTTP Server.
all ]

2-11
Command Reference Basic Configuration Management Commands

snmp-agent Enables SNMP Agent.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide Use this command to enable or disable a specified service. Use the no enable service command to
disable the specified service.

The enable service web-server command is followed by three optional keywords: [http | https |
all]. If the command is followed by no keyword or by all, the command enables http and https
services. Followed by http, the command enables http service only. Followed by https, the
command enables https service only.

Configuration The following example enables the SSH Server.

Examples Ruijie(Config)# enable service ssh-sesrver

Related
Command Description
Commands
Displays the service status in the current
show service
system.

Platform
N/A
Description

end

Use this command to return to privileged EXEC mode.

end

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command All modes except privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example returns to privileged EXEC mode.

Examples Ruijie#con

2-12
Command Reference Basic Configuration Management Commands

Enter configuration commands, one per line. End with CNTL/Z.

Ruijie(config)#line vty 0
Ruijie(config-line)#end
*May 20 09:49:38: %SYS-5-CONFIG_I: Configured from console by console
Ruijie#

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

exec-banner

Use this command to enable display of the EXEC message on a specific line. Use the no form of this
command to restore the default setting.
exec-banner
no exec-banner

Parameter
Parameter Description
Description
N/A N/A

Defaults The EXEC message is displayed on all lines by default.

Command Line configuration mode

Mode

Usage Guide After you configure the banner exec and the banner motd commands, the EXEC and the MOTD
messages are displayed on all lines by default. If you want to disable display of the EXEC and the
MOTD messages on a specific line, configure the no form of this command on the line.

This command does not work for the banner incoming message. If you configure the banner
incoming command, the banner incoming message is displayed on all reverse Telnet sessions
and the display cannot be disabled on a specific line.

Configuration The following example disables display of the EXEC message on line VTY 1.
Examples Ruijie(config)# line vty 1
Ruijie(config-line)no exec-banner

Related
Command Description
Commands
N/A N/A

2-13
Command Reference Basic Configuration Management Commands

Platform
N/A
Description

exec-timeout

Use this command to configure connection timeout for this device in LINE mode. Use the no form of
this command to restore the default setting and the connection never expires.
exec-timeout minutes [ seconds ]
no exec-timeout

Parameter
Parameter Description
Description
minutes Timeout in minutes.
seconds (Optional) Timeout in minutes

Defaults The default is 10 minutes.

Command Line configuration mode

Mode

Usage Guide If there is no input or output for this connection within a specified time, this connection will expire, and
this LINE will be restored to the free status.

Configuration The following example sets the connection timeout to 5’30’’.

Examples Ruijie(config)# line vty 0

Ruijie(config-line)#exec-timeout 5 30

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

exit

Use this command to return to the upper configuration mode.

exit

Parameter
Parameter Description
Description

2-14
Command Reference Basic Configuration Management Commands

N/A N/A

Defaults N/A

Command All configuration modes

Mode

Usage Guide N/A

Configuration The following example returns to the upper configuration mode.

Examples Ruijie#con
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#line vty 0
Ruijie(config-line)#end
*May 20 09:49:38: %SYS-5-CONFIG_I: Configured from console by console
Ruijie#con
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#line vty 0
Ruijie(config-line)#exit
Ruijie(config)#exit
*May 20 09:51:48: %SYS-5-CONFIG_I: Configured from console by console
Ruijie#exit

Press RETURN to get started

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

help

Use this command to display the help information.

help

Parameter
Parameter Description
Description
N/A N/A

Defaults Any mode

2-15
Command Reference Basic Configuration Management Commands

Command
Mode

Usage Guide This command is used to display brief information about the help system. You can use ”?” to display
all commands or a specified command with its parameters.

Configuration The following example displays brief information about the help system.
Examples Ruijie#help
Help may be requested at any point in a command by entering
a question mark '?'. If nothing matches, the help list will
be empty and you must backup until entering a '?' shows the
available options.
Two styles of help are provided:
1. Full help is available when you are ready to enter a
command argument (e.g. 'show ?') and describes each possible
argument.
2. Partial help is provided when an abbreviated argument is entered
and you want to know what arguments match the input
(e.g. 'show pr?'.)
The following example displays all available commands in interface configuration mode.
Ruijie(config-if-GigabitEthernet 0/0)# ?
arp ARP interface subcommands
arp-learning Dynamic arp learning ability
bandwidth Set bandwidth informational parameter
carrier-delay Specify delay for interface transitions
crypto Apply crypto command
dampening Enable event dampening
default Set a command to its defaults
description Interface specific description
dhcp-discover DHCP client try to discover server
dldp Exec data link detection command
dns-proxy Dns proxy enable
do To run exec commands in config mode
duplex Configure duplex operation
end Exit from interface configuration mode
exit Exit from interface configuration mode
help Description of the interactive help system
ip Interface Internet Protocol config commands
ipv6 IPv6 information
load-interval Specify interval for load calculation for an interface
logging Configure logging for interface
mac-address Set mac-address
mtu Set the interface Maximum Transmission Unit (MTU)
nat64 NAT64 interface config

2-16
Command Reference Basic Configuration Management Commands

nexthop Configure interface gateway

nexthop6 Configure interface gateway v6
no Negate a command or set its defaults
ntp Configure NTP
port-group Aggregateport/port bundling configuration
pppoe-server Pppoe-server interface subcommands
proxy-arp Set parameters for proxy ARP
reverse-path Enable reverse path limite
show Show running system information
shutdown Shutdown the selected interface
snmp Modify SNMP interface parameters
speed Configure speed operation
vlan-terminal Config vlan-terminal
vrrp VRRP interface subcommands
The following example displays the parameters of a specified command.
Ruijie(config)#access-list 1 permit ?
A.B.C.D Source address
any Any source host
host A single source host

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

hostname

Use this command to specify or modify the hostname of a device.

hostname name

Parameter
Parameter Description
Description
name Device hostname, string, number or hyphen, up to 63 characters.

Defaults The default is Ruijie.

Command Global configuration mode

Mode

Usage Guide This hostname is mainly used to identify the device and is taken as the username for the local device
during dialup and CHAP authentication.

2-17
Command Reference Basic Configuration Management Commands

Configuration The following example configures the hostname of the device as BeiJingAgenda.
Examples Ruijie(config)# hostname BeiJingAgenda
BeiJingAgenda(config)#

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

ip telnet source-interface

Use this command to configure the IP address of an interface as the source address for Telnet
connection.
ip telnet source-interface interface-name

Parameter
Parameter Description
Description
Configures the IP address of the interface as the source address for
interface-name
Telnet connection.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide This command is used to specify the IP address of an interface as the source address for global
Telnet connetction. When using the telnet command to log in a Telnet server, apply the global setting
if no source interface or source address is specified. Use the no ip telnet source-interface
command to restore it to the default setting.

Configuration The following example configures the IP address of the Loopback1 interface as the source address
Examples for global Telnet connection.
Ruijie(Config)# ip telnet source-interface Loopback 1

Related
Command Description
Commands
telnet Logs in a Telnet server.

Platform
N/A
Description

2-18
Command Reference Basic Configuration Management Commands

lock

Use this command to set a temporary password for the terminal.

lock

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide You can lock the terminal interface and maintain the session continuity to prevent access to the
interface by setting a temporary password. Take the following steps to lock the terminal interface:
 Enter the lock command, and the system will prompt you for a password:
 Enter the password, which can be any character string. The system will prompt you to confirm
the password, clear the screen, and display the "Locked" information.
 To access the terminal, enter the preset temporary password.
 To lock the terminal, run the lockable command in line configuration mode and enable terminal
locking in the corresponding line.

Configuration The following example locks a terminal interface.

Examples Ruijie(config-line)# lockable
Ruijie(config-line)# end
Ruijie# lock
Password: <password>
Again: <password>
Locked
Password: <password>
Ruijie#

Related
Command Description
Commands
lockable Supports terminal locking in the line.

Platform
N/A
Description

lockable

Use this command to support the lock command at the terminal. Use the no form of this command to

2-19
Command Reference Basic Configuration Management Commands

restore the default setting.

lockable
no lockable

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command This function is disabled by default.

Mode

Usage Guide This command is used to lock a terminal interface in the corresponding line. To lock the terminal, run
the lock command in EXEC mode.

Configuration The following example enables terminal locking at the console port and locks the console.
Examples Ruijie(config)# line console 0
Ruijie(config-line)# lockable
Ruijie(config-line)# end
Ruijie# lock
Password: <password>
Again: <password>
Locked
Password: <password>

Related
Command Description
Commands
lock Locks the terminal.

Platform
N/A
Description

login

Use this command to enable simple login password authentication on the interface if AAA is disabled.
Use the no form of this command to restore the default setting.
login
no login

Parameter
Parameter Description
Description
N/A N/A

2-20
Command Reference Basic Configuration Management Commands

Defaults N/A

Command Line configuration mode

Mode

Usage Guide If the AAA security server is inactive, this command enables simple password authentication at login.
The password is configured for a VTY or console interface.

Configuration The following example sets a login password authentication on VTY..

Examples Ruijie(config)# no aaa new-model
Ruijie(config)# line vty 0
Ruijie(config-line)# password 0 normatest
Ruijie(config-line)# login

Related
Command Description
Commands
password Configures the line login password

Platform
N/A
Description

login access non-aaa

Use this command to configure non-AAA authentication on line when AAA is enabled. Use the no
form of this command to restore the default setting.
login access non-aaa
no login access non-aaa

Parameter
Parameter Description
Description
N/A N/A

Defaults This function is disabled by default.

Command Global configuration mode

Mode

Usage Guide N/A

Configuration The following example configures VTY line authentication with AAA enabled.
Examples Ruijie(config)#log access non-aaa
Ruijie(config)#aaa new-model
Ruijie(config)#line vty 0 4

2-21
Command Reference Basic Configuration Management Commands

Ruijie(config-line)#login local
Ruijie(config-line)#

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

login authentication

If the AAA is enabled, login authentication must be performed on the AAA server. Use this command
to associate login authentication method list. Use the no form of this command to restore the default
setting.
login authentication { default | list-name }
no login authentication { default | list-name }

Parameter
Parameter Description
Description
default Name of the default authentication method list
list-name Name of the method list

Defaults N/A

Command Line configuration mode

Mode

Usage Guide If the AAA security server is active, this command is used for login authentication using the specified
method list.

Configuration The following example associates the method list on VTY and perform login authentication on a
Examples radius server.
Ruijie(config)# aaa new-model
Ruijie(config)# aaa authentication login default radius
Ruijie(config)# line vty 0
Ruijie(config-line)# login authentication default

Related
Command Description
Commands
aaa new-model Enables the AAA security service.
aaa authentication login Configures the login authentication method list.

2-22
Command Reference Basic Configuration Management Commands

Platform
N/A
Description

login local

Use this command to enable local user authentication on the interface if AAA is disabled. Use the no
form of this command to restore the default setting.
login local
no login local

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Line configuration mode

Mode

Usage Guide If the AAA security server is inactive, this command is used for local user login authentication. The
user is allowed to use the username command.

Configuration The following example sets local user authentication on VTY.

Examples Ruijie(config)# no aaa new-model
Ruijie(config)# username test password 0 test
Ruijie(config)# line vty 0
Ruijie(config-line)# login local

Related
Command Description
Commands
username Configures local user information.

Platform
N/A
Description

motd-banner

Use this command to enable display of the MOTD message on a specified line. Use the no form of
this command to restore the default setting.
motd-banner
no motd-banner

Parameter Parameter Description

2-23
Command Reference Basic Configuration Management Commands

Description
N/A N/A

Defaults The MOTD message is displayed on all lines by default.

Command Line configuration mode

Mode

Usage Guide After you configure the banner exec and the banner motd commands, the EXEC and the MOTD
messages are displayed on all lines by default. If you want to disable display of the EXEC and the
MOTD messages on a specific line, configure the no form of this command on the line.

This command does not work for the incoming message. If you configure the banner incoming
command, the banner incoming message is displayed on all reverse Telnet sessions and the
display cannot be disabled on a specific line.

Configuration The following example disables display of the MOTD message on VTY 1.
Examples Ruijie(config)# line vty 1
Ruijie(config-line)no motd-banner

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

password

Use this command to configure a password for line login, run the password command. Use the no
form of this command to restore the default setting.
password { password | [ 0 | 7 ] encrypted-password }
no password

Parameter
Parameter Description
Description
password Password for remote line login
Password encryption type, "0" for no encryption, "7" for simple
encryption
0|7 (Optional) Ruijie’s private algorithm will be used for password
encryption. If the password type is 0, the password is in plain text. If
the type is 7, the password is encrypted by a Ruijie device.
encrypted-password Password text

2-24
Command Reference Basic Configuration Management Commands

Defaults N/A

Command Line configuration mode

Mode

Usage Guide This command is used to configure a authentication password for remote line login.

Configuration The following example configures the line login password as "red".
Examples Ruijie(config)# line vty 0
Ruijie(config-line)# password red

Related
Command Description
Commands
Moves from user EXEC mode to privileged
login EXEC mode or enables a higher level of
authority.

Platform
N/A
Description

prompt

Use this command to set the prompt command. Use the no form of this command to restore the
default setting.
prompt string
no prompt string

Parameter
Parameter Description
Description
string Character string of the prompt command, containing up to 32 letters.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide If no prompt string is configured, the system name applies and varies with the system name. The
prompt command is valid only in EXEC mode.

Configuration The following example sets the prompt string to rgnos.

Examples Ruijie(config)# prompt rgnos
Ruijie(config)# end
RGOS

2-25
Command Reference Basic Configuration Management Commands

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

secret

Use this command to set a password encrypted by irreversible MD5 for line login. Use the no form of
this command to restore the default setting.
secret { [ 0 ] password | 5 encrypted-secret }
no secret

Parameter
Parameter Description
Description
(Optional) sets the plaintext password text and encrypts it with
0
irreversible MD5 after configuration.
password Sets the password plaintext, a string ranging from 1 to 25 characters.
Sets the password text encrypted by irreversible MD5 and saves it as
5 encrypted-secret
the encrypted password after configuration.

Defaults N/A

Command Line configuration mode

mode

Usage Guide This command is used to set a password encrypted by irreversible MD5 that is authenticated by a
remote user through line login.

If the specified encryption type is 5, the logical length of the cipher text to be entered must be 24
and the 1st, 3rd and 8th characters of the password text must be $.
In general, the encryption type does not need to be specified as 5 except when the encrypted
password is copied and pasted.
Line mode allows configuration of both “password” and “secret” types passwords at the same
time. When the two passwords are the same, the system will send alert notification but the
configuration will be permitted. When the system is configured with the two passwords, if the
user enters a password that does not match the “secret” type password, it will not continue to
match the “password” type password and login fails, enhancing security for the system
password.

Configuration The following example sets the password encrypted by irreversible MD5 for line login to vty0.
Examples Ruijie(config)# line vty 0
Ruijie(config-line)# secret vty0

2-26
Command Reference Basic Configuration Management Commands

The following displays the encryption outcome by running the show command.
secret 5 $1$X834$wvx6y794uAD8svzD

Related
Command Description
Commands
login Sets simple password authentication on the
interface as the login authentication mode

Platform N/A
Description

session-timeout

Use this command to configure the session timeout for a remote terminal. Use the no form of this
command to restore the default setting and the session never expires.
session-timeout minutes [ output ]
no session-timeout

Parameter
Parameter Description
Description
minutes Timeout in minutes.
Regards data output as the input to determine whether the session
output
expires.

Defaults The default timeout is 0.

Command Line configuration mode

Mode

Usage Guide If no input or output in current LINE mode is found on the remote terminal for the session within a
specified time, this connection will expire, and this LINE will be restored to the free status.

Configuration The following example specifies the timeout as 5 minutes.

Examples Ruijie(config-line)#exec-timeout 5 output

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

2-27
Command Reference Basic Configuration Management Commands

show mac

Use this command to display MAC address information about neighboring devices.
show mac

Parameter
Parameter Description
Description

Defaults N/A

Command Privileged EXEC mode

Mode

Default Level 14

Usage Guide This command is used to display MAC address information about neighboring devices for topology
discovery.

Configuration The following example displays MAC address information about neighboring devices.
Examples Ruijie# show mac

Vlan Mac Address Type Interface Port Age

4088 001a.a91f.e71f Dynamic GigabitEthernet0/0 0 ----

4089 002a.a91f.e72f Dynamic GigabitEthernet0/0 0 ----

Field description
Field Description
Vlan VLAN ID.
Mac Address Device MAC address.
Type MAC address entry type. Only dynamic MAC address entries are displayed in
the list.
Interface Device interface that obtains this MAC address.
Port Internal port number.
Age Aging time of the MAC address entry. ---- indicates that the device does not
support this parameter or no aging time is available.
Verification N/A

Notifications N/A

Common
N/A
Errors

2-28
Command Reference Basic Configuration Management Commands

Platform
N/A
Description

show debugging

Use this command to display debugging state.

show debugging

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example displays debugging state.

Examples Ruijie#show debugging
control debug : off.
status debug : off.
arl debug : off.
vlan debug : off.
mirror debug : off.
clear debug : off.
mib debug : off.
phy debug : off.
print debug : off.
terminal debug: off.
subintf debug : off.
Timer debug : off.
Lsm debug : off.
Hot-back : off.
File debug : off.
Genlink : off.
Efmp : off.
Switch : off.
Rx train print: off.
Pkt filter : off.
Debug ether pkt filter sip 0.0.0.0 smac 0000.0000.0000 dip 0.0.0.0 dmac
0000.0000.0000 counter 0

2-29
Command Reference Basic Configuration Management Commands

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

show hostname

Use this command to display the hostname of a device.

show hostname

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example displays the hostname of a device.

Examples Ruijie#show hostname
Ruijie
Ruijie#

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

show line

Use this command to display the configuration of a line.

show line { console line-num | vty line-num | line-num }

Parameter
Parameter Description
Description

2-30
Command Reference Basic Configuration Management Commands

console Display s the configuration of a console line.

vty Display s the configuration of a vty line.
line-num Number of the line.

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide This command displays the configuration of a line.

Configuration The following example displays the configuration of a console port.

Examples Ruijie# show line console 0
CON Type speed Overruns
* 0 CON 9600 45927
Line 0, Location: "", Type: "vt100"
Length: 24 lines, Width: 79 columns
Special Chars: Escape Disconnect Activation
^^x none ^M
Timeouts: Idle EXEC Idle Session
never never
History is enabled, history size is 10.
Total input: 53564 bytes
Total output: 395756 bytes
Data overflow: 27697 bytes
stop rx interrupt: 0 times
Field Description
CON CON refers to a console. 0 indicates the number of terminated line. If
there is an asterisk (*) before the number of terminated line, it means
the line is active.
Type Indicates terminal types, including CON and VTY.
speed Indicates asynchronous speed.
Overruns Indicates statistics on overrun errors received by the driver.
Line 0 Indicates the number of a VTY line.
Location: "" Indicates line location.
Type: "vt100" Indicates the line standard that is compatible with the terminal.
Special Chars Indicates the special characters, including Escape characters,
Disconnect characters and Activation characters.
Timeouts Indicates time-out period. Never: never time out.
History Indicates the switch for history records and the maximum number of
the history records.
Total input Indicates the statistics of data received from the drive.
Total output Indicates the statistics of data sent to the drive.
Data overflow Indicates the statistics of the received data overflow.

2-31
Command Reference Basic Configuration Management Commands

stop rx interrupt Indicates the statistics of RX interrupts.

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

show reload

Use this command to display the system restart settings.

show reload

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide This command is used to display the restart settings of the system.

Configuration The following example displays the restart settings of the system.
Examples Ruijie# show reload
Reload scheduled in 595 seconds.
At 2003-12-29 11:37:42
Reload reason: test.

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

show running-config

Use this command to display how the current device system is configured..
show running-config

2-32
Command Reference Basic Configuration Management Commands

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration N/A
Examples

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

show service

Use this command to display the service status.

show service

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example displays whether the service is enabled or disabled.
Examples Ruijie# show service
web-server : disabled
web-server(https): disabled
snmp-agent : enabled
ssh-server : enabled

2-33
Command Reference Basic Configuration Management Commands

telnet-server : disabled

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

show sessions

Use this command to display the Telnet Client session information.

show sessions

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command User EXEC mode

Mode

Usage Guide Telnet Client session information includes the VTY number and the server IP address.

Configuration The following example displays the Telnet Client session information.
Examples Ruijie#show sessions
Conn Address
*1 127.0.0.1
*2 192.168.21.122

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

show startup-config

Use this command to display the device configuration stored in the Non Volatile Random Access
Memory (NVRAM).
show startup-config

2-34
Command Reference Basic Configuration Management Commands

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide The device configuration stored in the NVRAM is executed while the device is starting.
On a device that does not support boot config, startup-config is contained in the default
configuration file /config.text in the built-in flash memory.
On a device that supports boot config, configure startup-config as follows:
If you have specified a boot configuration file using the boot config command and the file exists,
startup-config is stored in the specified configuration file.
If the boot configuration file you have specified using the boot config command does not exist or you
have not specified a boot configuration file using the command, startup-config is contained in
/config.text in the built-in flash memory.

Configuration N/A
Examples

Related
Command Description
Commands
boot config Sets the name of the boot configuration file.

Platform
N/A
Description

show this

Use this command to display effective configuration in the current mode.

show this

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command All modes.

Mode

2-35
Command Reference Basic Configuration Management Commands

Usage Guide The configuration in the following range modes cannot be displayed. If the show this command is
run, the outcome is NULL.
1. Use the line first-line last-line command to configure lines in a continuous group and enter line
configuration mode.
2. Use the interface range command to configure interfaces and enter interface range
configuration mode.

Configuration The following example displayS effective configuration on interface GigabitEthernet 0/1.
Examples Ruijie (config)# interface GigabitEthernet 0/1
Ruijie (config-if-GigabitEthernet 0/1)# show this
Building configuration...
!
spanning-tree link-type point-to-point
spanning-tree mst 0 port-priority 0
!
end
Ruijie (config-if-GigabitEthernet 0/1)#

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

speed

Use this command to set the speed at which the terminal transmits packets. Use the no form of this
command to restore the default setting.
speed speed
no speed

Parameter
Parameter Description
Description
Transmission rate (bps) on the terminal. For serial ports, optional
speed rates include 9600, 19200, 38400, 57600, and 115200 bps. The
default rate is 9600 bps.

Defaults The default is 9600.

Command Global configuration mode

Mode

2-36
Command Reference Basic Configuration Management Commands

Usage Guide This command is used to set the speed at which the terminal transmits packets.

Configuration The following example sets the rate of the serial port to 57600 bps.
Examples Ruijie(config)# line console 0
Ruijie(config-line)# speed 57600

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

telnet

Use this command to log in a server that supports telnet connection.

telnet host [ port ] [ /source { ip A.B.C.D | ipv6 X:X:X:X::X | interface interface-name } ]

Parameter
Parameter Description
Description
Host The IP address of the host or host name you want to log in.
Port Selects the TCP port number for login, 23 by default.
Specifies the source IP address or source interface used by the
/source
Telnet client.
ip A.B.C.D Specifies the source IPv4 address used by the Telnet client.
ipv6 X:X:X:X::X Specifies source IPv6 address for Telnet client.
interface interface-name Specifies the source interface used by the Telnet client.

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration Ruijie# telnet 1.1.1.1

Examples

Related
Command Description
Commands
Specifies the IP address of the interface as the
ip telnet source-interface
source address for Telnet connection.

2-37
Command Reference Basic Configuration Management Commands

Displays the currently established Telnet

show sessions
sessions.
exit Exits current connection.

Platform MGMT ports are supported on NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2 and
Description NBR6215-E but not on NBR6120-E.

username

Use this command to set a local username and optional authorization information.. Use the no form
of this command to restore the default setting.
username name [ login mode { aux | console | ssh | telnet } ] [ online amount number ]
[ permission oper-mode path ] [ privilege privilege-level ] [ reject remote-login ] [ web-auth ]
[ pwd-modify ] [ nopassword | password [ 0 | 7 ] text-string ]

no username name
Parameter
Parameter Description
Description
name Username
login mode Sets the login mode.
aux Sets the login mode to aux.
console Sets the login mode to console.
ssh Sets the login mode to ssh.
telnet Sets the login mode to telnet.
online amount number Sets the amount of users online simultaneously.
Sets the permission on the specified file. op-mode refers to the
permission oper-mode path
operation mode and path to the file or the directory path.
privilege privilege-level Sets the privilege level, in the range from 0 to 15.
reject remote-login Confines the account to remote login.
web-auth Confines the account to web authentication.
Allows the web authentication user of this account to change the
pwd-modify
password. It works only when the web-auth command is configured.
nopassword The account is not configured with a password.
If the password type is 0, the password is in plain text. If the type is 7,
password [ 0 | 7 ] text-string
the password is encrypted. The password is in plain text by default.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide This command is used to establish a local user database for authentication.

If encryption type is 7, the cipher text you enter should contain seven characters to be valid.

2-38
Command Reference Basic Configuration Management Commands

In general, do not set the entryption type 7.

Instead, specify the type of encryption as 7 only when the encrypted password is copied and
pasted.

Configuration The following example configures a username and password and binds the user to level 15.
Examples Ruijie(config)# username test privilege 15 password 0 pw15
The following example configures the username and password exclusive to web authentication.
Ruijie(config)# username user1 web-auth password 0 pw
The following example configures user test with read and write permissions on all files and
directories.
Ruijie(config)# username test permission rw /
The following example configures user test with read, write and execute permissions on all files and
directories except the confix.text file.
Ruijie(config)# username test permission n /config.text
Ruijie(config)# username test permission rwx /

Related
Command Description
Commands
login local Enables local authentication

Platform
N/A
Description

username export

Use this command to export user information to the file.

username export filename

Parameter
Parameter Description
Description
filename The file name.

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide This command is used to export user information to the file.

Configuration The following example exports user information to the file.

Examples Ruijie# username export user.csv

Related Command Description

2-39
Command Reference Basic Configuration Management Commands

Commands
N/A N/A

Platform
N/A
Description

username import

Use this command to import user information from the file.

username import filename

Parameter
Parameter Description
Description
filename The file name.

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide This command is used to import user information from the file.

Configuration The following example imports user information from the file.
Examples Ruijie# username import user.csv

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

write

Use this command to save running-config at a specified location.

write [ memory | terminal ]

Parameter
Parameter Description
Description
Writes the system configuration (running-config) into NVRAM, which
memory
is equivalent to copy running-config startup-config.
Displays the system configuration, which is equivalent to show
terminal
running-config.

2-40
Command Reference Basic Configuration Management Commands

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide The system automatically creates the specified file and writes it into system configuration if the device
that stores the file exists;
The system will ask you whether to save the current configuration in default boot configuration file
/config.text and perform an action as required if the device that stores the file does not exist possibly
because the boot configuration file is stored on a removable storage device such as USB drive and
the device has not been loaded when you run the write [ memory ] command.

Configuration The following example saves running-config at a specified location.

Examples Ruijie# write
Building configuration...
[OK]

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

2-41
Command Reference LINE Commands

3 LINE Commands

access-class

Use this command to control login into the terminal through IPv4 ACL. Use the no form of this
command to restore the default setting.
access-class { access-list-number | access-list-name } { in | out }
no access-class { access-list-number | access-list-name } { in | out }

Parameter
Parameter Description
Description
Specifies the ACL number. Standard IP ACL number is from 1 to 99
access-list-number and from 1300 to 1999. Extended IP ACL number is from 100 to 199
and from 2000 to 2699.
access-list-name Specifies the ACL name.
in Filters the incoming connections.
out Filters the outgoing connections.

Defaults N/A

Command Line configuration mode

Mode

Usage Guide N/A

Configuration The following example uses ACL 20 to filter the incoming connections in line VTY 0 5.
Examples Ruijie(config)# line vty 0 5
Ruijie(config-line)access-list 20 in

The following example uses the ACL named “test” to filter the outgoing connections in line VTY 6 7.
Ruijie(config)# line vty 6 7
Ruijie(config-line)access-list test out

Related
Command Description
Commands
show running Displays status information

Platform N/A
Description

3-1
Command Reference LINE Commands

accounting commands

Use this command to enable command accounting in the line. Use the no form of this command to
restore the default setting.
accounting commands level { default | list-name }
no accounting commands level

Parameter
Parameter Description
Description
Command level ranging from 0 to 15. The command of this level is
level
accounted when it is executed.
default Default authorization list name.
list-name Optional list name.

Defaults This function is disabled by default.

Command Line configuration mode

Mode

Usage Guide This function is used together with AAA authorization. Configure AAA command accounting first, and
then apply it on the line.

Configuration The following example enables command accounting in line VTY 1 and sets the command level to 15.
Examples Ruijie(config)# aaa new-model
Ruijie(config)# aaa accounting commands 15 default start-stop group tacacs+
Ruijie(config)# line vty 1
Ruijie(config-line)# accounting commands 15 default

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

accounting exec

Use this command to enable user access accounting in the line. Use the no form of this command to
restore the default setting.
accounting exec { default | list-name }
no accounting exec

Parameter Parameter Description

3-2
Command Reference LINE Commands

Description
default Default authorization list name.
list-name Optional list name.

Defaults This function is disabled by default.

Command Line configuration mode

Mode

Usage Guide This function is used together with AAA authorization. Configure AAA EXEC accounting first, and
then apply it on the line.

Configuration The following example enables user access accounting in line VTY 1.
Examples Ruijie(config)# aaa new-model
Ruijie(config)# aaa accounting exec default start-stop group radius
Ruijie(config)# line vty 1
Ruijie(config-line)# accounting exec default

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

authorization commands

Use this command to enable authorization on commands, Use the no form of this command to
restore the default setting.
authorization commands level { default | list-name }
no authorization commands level

Parameter
Parameter Description
Description
Command level ranging from 0 to 15. The command of this level is
level
executed after authorization is performed.
default Default authorization list name,
list-name Optional list name.

Defaults This function is disabled by default.

Command Line configuration mode

Mode

3-3
Command Reference LINE Commands

Usage Guide This function is used together with AAA authorization. Configure AAA authorization first, and then
apply it on the line.

Configuration The following example enables authorization on commands of level 15 in line VTY 1.
Examples Ruijie(config)# aaa new-model
Ruijie(config)# aaa authorization commands 15 default group tacacs+
Ruijie(config)# line vty 1
Ruijie(config-line)# authorization commands 15 default

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

authorization exec

Use this command to enable EXEC authorization for the line. Use the no form of this command to
restore the default setting.
authorization { default | list-name }
no authorization exec

Parameter
Parameter Description
Description
default Default authorization list name,
list-name Optional list name.

Defaults This function is disabled by default,

Command Line configuration mode

Mode

Usage Guide This function is used together with AAA authorization. Configure AAA EXEC authorization first, and
then apply it on the line.

Configuration The following example performs EXEC authorization to line VTY 1.

Examples Ruijie(config)# aaa new-model
Ruijie(config)# aaa authorization exec default group radius
Ruijie(config)# line vty 1
Ruijie(config-line)# authorization exec default

3-4
Command Reference LINE Commands

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

clear line

Use this command to clear connection status of the line.

clear line { console line-num | vty line-num | line-num }

Parameter
Parameter Description
Description
console Clears connection status of the console line.
vty Clears connection status of the virtual terminal line.
line-num Specifies the line to be cleared.

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide This command is used to clear connection status of the line and restore the line to the unoccupied
status to create new connections.

Configuration The following example clears connection status of line VTY 13. The connected session on the client
Examples (such as Telnet and SSH) in the line is disconnected immediately.
Ruijie# clear line vty 13

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

disconnect-character

Use this command to set the hot key that disconnects the terminal service connection. Use the no
form of this command to restore the default setting.
disconnect-character ascii-value
no disconnect-character

3-5
Command Reference LINE Commands

Parameter
Parameter Description
Description
ascii-value ASCII decimal value of the hot key that disconnects the terminal
service connection, in the range from 0 to 255.

Defaults The default hot key is Ctrl+D and the ASCII decimal value is 0x04.

Command Line configuration mode

Mode

Usage Guide This command is used to set the hot key that disconnects the terminal service connection. The hot
key cannot be the commonly used ASCII node such as characters ranging from a to z, from A to Z or
numbers ranging from 0 to 9. Otherwise, the terminal service cannot operate properly.

Configuration The following example sets the hot key that disconnects the terminal service connection on line VTY
Examples 0 5 to Ctrl+E (0x05).
Ruijie(config)# line vty 0 5
Ruijie(config-line)# disconnect-character 5

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

escape-character

Use this command to set the escape character for the line. Use the no form of this command to
restore the default setting.
escape-character escape-value
no escape-character

Parameter
Parameter Description
Description
escape-value Sets the ASCII value corresponding to the escape character for the
line, in the range from 0 to 255.

Defaults The default escape character is Ctrl+^ (Ctrl+Shift+6) and the ASCII decimal value is 30.

Command Line configuration mode

Mode

3-6
Command Reference LINE Commands

Usage Guide After configuring this command, press the key combination of the escape character and then press x,
the current session is disconnected to return to the original session.

Configuration The following example sets the escape character for the line to 23 (Ctrl+w).
Examples Ruijie(config)# line vty 0
Ruijie(config-line)# escape-character 23

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

exec

Use this command to enable the line to enter the command line interface. Use the no form of this
command to disable the function.
exec
no exec

Parameter
Parameter Description
Description
N/A N/A

Defaults This function is enabled by default.

Command Line configuration mode

Mode

Usage Guide The no exec command is used to ban the line from entering the command line interface. You have to
enter the command line interface through other lines,

Configuration The following example bans line VTY 1 from entering the command line interface.
Examples Ruijie(config)# line vty 1
Ruijie(config-line)# no exec
Ruijie# show users
Line User Host(s) Idle Location
---------------- ------------ -------------------- ----------
------------------
* 0 con 0 --- idle 00:00:00 ---
1 vty 0 --- idle 00:01:03 20.1.1.2
3 vty 2 --- idle 00:00:13 20.1.1.2

3-7
Command Reference LINE Commands

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

history

Use this command to enable command history for the line or set the number of commands in the
command history. Use the no history command to disable command history. Use the no history
size command to restore the number of commands in the command history to the default setting.
history [ size size ]
no history
no history size

Parameter
Parameter Description
Description
size size The number of commands, in the range from 0 to 256.

Defaults This function is enabled by default, The default size is 10.

Command Line configuration mode

Mode

Usage Guide N/A

Configuration The following example sets the number of commands in the command history to 20 for line VTY 0 5.
Examples Ruijie(config)# line vty 0 5
Ruijie(config-line)# history size 20
The following example disables the command history for line VTY 0 5.
Ruijie(config)# line vty 0 5
Ruijie(config-line)# no history

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

3-8
Command Reference LINE Commands

length

Use this command to set the screen length for the line. Use the no form of this command to restore
the default setting.
length screen-length
no length

Parameter
Parameter Description
Description
screen-length Sets the screen length, in the range from 0 to 512.

Defaults The default is 24.

Command Line configuration mode

Mode

Usage Guide N/A

Configuration The following example sets the screen length to 10.

Examples Ruijie(config-line)# length 10

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

line

Use this command to enter the specified LINE mode.

line [console | vty ] first-line [ last-line ]

Parameter
Parameter Description
Description
console Console port
vty Virtual terminal line, applicable for telnet/ssh connection.
first-line Number of first-line to enter
last-line Number of last-line to enter

Defaults N/A

Command Global configuration mode

3-9
Command Reference LINE Commands

Mode

Usage Guide This command is used to enter the specified LINE mode.

Configuration The following example enters the LINE mode from LINE VTY 1 to 3:
Examples Ruijie(config)# line vty 1 3

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

line vty

Use this command to increase the number of VTY connections currently available. Use the no form of
this command to restore the default setting.
line vty line-number
no line vty line-number

Parameter
Parameter Description
Description
line-number Number of VTY lines. Range: 1-35.

Defaults By default, there are five available VTY connections, numbered 0 to 4.

Command Global configuration mode.

Mode

Usage Guide When you need to increase or decrease the number of available VTY connections, use the above
commands.

Configuration The following example increases the number of available VTY connections to 20. The available VTY
Examples connections are numbered 0 to 19.
Ruijie(config)# line vty 19
Decrease the number of available VTY connections to 10. The available VTY
connections are numbered 0-9.
Ruijie(config)# line vty 10

Related
Command Description
Commands
N/A N/A

3-10
Command Reference LINE Commands

Platform N/A
Description

location

Use this command to configure the line location description. Use the no form of this command to
restore the default setting.
location location
no location

Parameter
Parameter Description
Description
location Line location description

Defaults N/A

Command Line configuration mode

Mode

Usage Guide N/A

Configuration The following example describes the line location as Device’s Line VTY 0.
Examples Ruijie(config)# line vty 0
Ruijie(config-line)# location Device’s Line Vty 0

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

monitor

Use this command to enable log display on the terminal. Use the no form of this command to restore
the default setting,
monitor
no monitor

Parameter
Parameter Description
Description
N/A N/A

3-11
Command Reference LINE Commands

Defaults N/A

Command Line configuration mode

Mode

Usage Guide N/A

Configuration The following example enables log display on the terminal in VTY line 0 5.
Examples Ruijie(config)# line vty 0 5
Ruijie(config-line)# monitor

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

privilege level

Use this command to set the privilege level for the line. Use the no form of this command to restore
the default setting.
privilege level level
no privilege level

Parameter
Parameter Description
Description
level Privilege level, in the range from 0 to 15.

Defaults The default is 1.

Command Line configuration mode

Mode

Usage Guide N/A

Configuration The following example sets the privilege level for the line VTY 0 4 to 14.
Examples Ruijie(config)# line vty 0 4
Ruijie(config-line)privilege level 14

Related
Command Description
Commands

3-12
Command Reference LINE Commands

N/A N/A

Platform N/A
Description

refuse-message

Use this command to set the login refusal message for the line. Use the no form of this command to
restore the default setting.
refuse-message [ c message c ]
no refuse-message

Parameter
Parameter Description
Description
c Delimiter of the login refusal message, which is not allowed within the
message.
message Login refusal message.

Defaults N/A

Command Line configuration mode

Mode

Usage Guide This command is used to set the login refusal message for the line. The characters entered after the
ending delimiter are discarded directly, The login refusal message is displayed when the user has
been refused to login.

Configuration The following example sets the login refusal message for the line to “Unauthorized user cannot login
Examples to the ruijie device”.
Ruijie(config-line)#vacant-message @ Unauthorized user cannot login to the
ruijie device @

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

show history

Use this command to display the command history of the line.

show history

3-13
Command Reference LINE Commands

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example displays the command history of the line.
Examples Ruijie# show history
exec:
sh privilege
sh run
show user
sh user all
show history

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

show line

Use this command to display line configuration.

show line { console line-num | vty line-num | line-num }

Parameter
Parameter Description
Description
console Displays configuration for the console line.
vty Displays configuration for the virtual terminal line.
line-num Displays the line.

Defaults N/A

Command Privileged EXEC mode

Mode

3-14
Command Reference LINE Commands

Usage Guide N/A

Configuration The following example displays configuration for the console port.
Examples Ruijie# show line console 0
CON Type speed Overruns
* 0 CON 9600 45927
Line 0, Location: "", Type: "vt100"
Length: 24 lines, Width: 79 columns
Special Chars: Escape Disconnect Activation
^^x none ^M
Timeouts: Idle EXEC Idle Session
never never
History is enabled, history size is 10.
Total input: 53564 bytes
Total output: 395756 bytes
Data overflow: 27697 bytes
stop rx interrupt: 0 times
Field Description
CON Terminal type. CON indicates console; 0 indicates terminal line
number and * ahead of the number means that the terminal is in use.
Type Terminal type, including CON, and VTY.
speed Asynchronous speed.
Overruns The number of overrun errors received by the flash.
Line 0 Terminal line number.
Location: "" Line location configuration.
Type: "vt100" Compatibility standard.
Special Chars Special characters, including Escape, Disconnect, and Activation
characters.
Timeouts Timeout value; “never” indicates no timeout.
History Whether to enable command history; the number of commands in the
command history.
Total input Data volume received from the drive.
Total output Date volume sent to the drive.
Data overflow Overflowing data volume.
stop rx interrupt Data reception interruption times.

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

3-15
Command Reference LINE Commands

show privilege

Use this command to display the privilege level of the line.

show privilege

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example displays the privilege level of the line.
Examples Ruijie# show privilege
Current privilege level is 10

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

show users

Use this command to display the login user information.

show users [ all ]

Parameter
Parameter Description
Description
all Displays line user information, including users logging into the line
and users not logging into the line.

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

3-16
Command Reference LINE Commands

Configuration The following example displays the information about users logging into the line,
Examples Ruijie# show users
Line User Host(s) Idle Location
---------------- ------------ -------------------- ----------
------------------
0 con 0 --- idle 00:00:46 ---
1 vty 0 --- idle 00:00:29 20.1.1.2
* 2 vty 1 --- idle 00:00:00 20.1.1.2
The following example displays all line user information,
Ruijie(config)# show users all
Line User Host(s) Idle Location
---------------- ------------ -------------------- ----------
------------------
0 con 0 --- idle 00:00:49 ---
1 vty 0 --- idle 00:00:32 20.1.1.2
* 2 vty 1 --- idle 00:00:00 20.1.1.2
3 vty 2 --- 00:00:00 ---
4 vty 3 --- 00:00:00 ---
5 vty 4 --- 00:00:00 ---
6 vty 5 --- 00:00:00 ---

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

speed

Use this command to configure the baud rate for the specified line. Use the no form of this command
to restore the default setting,
speed baudrate
no speed

Parameter
Parameter Description
Description
baudrate Sets the baud rate, in the range from 9600 to 115200.

Defaults The default is 9600.

Command Line configuration mode

Mode

3-17
Command Reference LINE Commands

Usage Guide N/A

Configuration The following example sets the baud rate to 115200,

Examples Ruijie(config-line)# speed 115200

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

terminal escape-character

Use this command to set the escape character for the current terminal. Use the no form of this
command to restore the default setting.
terminal escape-character escape-value
terminal no escape-character

Parameter
Parameter Description
Description
escape-value Sets the ASCII value corresponding to the escape character for the
current terminal, in the range from 0 to 255.

Defaults The default escape character is Ctrl+^ (Ctrl+Shift+6) and the ASCII decimal value is 30.

Command Privileged EXEC mode

Mode

Usage Guide After configuring this command, press the key combination of the escape character and then press x,
the current session is disconnected to return to the original session.

Configuration The following example sets the escape character for the current terminal to 23 (Ctrl+w).
Examples Ruijie# terminal escape-character 23

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

3-18
Command Reference LINE Commands

terminal history

Use this command to enable command history for the current terminal or set the number of
commands in the command history. Use the no history command to disable command history. Use
the no history size command to restore the number of commands in the command history to the
default setting.
terminal history [ size size ]
terminal no history
terminal no history size

Parameter
Parameter Description
Description
size size Sets the number of commands, in the range from 0 to 256.

Defaults This function is enabled by default, The default size is 10.

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example sets the number of commands in the command history to 20 for the current
Examples terminal.
Ruijie# terminal history size 20
The following example disables the command history for the current terminal.
Ruijie# terminal no history

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

terminal length

Use this command to set the screen length for the current terminal. Use the no form of this command
to restore the default setting.
terminal length screen-length
terminal no length

Parameter
Parameter Description
Description

3-19
Command Reference LINE Commands

screen-length Sets the screen length, in the range from 0 to 512.

Defaults The default is 24.

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example sets the screen length for the current terminal to 10.
Examples Ruijie# terminal length 10

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

terminal location

Use this command to configure location description for the current device. Use the no form of this
command to restore the default setting.
terminal location location
terminal no location

Parameter
Parameter Description
Description
location Configures location description of the current device.

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example configures location description of the current device as “Device’s Line Vty 0”.
Examples Ruijie# terminal location Device’s Line Vty 0

Related
Command Description
Commands
N/A N/A

3-20
Command Reference LINE Commands

Platform N/A
Description

terminal speed

Use this command to configure the baud rate for the current terminal. Use the no form of this
command to restore the default setting,
terminal speed baudrate
terminal no speed

Parameter
Parameter Description
Description
baudrate Sets the baud rate, in the range from 9600 to 115200.

Defaults The default is 9600.

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example sets the baud rate for the current terminal to 115200,
Examples Ruijie# terminal speed 115200

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

terminal width

Use this command to set the screen width for the terminal.
terminal width screen-width
terminal no width

Parameter
Parameter Description
Description
screen-width Sets the screen width for the terminal, in the range from 0 to 256.

Defaults The default is 79.

3-21
Command Reference LINE Commands

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example sets the screen width for the terminal to 10.
Examples Ruijie# terminal width 10

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

timeout login

Use this command to set the login authentication timeout for the line. Use the no form of this
command to restore the default setting.
timeout login response seconds
no timeout login response

Parameter
Parameter Description
Description
response The time period during which the line waits for the user to enter any
message.
seconds Timeout value, in the range from 1 to 300 in the unit of seconds.

Defaults The default is 30.

Command Line configuration mode

Mode

Usage Guide N/A

Configuration The following example sets the login authentication timeout to 300 seconds for line VTY 0 5.
Examples Ruijie(config)# line vty 0 5
Ruijie(config-line)login timeout response 300

Related
Command Description
Commands
N/A N/A

3-22
Command Reference LINE Commands

Platform N/A
Description

transport input

Use this command to set the specified protocol under Line that can be used for communication. Use
the no form of this command to restore the default setting.
transport input { all | ssh | telnet | none }
no transport input { all | ssh | telnet | none }

Parameter
Parameter Description
Description
all Allows all the protocols under Line to be used for communication
Allows only the SSH protocol under Line to be used for
ssh
communication
Allows only the Telnet protocol under Line to be used for
telnet
communication
none Allows none of protocols under Line to be used for communication

Defaults all, ssh and telnet protocols are allowed.

Command Line configuration mode

Mode

Usage Guide N/A

Configuration The following example specifies that only the Telnet protocol is allowed to login in line vty 0 4.
Examples Ruijie(config)# line vty 0 5
Ruijie(config-line)transport input ssh

Related
Command Description
Commands
show running Displays status information

Platform N/A
Description

vacant-message

Use this command to set the logout message. Use the no form of this command to restore the default
setting.
vacant-message [ c message c ]

3-23
Command Reference LINE Commands

no vacant-message

Parameter
Parameter Description
Description
c Delimiter of the logout message, which is not allowed within the
message.
message Logout message.

Defaults N/A

Command Line configuration mode

Mode

Usage Guide This command is used to set the logout message for the line. The characters entered after the ending
delimiter are discarded directly, The logout message is displayed when the user logs out.

Configuration The following example sets the logout message to “Logout from the ruijie device”.
Examples Ruijie(config-line)#vacant-message @ Logout from the ruijie device @

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

width

Use this command to set the screen width for the line. Use the no form of this command to restore the
default setting,
width screen-width
no width

Parameter
Parameter Description
Description
screen-width Sets the screen width for the line, in the range from 0 to 256,

Defaults The default is 79.

Command Line configuration mode

Mode

Usage Guide N/A

3-24
Command Reference LINE Commands

Configuration The following example sets the screen width for the line to 10.
Examples Ruijie(config-line)# width 10

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

3-25
Command Reference Password Policy Commands

4 Password Policy Commands

password policy life-cycle

Use this command to set the password lifecycle. Use the no form of this command to restore the
default setting.
password policy life-cycle days
no password policy life-cycle

Parameter
Parameter Description
Description
Sets the password lifecycle, in the range from 1 to 65535 in the unit of
days
days.

Defaults No password lifecycle is set by default.

Command Global configuration mode

Mode

Usage Guide This command is used to set the password lifecycle. After the password lifecycle expires, the system
reminds you to change the password when you login next time.

This function is valid for the global password (the enable password and the enable secret
commands) and the local user password (the username name password password command)
while not valid for the password in line mode.

Configuration The following example sets the password lifecycle to 90 days.

Examples Ruijie(config)# password policy life-cycle 90

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

password policy min-size

Use this command to set the minimum length of the password. Use the no form of this command to
restore the default setting.
password policy min-size length
no password policy min-size

4-1
Command Reference Password Policy Commands

Parameter
Parameter Description
Description
length Sets the minimum length of the password, in the range from 1 to 31.

Defaults No minimum length of the password is set by default.

Command Privileged EXEC mode

Mode

Usage Guide This command is used to set the minimum length of the password,

This function is valid for the global password (the enable password and the enable secret
commands) and the local user password (the username name password password command)
while not valid for the password in line mode.

Configuration The following example sets the minimum length of the password to 8.
Examples Ruijie(config)# password policy min-size 8

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

password policy no-repeat-times

Use this command to ban the use of passwords used in the past several times. Use the no
form of this command to restore the default setting.
password policy no-repeat-times times
no password policy no-repeat-times

Parameter
Parameter Description
Description
The past several times when passwords are configured, in the
times
range from 1 to 31.

Defaults This function is disabled by default.

Command Mode Global configuration mode

Usage Guide After this function is enabled, passwords used in the past several times are recorded. If the
new password has been used, the alarm message is displayed and password configuration

4-2
Command Reference Password Policy Commands

fails.
This command is used to set the maximum number of password entries. When the actual
number of password entries exceeds the configured number, the new password overwrites
the oldest password.

This function is valid for the global password (the enable password and the enable
secret commands) and the local user password (the username name password
password command) while not valid for the password in line mode.

Configuration The following example bans the use of passwords used in the past five times.
Examples Ruijie(config)# password policy no-repeat-times 5

Related Commands Command Description

N/A N/A

Platform Description N/A

password policy strong

Use this command to enable strong password check.

password policy strong
no password policy strong

Parameter
Parameter Description
Description
N/A N/A

Defaults This function is disabled by default.

Command Global configuration mode

Mode

Usage Guide If the following two kinds of passwords are set not matching the strength policy, the alarm message is
displayed.
1. The password the same as the username.
2. The simple password containing only characters or numbers.

This function is valid for the global password (the enable password and the enable secret
commands) and the local user password (the username name password password command)
while not valid for the password in line mode.

Configuration The following example configures the strong password check.

Examples Ruijie(config)# password policy strong

4-3
Command Reference Password Policy Commands

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

service password-encryption

Use this command to encrypt a password. Use the no form of this command to restore default setting.
service password-encryption
no service password-encryption

Parameter
Parameter Description
Description
N/A N/A

Defaults This function is disabled by default.

Command Global configuration mode

Mode

Usage Guide This command is disabled by default. Various passwords are displayed in plain text, unless they are
encrypted. After you run the service password-encryption and show running or write command to
save your configuration, the password changes into cipher text. If you disable the command, the
password in cipher text cannot be restored to plain text.

Configuration The following example encrypts the password:

Examples Ruijie(config)# service password-encryption

Related
Command Description
Commands
enable password Sets passwords of different privileges.

Platform
N/A
Description

show password policy

Use this command to display the password security policy set by the user.
show password policy

4-4
Command Reference Password Policy Commands

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide This command is used to display the password security policy set by the user.

Configuration The following example displays the password security policy set by the user.
Examples Ruijie#show password policy
Global password policy configurations:
Password encryption: Enabled
Password strong-check: Enabled
Password forced-password-modify: Disabled
Password min-size: Enabled (6 characters)
Password life-cycle: Enabled (90 days)
Password no-repeat-times: Enabled (max history record: 5)
Field Description
Password encryption Whether to encrypt the password.
Password strong-check Whether to enable password strong-check.
Password forced-password-modify Whether to enable forced password
modifcation..
Password min-size Whether to set the minimum length of the
password.
Password life-cycle Whether to set the password lifecycle.
Password no-repeat-times

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

4-5
Command Reference File System Commands

5 File System Commands

cd

Use this command to set the present directory for the file system.
cd [ filesystem: ] [ directory ]

Parameter Parameter Description

Description filesystem: The URL of filesystem, followed by a colon (:). The filesystem
includes flash:, sata:, usb: and tmp:.
directory The path name. A file name starts with “/” is an absolute path.
Otherwise, it is a relative path.

Defaults The default directory is the flash root directory.

Command Privileged EXEC mode.

Mode The specified path of the file system support URLs. For details of URL prefixes, see description of the
copy command.
Usage Guide Change the above parameter to the directory you want to enter. Use the pwd command to view the
present directory.

Configuration The following example enters the sata hardware.

Examples Ruijie# pwd
flash:/
Ruijie# cd sata:
Ruijie# pwd
sata:/

Related Command Description

Commands pwd Displays the present word directory.

Platform For the NBR6120-E, NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2, and NBR6215-E, no
Description SATA hard drive is configured upon delivery. For the NBR6205-E, NBR6205-E V2, NBR6210-E,
NBR6210-E V2, and NBR6215-E, SATA hard drives can be separately purchased and installed.

copy

Use this command to copy a file from the specified source directory to the specified destination
directory.
copy source-url destination-url

5-1
Command Reference File System Commands

Parameter Parameter Description

Description source-url Source file URL, which can be local or remote.
destination-url Destination file URL, which can be local or remote.

Defaults N/A.

Command Privileged EXEC mode.

Mode

Usage Guide when the file to be copied exists on the target URL, the target file system determines the action, such
as error report, overwrite, or offering you the choice.
The following table lists the URL:
Prefix Description
running-config Running configuration file.
startup-config startup configuration file.
flash: local FLASH file system.
tftp: The URL of TFTP network server, in the format as follows:
tftp:[[//location]/directory]/filename

Configuration The following example copies the netconfig file from device 192.168.64.2 to the FLASH disk and the
Examples netconfile file exists locally.
Ruijie# copy tftp://192.168.64.2/netconfig flash:/netconfig
The file [flash:/netconfig] exits,override it? [Y/N]: y
Copying: !!!!!!!!

Accessing tftp://192.168.64.2/netconfig finished, 2399bytes prepared

Flushing data to flash:/netconfig…
Flush data done

Related Command Description

Commands delete Deletes the file.
rename Renames the file.
dir Displays the file list of the specified directory.

Platform N/A
Description

delete

Use this command to delete the files in the present directory.

5-2
Command Reference File System Commands

delete [ filesystem: ] file-url

Parameter Parameter Description

Description The URL of file system, followed by a colon (:). The file system
filesystem:
includes flash:, sata:, usb:, and tmp:.
The file name containing the path. A file name starts with “/” is an
file-url
absolute path. Otherwise, it is a relative path.

Defaults The default filesystem: is flash:.

Command Privileged EXEC mode.

Mode

Usage Guide This command is used to delete the specified file in the URL. This command supports deleting the
files stores in the local storage media, i.e., the URL must be one of the flash:/ usb0:/ or usb1:/ slave:/.
If the prefix is not specified in the URL, it indicates to delete the file in the system.
This command does not support wildcard.

Configuration The following example deletes the fstab file on the FLASH disk.
Examples Ruijie# pwd
flash:/
Ruijie# dir
Directory of flash:/
1 -rw- 336 Jan 03 2012 18:53:42 fstab
2 -rw- 4096 Jan 03 2012 12:32:09 rc.d
3 -rw- 10485760 Jan 03 2012 18:13:37 rpmdb
3 files, 0 directories
10,490,192 bytes total (13,192,656 bytes free)
Ruijie# delete flash:/fstab

Do you want to delete [flash:/fstab]? [Y/N]:y

Delete success.

Ruijie# dir
Directory of flash:/
1 -rw- 4096 Jan 03 2012 12:32:09 rc.d
2 -rw- 10485760 Jan 03 2012 18:13:37 rpmdb
2 files, 0 directories
10,489,856 bytes total (13,192,992 bytes free)

Related Command Description

Commands copy Copies the file.
dir Displays the file list of the specified directory.

5-3
Command Reference File System Commands

Platform For the NBR6120-E, NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2, and NBR6215-E, no
Description SATA hard drive is configured upon delivery. For the NBR6205-E, NBR6205-E V2, NBR6210-E,
NBR6210-E V2, and NBR6215-E, SATA hard drives can be separately purchased and installed.

dir

Use this command to display the files in the present directory.

dir [ filesystem: ] [ directory ]

Parameter Parameter Description

Description filesystem The URL of file system, followed by a colon (:). The file system includes flash:,
sata:, usb:, and tmp:.
directory The path name. A file name starts with “/” is an absolute path. Otherwise, it is a
relative path.

Defaults By default, only the information under the present working path is displayed.

Command Privileged EXEC mode.

Mode

Usage Guide Enter the specified directory to show the information of all the files in that directory. If no parameter is
specified, the information of the files in the present directory is shown by default.
This command does not support wildcard.

Configuration The following example displays the file information of the root directory in the FLASH disk.
Examples Ruijie# dir flash:/
Directory of flash:/
1 -rw- 336 Jan 03 2012 18:53:42 fstab
2 -rw- 4096 Jan 03 2012 12:32:09 rc.d
3 -rw- 10485760 Jan 03 2012 18:13:37 rpmdb
3 files, 0 directories
10,490,192 bytes total (13,192,656 bytes free)
Field Description
1, 2, 3… Index number
Permissions on a file include:
 d: directory
-rw-  r: read
 w: write
 x: executable
10485760 File size
rpmdb File name
files File number

5-4
Command Reference File System Commands

directories Directory number

total Total size
free Available space

Related Command Description

Commands pwd Displays the present directory.
cd Sets the present directory of the file system.

Platform For the NBR6120-E, NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2, and NBR6215-E, no
Description SATA hard drive is configured upon delivery. For the NBR6205-E, NBR6205-E V2, NBR6210-E,
NBR6210-E V2, and NBR6215-E, SATA hard drives can be separately purchased and installed.

erase

Use this command to erase the device or file that does’t have a file system.
erase filesystem

Parameter Parameter Description

Description filesystem: Name of the file system, followed by a colon (:). For example, usb0:.

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example erases the USB filesystem.

Examples Ruijie# erase usb0:
Sure to erase usb0:? [Y/N] y
Erasing disk usb0 …
Erase disk usb0 done!

Related Command Description

Commands N/A N/A

Platform N/A
Description

file

Use this command to display the information about a file.

file [ filesystem: ] file-url

5-5
Command Reference File System Commands

Parameter Parameter Description

Description The URL of file system, followed by a colon (:). The file system
filesystem:
includes flash:, sata:, usb:, and tmp:.
The file name containing the path. A file name starts with “/” is an
file-url
absolute path. Otherwise, it is a relative path.

Defaults The default filesystem: is flash:.

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example displays the information about gcc executable file.
Examples Ruijie#file flash:/gcc
/usr/bin/gcc-4.6: ELF 32-bit LSB executable, Intel 80386, version 1 (SYSV),
dynamically linked (uses shared libs), for GNU/Linux 2.6.15, stripped

Related Command Description

Commands N/A N/A

Platform For the NBR6120-E, NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2, and NBR6215-E, no
Description SATA hard drive is configured upon delivery. For the NBR6205-E, NBR6205-E V2, NBR6210-E,
NBR6210-E V2, and NBR6215-E, SATA hard drives can be separately purchased and installed.

file prompt

Use this command to set the prompt mode.

file prompt [ noisy | quiet ]

Parameter Parameter Description

Description noisy Displays prompt for all operation.
quiet Displays prompt rarely.

Defaults The default mode is noisy.

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example sets the prompt mode to noisy.

5-6
Command Reference File System Commands

Examples Ruijie#file prompt noisy

Related Command Description

Commands N/A N/A

Platform N/A
Description

mkdir

Use this command to create a directory.

mkdir [ filesystem: ] directory

Parameter Parameter Description

Description filesystem: The URL of file system, followed by a colon (:). The file system
includes flash:, sata:, usb:, and tmp:.
directory The path name. A file name starts with “/” is an absolute path.
Otherwise, it is a relative path.

Defaults The default filesystem: is flash:.

The default directory is the root directory.

Command Privileged EXEC mode.

Mode

Usage Guide

Configuration The following example creates a directory named newdir:

Examples Ruijie#dir
Directory of flash:/
1 -rw- 336 Jan 03 2012 18:53:42 fstab
2 -rw- 4096 Jan 03 2012 12:32:09 rc.d
3 -rw- 10485760 Jan 03 2012 18:13:37 rpmdb
3 files, 0 directories
10,490,132 bytes total (13,192,656 bytes free)
Ruijie#mkdir newdir
Created dir flash:/newdir
Ruijie#dir
Directory of flash:/
1 -rw- 336 Jan 03 2012 18:53:42 fstab
2 -rw- 4096 Jan 03 2012 12:32:09 rc.d
3 -rw- 10485760 Jan 03 2012 18:13:37 rpmdb
4 drw- 4096 Jan 03 2012 18:13:37 newdir

5-7
Command Reference File System Commands

3 files, 1 directories
10,494,228 bytes total (13,188,560 bytes free)

Related Command Description

Commands rmdir Deletes the directory.
pwd Displays the present directory.

Platform For the NBR6120-E, NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2, and NBR6215-E, no
Description SATA hard drive is configured upon delivery. For the NBR6205-E, NBR6205-E V2, NBR6210-E,
NBR6210-E V2, and NBR6215-E, SATA hard drives can be separately purchased and installed.

more

Use this command to display the content of a file.

more [ /ascii | /binary ] [ filesystem: ] file-url

Parameter Parameter Description

Description /ascii Displays the file content in the ASCII format.
/binary Displays the file content in the
The URL of file system, followed by a colon (:). The file system
filesystem:
includes flash:, sata:, usb:, and tmp:.
The file name containing the path. A file name starts with “/” is an
file-url
absolute path. Otherwise, it is a relative path.

Defaults The file is displayed in its own format by default.

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example displays the content of the netconfig file under root directory of FLASH disk.
Examples Ruijie#more flash:/netconfig
#
# The network configuration file. This file is currently only used in
# conjunction with the TI-RPC code in the libtirpc library.
#
# Entries consist of:
#
# <network_id> <semantics> <flags> <protofamily> <protoname> \
# <device> <nametoaddr_libs>
#
# The <device> and <nametoaddr_libs> fields are always empty in this

5-8
Command Reference File System Commands

# implementation.
#
udp tpi_clts v inet udp - -
tcp tpi_cots_ord v inet tcp - -
udp6 tpi_clts v inet6 udp - -
tcp6 tpi_cots_ord v inet6 tcp - -
rawip tpi_raw - inet - - -
local tpi_cots_ord - loopback - - -

Related Command Description

Commands N/A N/A

Platform For the NBR6120-E, NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2, and NBR6215-E, no
Description SATA hard drive is configured upon delivery. For the NBR6205-E, NBR6205-E V2, NBR6210-E,
NBR6210-E V2, and NBR6215-E, SATA hard drives can be separately purchased and installed.

pwd

Use this command to display the working path.

pwd

Parameter Parameter Description

Description N/A. N/A.

Defaults N/A.

Usage Guide This command displays the present working path

Configuration The following example displays the process of switching the working directory from flash: to sata:.
Examples Ruijie#pwd
flash:/
Ruijie#cd sata:/
Ruijie#pwd
sata:/

Related Command Description

Commands cd Changes the file system in the present directory.

Platform N/A.
Description

5-9
Command Reference File System Commands

rename

Use this command to move or rename the specified file.

rename src-url dst-url

Parameter Parameter Description

Description src-url The source file URL to move.
dst-url The URL of the destination file or directory.

Defaults N/A.

Command Privileged EXEC mode.

Mode

Usage Guide N/A

Configuration The following example renames the fstab file in the root directory on the FLASH disk as new-fstab.
Examples Ruijie#dir
Directory of flash:/
1 -rw- 336 Jan 03 2012 18:53:42 fstab
2 -rw- 4096 Jan 03 2012 12:32:09 rc.d
3 -rw- 10485760 Jan 03 2012 18:13:37 rpmdb
3 files, 0 directories
10,490,192 bytes total (13,192,656 bytes free)
Ruijie#rename flash:/fstab flash:/new-fstab
Renamed file flash:/new-fstab
Ruijie#dir
Directory of flash:/
1 -rw- 336 Jan 03 2012 18:53:42 new-fstab
2 -rw- 4096 Jan 03 2012 12:32:09 rc.d
3 -rw- 10485760 Jan 03 2012 18:13:37 rpmdb
3 files, 0 directories
10,490,192 bytes total (13,192,656 bytes free)

Related Command Description

Commands delete Deletes the file.
copy Copies the file.

Platform N/A
Description

5-10
Command Reference File System Commands

rmdir

Use this command to delete an empty directory.

rmdir [ filesystem: ] directory

Parameter Parameter Description

Description The URL of file system, followed by a colon (:). The file system
filesystem:
includes flash:, sata:, usb:, and tmp:.
directory

Defaults The default filesystem: is flash:.

Command Privileged EXEC mode.

Mode

Usage Guide This command does not support the wildcards, and the directory to be deleted must be empty. Since
this command supports abbreviations, you can also use the rm command to delete empty directories.

Configuration The following example deletes the null test directories.

Examples Ruijie#mkdir newdir
Ruijie#dir
Directory of flash:/
1 -rw- 336 Jan 03 2012 18:53:42 fstab
2 -rw- 4096 Jan 03 2012 12:32:09 rc.d
3 -rw- 10485760 Jan 03 2012 18:13:37 rpmdb
4 drw- 4096 Jan 03 2012 18:13:37 newdir
3 files, 1 directories
10,494,228 bytes total (13,188,560 bytes free)
Ruijie#rmdir newdir
removed dir flash:/newdir
Ruijie#dir
Directory of flash:/
1 -rw- 336 Jan 03 2012 18:53:42 fstab
2 -rw- 4096 Jan 03 2012 12:32:09 rc.d
3 -rw- 10485760 Jan 03 2012 18:13:37 rpmdb
3 files, 0 directories
10,490,132 bytes total (13,192,656 bytes free)

Related Command Description

Commands N/A. N/A.

Platform For the NBR6120-E, NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2, and NBR6215-E, no
Description SATA hard drive is configured upon delivery. For the NBR6205-E, NBR6205-E V2, NBR6210-E,
NBR6210-E V2, and NBR6215-E, SATA hard drives can be separately purchased and installed.

5-11
Command Reference File System Commands

show disk

Use this command to display SATA/USB/Flash information.

show disk { sata | usb | flash }

Parameter
Parameter Description
Description
sata Displays SATA information.
usb Displays USB information.
flash Displays FLASH information.

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example displays SATA information.

Examples Ruijie#show disk sata
Disk /dev/sda: 160.0 GB, 160039272960 bytes
255 heads, 63 sectors/track, 19457 cylinders
The following example displays USB information.
Ruijie#show disk usb
Disk /dev/sdb: 8159 MB, 8159477760 bytes
252 heads, 62 sectors/track, 1020 cylinders
Units = cylinders of 15624 * 512 = 7999488 bytes
The following example displays FLASH information.
Ruijie#show disk flash
Nand flash size: 512MB
Nor flash size: 1MB

Related Command Description

Commands N/A N/A

Platform For the NBR6120-E, NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2, and NBR6215-E, no
Description SATA hard drive is configured upon delivery. For the NBR6205-E, NBR6205-E V2, NBR6210-E,
NBR6210-E V2, and NBR6215-E, SATA hard drives can be separately purchased and installed.

show file systems

Use this command to display the file system information.

show file systems

5-12
Command Reference File System Commands

Parameter Parameter Description

Description N/A. N/A.

Defaults N/A.

Command Privileged EXEC mode.

Mode

Usage Guide Use this command to display the file systems supported in the present devices and the available
space condition in the file system.

Configuration The following example displays the file system information:

Examples Ruijie#show file systems
Size(KB) Free(KB) Type Flags Prefixes
NA NA ram rw tmp:
NA NA network rw tftp:
NA NA network rw oob_tftp:
NA NA xmodem rw xmodem:
8192 2416 disk rw flash:
167772160 147772160 disk rw sata0:
1048576 548576 disk rw usb0:

Field Description
Size(KB) File system space, in the unit of KB.
Free(KB) Available file system space, in the unit of KB.
Type File system type
Permissions on the file system include:
 ro: read-only
Flags
 wo: write-only
 rw: read and write
Prefixes File system prefix

Related Command Description

Commands N/A. N/A.

Platform N/A.
Description

show mount

Use this command to display the mounted information.

show mount

5-13
Command Reference File System Commands

Parameter Parameter Description

Description N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example displays the mounted information.

Examples Ruijie# show mount
/dev/sda1 on / type ext4 (rw,errors=remount-ro,commit=0)
proc on /proc type proc (rw,noexec,nosuid,nodev)
sysfs on /sys type sysfs (rw,noexec,nosuid,nodev)
fusectl on /sys/fs/fuse/connections type fusectl (rw)
none on /sys/kernel/debug type debugfs (rw)
none on /sys/kernel/security type securityfs (rw)
udev on /dev type devtmpfs (rw,mode=0755)
devpts on /dev/pts type devpts (rw,noexec,nosuid,gid=5,mode=0620)
tmpfs on /run type tmpfs (rw,noexec,nosuid,size=10%,mode=0755)
none on /run/lock type tmpfs (rw,noexec,nosuid,nodev,size=5242880)
none on /run/shm type tmpfs (rw,nosuid,nodev)
/dev/sda3 on /hao-share type ext3 (rw,commit=0)
binfmt_misc on /proc/sys/fs/binfmt_misc type binfmt_misc
(rw,noexec,nosuid,nodev)
Field Description
proc Source address of mount.
on -
/proc Destination address of mount.
type -
proc Mount type.
(rw,noexec,nosuid,nodev) Mount property.

Related Command Description

Commands N/A N/A

Platform N/A
Description

5-14
Command Reference File System Commands

tftp-client source

Use this command to bind a source IP address or source interface with a TFTP client. Use the no or
default form of this command to restore the default setting.
tftp-client source { ip ip-address | interface }
no tftp-client source { ip ip-address | interface}
default tftp-client source { ip ip-address | interface }

Parameter Parameter Description

Description ip-address Specifies the IPv4 source address.
interface Specifies the source interface

Defaults No source interface or IP address is bound with the TFTP client by default.

Command Global configuration mode

Mode

Usage Guide N/A

Configuration The following example binds source IP address 192.168.23.236 with the TFTP client.
Examples Ruijie(config)# tftp-client source ip 192.168.23.236
The following example binds source interface gigabitEthernet 0/0 with the TFTP client.
Ruijie(config)# tftp-client source gigabitEthernet 0/0
The following example removes the configuration.
Ruijie(config)# no tftp-client source ip 192.168.23.236
The following example restores the default setting.
Ruijie(config)# default tftp-client source ip 192.168.23.236

Related Command Description

Commands N/A N/A

Platform N/A
Description

tree

Use this command to display the file tree of the current directory.
tree [ filesystem: ] [ directory ]

Parameter Parameter Description

Description The URL of file system, followed by a colon (:). The file system
filesystem:
includes flash:, sata:, usb:, and tmp:.
directory The path name. A file name starts with “/” is an absolute path.

5-15
Command Reference File System Commands

Otherwise, it is a relative path.

Defaults The default filesystem: is flash:.

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example displays the file tree of flash:/echo

Examples Ruijie#tree flash:/echo
+-- client_module
+-- client_userspace
+-- echo_cli.c
+-- echo_client.c
+-- echo_client.h
+-- echo_client.o
+-- echo_cli.o
+-- echo_flag.h
+-- echo.h
+-- echo.ko
+-- echo_server.h
+-- exec_set_echo.h
+-- exec_show_echo.h
+-- Makefile
+-- module
¦ +-- echo.ko
¦ +-- echo.mod.c
¦ +-- echo.mod.o
¦ +-- echo_module.c
¦ +-- echo_module.o
¦ +-- echo.o
¦ +-- echo_server.c
¦ +-- echo_server.o
¦ +-- echo_sysfs.c
¦ +-- echo_sysfs.h
¦ +-- echo_sysfs.o
¦ +-- Makefile
¦ +-- modules.order
¦ +-- Module.symvers
¦ +-- msg_fd.c
¦ +-- msg_fd.o
+-- readme
+-- server_module

5-16
Command Reference File System Commands

+-- server_userspace
+-- sys_rgos.ko
+-- user_space
+-- echo_server.c
+-- echo_server.o
+-- Makefile
+-- msg_fd.c
+-- msg_fd.o 10,490,132 bytes total (13,192,656 bytes free)

Related Command Description

Commands N/A N/A

Platform N/A
Description

verify

Use this command to compute, display and verify Message Digest 5 (MD5).
verify [ /md5 md5-value ] filesystem: [ file-url ]

Parameter Parameter Description

Description /md5 Computes and displays MD5.
md5-value The file MD5, which is compared with the computed MD5.
The URL of file system, followed by a colon (:). The file system
filesystem:
includes flash:, sata:, usb:, and tmp:.
The file name containing the path. A file name starts with “/” is an
file-url
absolute path. Otherwise, it is a relative path.

Defaults The default filesystem: is flash:.

Command Privileged EXEC mode.

Mode

Usage Guide N/A

Configuration The following example computes MD5 of flash:/gcc.

Examples Ruijie#verify flash:/gcc
8b072de7db7affd8b2ef824e7e4d716c
The following example

Related Command Description

Commands N/A N/A

5-17
Command Reference File System Commands

Platform N/A
Description

5-18
Command Reference LICENSING Commands

6 LICENSING Commands

license copy

Use this command to back up a license file.

license { copy-all | copy-file filename } { flash: | usb0: } [target-filename]

Parameter
Parameter Description
description
copy-all Copies all permanent license files in the system.
Copies the filename license file in the system. And filename can
be the name of a license file already installed in the system or
copy-file
the name of a feature. When filename is a feature name, all
license files already installed for this feature are backed up.
The name of a license file already installed in the system or the
filename
name of a feature
Specifies that the license file is installed in the internal flash file
flash:
system.
usb0: Specifies that the license file is installed in the USB file system.
target-filename Specifies the name of the license file.

Command Privileged EXEC mode

Mode

Default Level 4

Usage Guide When you back up all license files in the system, a tar file is generated. This command does not
require authorization.
Both one license file and all license files of a certain feature can be copied.

Configuration The following example backs up all license files in the system into file-rg-license-lics in a USB flash
Examples drive (there must be this path) and name the backup lics.tar.
Ruijie# license copy-all usb0:rg-license-lics/lics.tar
Success to copy all permanent license.

Verification You can run the dir command to check whether the license file backup is generated. In addition, you
can check whether the backup is correct by comparing the output of the dir command with the license
file name in the installed license field of the feature with permanent authorization displayed by
running the show license all_license command.

Only a multi-instance license file has the installed license field. The multi-instance license file
backup is named after the ID of the multi-instance license file. At most one single-instance

6-1
Command Reference LICENSING Commands

license file exists in the system at a time; therefore, the single-instance license file backup is
named after the feature.

In this example, the IDs 19881021.lic and 19881023.lic are embedded in the license file.
License files are stored in different folders based on the features during the packing; therefore,
users can still identify the mapping between license files and features.

Prompt There is not permanent license in the system for backup.

Messages Copy failed, there's no permanent license in the system.

All license files in the system are successfully backed up.

Success to copy all permanent license.

The error message is displayed if no feature or license file is specified on the device.
Copy failed, there’s no such service or license installed in the system.

The error message is displayed if the specified license file is temporary.

Copy failed, the license is temporary.

The specified license file is backed up successfully.

Success to copy license vsd.lic.

Common Specify a license file or a file not in the system.

Errors Specify a temporary license file for backup (a temporary license file cannot be backed up).

license grace-period

Use this command to set the time of issuing a warning before the validity period of a license file
expires. Use the no or default form of this command to restore the default setting.
license grace-peroid license days

Parameter
Parameter Description
Description
filename The name of the license file for a feature
days The period from the expiry time to the warning time

Defaults The default value is the smaller one between 120 and half the evaluation license file's validity period.

Command Privileged EXEC mode

Mode

Default Level 4

Usage Guide When the timeout interval of a license file is shorter than the friendly period, the friendly period

6-2
Command Reference LICENSING Commands

warning is generated once a day; and the warning is generated once an hour one day before the
license file expires. Friendly period warning is issued in log or SNMP TRAP form.

This command does not require authorization.

An evaluation license file needs to be configured with friendly period warning. A permanent
license file does not need to be configured with friendly period warning.

Configuration
Examples

Prompt
Messages The specified license file is not in the system.
There's no license abc in the system.

Common
Specify a license file not in the system.
Errors

license install

Use this command to install a license file.

license install { flash: | usb0: } filename

Parameter
Parameter Description
Description
Specifies that the license file is installed in the internal flash file
flash:
system.
usb0: Specifies that the license file is installed in the USB file system.
filename Specifies the name of the license file.

Command Privileged EXEC mode

Mode

Default Level 4

Usage Guide The name of the license file can be modified. This command does not require authorization.

Configuration
Examples

Verification Run the show license all_license command to check the license name. If the license name is
displayed, the corresponding license file is installed.

6-3
Command Reference LICENSING Commands

Prompt The specified license file is not in the system.

Messages Install failed: no such file or directory.

The specified license file is not legal.

Install failed: the install license may be wrong.

The specified license file is newer than the installed one.

Install failed: the system already has a same license which is newer.

The license file is reinstalled.

Install failed: the license has been installed before.

The specified license file is temporary and there is the same permanent one.
Install failed: The system already has a same permanent license.

Common Specify a license file not on the device.

Errors Specify a license file illegal.
Specify a license file to install older than existing one in the system.
Reinstall the license file.
Replace the permanent license file with the temporary license file.

license unbind

Use this command to unbind a license.

license unbind pak

Parameter
Parameter Description
Description
pak The license code

Command Privileged EXEC mode

Mode

Default Level 4

Usage Guide This command does not require the license.

Use this command to unbind a license from the bound device before performing unbinding on the
Web page.

You will get an authenticode after unbinding the license from the device, which is necessary for
unbinding operation on the Web page.

6-4
Command Reference LICENSING Commands

Configuration The following example unbinds license code LIC-FCOE00000012268888.

Examples Ruijie# license unbind LIC-FCOE00000012268888
Success to unbind license LIC-FCOE00000012268888.
The verification string is
775719468737BA269825589557F558657575B5D5D5D5D785782598859765A8355855.

Verification Run the show license command to check whether the license associated with the license code is
available.

Notifications 1. If the license that matches the system is not available, the following message is displayed.
Unbind failed: not match license found.

Common
No matched license is available.
Error

license uninstall

Use this command to remove a license file.

license uninstall { all | license [ filename ] }

Parameter
Parameter Description
Description
all Removes all license files in the system.
license The name of the license to be removed
filename The name of the file to be removed

Command Privileged EXEC mode

Mode

Default Level 4

Usage Guide This command does not require authorization.

After you remove the license file for a feature that is running, the license file removal does not
take effect immediately.

A license file cannot be restored after it is removed. It is recommended that you back up the
license file before removing it.

Configuration
Examples

6-5
Command Reference LICENSING Commands

Verification Run the show license all_license command to view the Service name filed. If the name of a feature
corresponding to a license file already removed is not displayed, the removal is successful.

Prompt The specified license file is not on the device. (it is named after defd in this example).
Messages Uninstall failed: there's no license defd in the system.

The specified license file of the specified feature is not on the device (The specified feature is
LIC-WLAN-AP-32 and the specified license is named 123.lic).
Uninstall failed: there's no license 123.lic of service LIC-WLAN-AP-32 in the
system.

The single instance license does not support license based uninstalling.
Uninstall failed: single instance license does not support license based
uninstalling.

The removing of a license file is successful (LIC-WLAN-AP-32 is the name of the specified file and
AP32_1.lic is a license file in this example).
Uninstall license AP32_1.lic of service LIC-WLAN-AP-32 success.

Common The license file has not been installed on the device.
Errors Specify a license file not on the device.
Remove a certain license file for a single-instance feature (One single-instance license does not
support the removing of one single file.

license update

Use this command to update a license file.

license update { flash: | usb0: } filename

Parameter
Parameter Description
Description
Specifies that the license file is installed in the internal flash file
flash:
system.
usb0: Specifies that the license file is installed in the USB file system.
filename Specifies the name of the license file.

Command Privileged EXEC mode

Mode

Default Level 4

Usage Guide This command does not require authorization. The name of a license file can be modified.

6-6
Command Reference LICENSING Commands

Configuration
Examples

Verification Run the show license command to check the Attribute field. If the field is displayed as Permanent,
the corresponding attribute is updated.

Configuration Ruijie #show license all-license

Examples Searching license in the system...
1. Service name: LIC-VSD
Attribute: Permanent, Multiple instance, Releasable
Installed licenses(s): 123.lic

Prompt The specified license file is not in the system.

Messages Update failed: No such file or directory.

The specified license file is not legal.

Update failed: the update license may be wrong.

The specified license file is newer than the installed one.

Update failed: the new installed license is older than the system one.

The license file is reinstalled.

Update failed: the license has been installed before.

The temporary license file cannot be replaced by a permanent one.

Update failed: the period license cannot replace permanent license.

The specified license file is not on the device before the corresponding feature of the license file is to
be installed first.
Update failed: now the system does not have the license.
Try "license install" instead.

Common Install a license file that does not belong to the present device.
Errors Replace the license file of the new version with the old version.
Reinstall an updated license file.
Replace the permanent license file with the temporary license file.
Start update when the corresponding feature is not licensed for the system.

6-7
Command Reference LICENSING Commands

show license

Use this command to check a license file for the device.

show license { all-license | dev-license | file [ license ] }

Parameter
Parameter Description
Description
all-license The list of all license files already installed on the device
dev-license The list of the license files on all devices
file filename The name of a specified license file

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide This command does not require authorization. It displays the license information of the system.

Configuration
Examples
The following example displays the information of all the license files installed in the system.

Ruijie#show license all-license

Searching license in the system...
1. Service name: LIC-AP-64
Attribute: Releasable
[Permanent licenses] [Licensed serial number]
19880966.lic LIC-AP-6400000012264966
19880988.lic LIC-AP-6400000012264988

[Temporary license] [Licensed serial number]

19880900.lic LIC-AP-6400000012264900
(63 days left)

The following example displays the information of the license files on all devices.
Ruijie#show license dev-license
Searching license in the system...
Dev:1
1. Service name: LIC-AP-64
Attribute: Releasable
[Permanent licenses] [Licensed serial number]
19880966.lic LIC-AP-6400000012264966
19880988.lic LIC-AP-6400000012264988

[Temporary license] [Licensed serial number]

6-8
Command Reference LICENSING Commands

19880900.lic LIC-AP-6400000012264900
(63 days left)

Dev:2
1. Service name: LIC-FC-BLADE-S
Attribute: Temporary, Releasable
Left days: 99
Licensed serial number: LIC-FC-BLADE-S 00000001884686
2. Service name: LIC-AP
Attribute: Permanent, Releasable
[Installed licenses] [Licensed serial number]
19880921.lic LIC-AP00000012265001
19880922.lic LIC-AP00000012265002

Field Description:
Field Description
Service name The name of the feature of the license file
Attribute Some features of the license file
Left days The remaining days of the expiry time of the
license file
Installed license Installed license file
Licensed serial number License code

show license hostid

Use this command to display the host ID for the license (one device).
show license hostid

Parameter
Parameter Description
Description
N/A N/A

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide This command does not require authorization. There is a unique serial number for identifying each
device.

Configuration
The following example displays the host ID for the license (one device).
Examples
Ruijie#show license hostid

6-9
Command Reference LICENSING Commands

1234942570021

show license unbind-code

Use this command to display the unbound license code on the current device.
show license unbind-code

Parameter
Parameter Description
Description
N/A N/A

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide This command does not require license.

Configuration
Examples

show license usage

Use this command to display the status of current license file in the system.
show license usage

Parameter
Parameter Description
Description
N/A N/A

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide This command does not require authorization.

Configuration
The following example displays the status of current license file in the system.
Examples
Ruijie#show license usage
Searching license in the system...
1. Service name: LIC-AP-64
Attribute: Releasable

6-10
Command Reference LICENSING Commands

[Permanent licenses] [Licensed serial number]

19880966.lic LIC-AP-6400000012264966
19880988.lic LIC-AP-6400000012264988

[Temporary license] [Licensed serial number]

19880900.lic LIC-AP-6400000012264900
(63 days left)
Field Description
Field Description
Service name The feature name of the license file
Attribute The attributes of the license file
Left days The remaining days of the expiry time of the
license file

6-11
Command Reference PKG_MGMT Commands

7 PKG_MGMT Commands

clear storage

Use this command to remove an installation package on the local device.

clear storage [ url ]

Parameter
Parameter Description
Description
A local url directory or full path name indicates where the installation
url
package is stored

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide This command is used to remove an installation package or all packages in a directory and all
installation packages on the local device.

Configuration Ruijie# clear storage

Examples Remove the whole storage directory?[y/n]y
Ruijie# clear storage usb0
Remove the file or directory usb0 from the storage?[y/n]y
Ruijie#

Verification Check specified url

Platforms N/A

patch active

Use this command to activate a patch to take effect.

patch active

Parameter
Parameter Description
Description
N/A N/A

7-1
Command Reference PKG_MGMT Commands

Defaults N/A

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide Activating operation can be performed only on the device already installed with a patch, after which
the patch really takes effect. This command can be used to activate a hot patch temporarily. The
activated patch becomes invalid after device restart.

Configuration The following example activates a patch on the box device.

Examples Ruijie# patch active
Active the patch package success

Verification Use the show patch command to display patch information.

Prompt The patch is activated successfully.

Messages Active the patch package success

The running fails and a patch package needs to be installed at first.

Patch not installed

There is no need to run the command for the patch in the activated or running status.
The patch status is already active or running

Contact the service center to solve the package problem.

Cannot find the package's scripts file

Common There is no hot patch installed on current device.

Errors The hot patch on current device is already activated.

Platforms
N/A

patch deactive

Use this command to deactivate a patch.

patch deactive

Parameter
Parameter Description
Description
N/A N/A

7-2
Command Reference PKG_MGMT Commands

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide This commandcan be performed to deactivate a patch only after the patch is in the activated status.
Configuration The following example deactivates a patch on the box device.
Examples Ruijie#patch deactive
Deactive the patch package success

Verification Use the show patch command to display patch information.

Prompt The patch is deactivated successfully.

Messages Deactive the patch package success

The running fails and a patch package needs to be installed at first.

Patch not installed

There is no need to run the command for the patch in the deactivated status.

The patch is not in active or running status

Contact the service center to solve the package problem.

Cannot find the package's scripts file

Common There is no hot patch installed on current device.

Errors The hot patch on current device is already invalid.

patch delete

Use this command to uninstall a patch.

patch delete

Parameter
Parameter Description
Description
N/A N/A

Command Privileged EXEC mode

Mode

Default Level 2

7-3
Command Reference PKG_MGMT Commands

Usage Guide This command is used to remove the existing hot patch package on the device.

Configuration The following example removes the installed hot patch package from the box device.
Examples Ruijie# patch delete
Clear the patch patch_bridge success
Clear the patch success

Verification Use the show patch command to display patch status.

Prompt The patch is uninstalled successfully.

Messages Clear the patch success

A hot patch package should be installed at first for it has not been installed.
Patch not installed

Common
There is no hot patch installed on current device.
Errors

patch running

Use this command to activate a patch permanently.

patch running

Parameter
Parameter Description
Description
N/A N/A

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide Activating operation can be performed only on the device already installed with a patch, after which
the patch really takes effect. This command can be used to activate a hot patch permanently.

Configuration The following example activates a patch on the box device.

Examples Ruijie# patch running
The patch on the system now is in running status

Verification Use the show patch command to display the patch information.

Prompt The patch is activated permanently.

Messages The patch on the system now is in running status

7-4
Command Reference PKG_MGMT Commands

The running fails and a patch package needs to be installed at first.

Patch not installed

There is no need to run the command for the patch is in the deactivated status.
The patch is not in active or running status

Contact the service center to solve the package problem.

Cannot find the package's scripts file

Common There is no hot patch on current device.

Errors The hot patch is already activated on current device.

show component

Use this command to display all components already installed on current device and their information.
show component [component _name ]

Parameter
Parameter Description
Description
Name of the components
When this parameter value is N/A, the command is used to
display all components already installed on the device and
basic information of these components.
component _name
When this parameter value is not N/A, the command is used to
display detailed information of the corresponding component,
check whether the component is intact, and check whether
this component works properly.

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide This command includes one with component_name and one without component_name. During
upgrade, it requires users to understand all components installed on current device and their version
information before components deletion. This needs to use the show component command without
component_name. The show component command with component_name is used to obtain details
of the corresponding component. The detailed information enables users to easily realize
components’ operation and damage. It is significant to insure their troubleshooting, security and
reliability.

Some components in use will change their defaults files. Though this is more possibly normal
than malicious, the show component command is used only to judge whether component files

7-5
Command Reference PKG_MGMT Commands

change in use. It is unable to distinguish natural damage from malicious one. It depends on
users to make a further judgment.

Configuration The following example displays all components already installed on the box device and their
Examples information.
Ruijie# show component
Package :sysmonit
Version:1.0.1.23cd34aa Build time: Wed Dec 7 00:58:56 2013
Size:12877 Install time :Wed Mar 5 14:23:12 2012
Description: this is a system monit package
Required packages: None
-------------------------------------------------------------------
Package:bridge
Version:2.0.1.37cd5cda Build time: Wed Dec 7 00:54:56 2013
Size:23245 Install time :Wed Mar 5 14:30:12 2012
Description: this is a bridge package
Required packages: None
-------------------------------------------------------------------
This command is used to obtain all components already installed on the device and their basic
information. The information offers a basis for users to decide whether to upgrade or delete
components.
Field Description
Package Name of the component
Version Version number of the component
Compilation time of the component on the
Build time
server
Size Content size of the component
Install time Installation time of the component
Description Simple functional description of the component
Required packages Name of required packages

The following example displays the information of specified components already installed on the box
device.
Ruijie# show component bridge
package:bridge
Version: 2.3.1.1252ea Build time: Wed Dec 7 00:54:56 2013
Size:26945 Install time : Wed Mar 19:23:15 2012
Description:this is a bridge package
Required packages: None
Package files:
/lib64
/lib64/libbridge.so
/sbin
/sbin/bridge

7-6
Command Reference PKG_MGMT Commands

Package file validate: [OK]

Required relationship verify: [OK]

The other information except the basic information of components is listed as follows.
Field Description
Checks whether the component filesare intact.
“OK” is displayed when all component files work
Package file validate properly; “ERR” is displayed together with their
names when some component files are lost or
revised.
Lists all required packages of the component.
“OK” is labeled if required components are
Required package already installed; “ERR” is labeled if not
together with detailed description about their
names and versions.
Package files Lists all files contained in the package.

Prompt The execution is successful with all components information displayed.

Messages Package :sysmonit
Version:1.0.1.23cd34aa Build time: Wed Dec 7 00:58:56 2013
Size:12877 Install time :Wed Mar 5 14:23:12 2012
Description: this is a system monit package
Required packages: None
-------------------------------------------------------------------
Package:bridge
Version:2.0.1.37cd5cda Build time: Wed Dec 7 00:54:56 2013
Size:23245 Install time :Wed Mar 5 14:30:12 2012
Description: this is a bridge package
Required packages: None
-------------------------------------------------------------------

show patch

Use this command to display the information of a hot patch package already installed on the device.
show patch [ patch _name ]

Parameter
Parameter Description
Description
Name of the patches
When this parameter value is N/A, the command is used to
patch _name
display all components already installed on the device and basic
information of these components.

7-7
Command Reference PKG_MGMT Commands

When this parameter value is not N/A, the command is used to

display detailed information of the corresponding component,
check whether the component is intact, and check whether this
component works properly.

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide This command is used to check all patches already installed on the device and their information.

Configuration The following example displays all patches already installed on the box device.
Examples Ruijie# show patch
patch package patch_install installed in the system, version:pa1
Package : patch_bridge
status:running
Version: pa1 Build time: Mon May 13 09:03:07 2013
Size: 277 Install time: Tue May 21 03:07:17 2013
Description: a patch for bridge
Required packages: None
This command is used to obtain the basic information of all patches already installed on the device.
Field Description
Package Name of the patch
status Status of the patch
Version Version of the patch
Build time Compilation time of the patch on the server
Size Content size of the patch
Install time Installation time of the patch
Description Simple functional description of the patch

The following example displays the information of particular patches installed on the box device.
Ruijie# show componentbridge
package:bridge
Version: 2.3.1.1252ea Build time: Wed Dec 7 00:54:56 2011
Size:26945 Install time : Wed Mar 19:23:15 2012
Description:this is a bridge package
Required packages: None
Package files:
/lib64
/lib64/libbridge.so
/sbin
/sbin/bridge

7-8
Command Reference PKG_MGMT Commands

Package file validate: [OK]

The other information except the basic information of the patch is listed as follows:
Field Description
Checks whether the patch files are intact. “OK”
is displayed when all patch files work properly;
Package file validate
“ERR” is displayed together with their names
when some files are lost or revised.
Package files Lists all files contained in the patch package.

Prompt The information of the patch is displayed after successful running.

Messages Patch package patch_install installed in the system, version:pa1
Package : patch_bridge
Status:running
Version: pa1 Build time: Mon May 13 09:03:07 2013
Size: 277 Install time: Tue May 21 03:07:17 2013
Description: a patch for bridge
Required packages: None

show upgrade file

Use this command to display the information of the installation package files in the device file system.
show upgrade file url

Parameter
Parameter Description
Description
The local url path indicates where an installation package file is
url
stored.

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide This command is used to preview main messages of an installation package after it is downloaded
into local file system.

This command is not applied to a chassis package.

Configuration The following example displays the information of an installation package file.
Examples Ruijie# show upgrade file flash://bridge_eg1000m_2.3.1.1252ea-1.mips.rpm
Name : bridge
Version:1.0.1.23cd34aa
Package type : common component
Support target : eg1000m

7-9
Command Reference PKG_MGMT Commands

Size : 26945
Build time : Wed Dec 7 00:54:56 2013
Install date : (not installed)
Description : this is a bridge package
Package files :
Package files:
/lib64
/lib64/libbridge.so
/sbin
/sbin/bridge
This command is used to obtain the information in the package.
Field Description
Name Name of the package
Version Version of the package
Package type Type of the package
Support target Supported product description
Size Content size of the package
Build time Compilation time of the package
Install date Installation time of the package
Description Description of the package
Package files All contents in the package

Prompt The package information is displayed after running.

Messages Name : bridge
Version:1.0.1.23cd34aa
Package type : common component
Support target : eg1000m
Size : 26945
Build time : Wed Dec 7 00:54:56 2013
Install date : (not installed)
Description : this is a bridge package
Package files :
Package files:
/lib64
/lib64/libbridge.so
/sbin
/sbin/bridge

show upgrade history

Use this command to display the upgrade history.

show upgrade history

7-10
Command Reference PKG_MGMT Commands

Parameter
Parameter Description
Description
N/A N/A

Command Privileged EXEC mode

Mode

Default Level 2

Configuration The following example displays the upgrade history.

Examples Ruijie# show upgrade history
Last Upgrade Information:
Time: 2014-08-31 12:15:03
Method: LOCAL
Package Name: N18000_RGOS11.0(1)B1_CM_01200616_install.bin
Package Type: Distribution

Prompt
N/A
Messages

Platforms N/A

upgrade

Use this command to install and upgrade an installation package in the local file system.
upgrade [url [ force ]

Parameter
Parameter Description
Description
The local path indicates where an installation package is stored.
url This command is used to upgrade an installation package on the
device.
force Mandatory upgrade

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide This command is applicable to installation packages of all subsystem components, chassis devices,
feature components and hot patches. Before its use, run the copy command to copy feature
packages into the file system in the device.

7-11
Command Reference PKG_MGMT Commands

When there is no specified range of parameters, the command is used to upgrade the matched
system components according to the auto-sync configuration.

Configuration The following example upgrades the main package on the device.
Examples Ruijie#upgrade usb0:/eg1000m_main_1.0.0.0f328e91.bin
Upgrade processing is 10%
Upgrade processing is 60%
Upgrade processing is 90%
Upgrade info [OK]
Kernel version[2.6.32.91f9d21->2.6.32.9f8b56f]
Rootfs version[1.0.0.2ad02537->1.0.0.1bcc12e8]
Upgrade processing is 100%
Reload system to take effect!

Verification Run the show version detail command to check whether the upgrade of a subsystem component is
successful.
Run the show component command to check whether the upgrade of a feature component is
successful. upgrading a feature component
Run the show patch command to check whether the upgrade of a hot patch is successful.

Prompt The prompt message of successful running is displayed.

Messages Upgrade info [OK]

The installation package is invalid or damaged and needs to be regained for upgrade command.
Invalid package file

The installation package is not available on the device and needs to be regained for upgrade
command.
Device don't support

There is no need to upgrade the device.

The version in device is newer or the same

When there is insufficient space for upgrade, check USB flash disk attached on the device.
No enough space for decompress

Contact the service center to solve the system problem.

No enough space,rootfs been destroyed. Please upgrade in uboot

The existing patch package needs to be uninstalled before upgrade.

Already exist patch, please uninstall before upgrade

The patch package is not applicable to this system and needs to be changed.
Patch compatibility err

7-12
Command Reference PKG_MGMT Commands

The upgrade of a patch package is not available on this device and needs to be regained.
some origin cmpnt has change

upgrade auto

Use this command to upgrade an installation package automatically without interrupting services on a
dual-device VSU system. While either in VSU mode or in standalone mode, one single device will
restart after this configuration, thus interrupting services.
upgrade auto url [ force ]

Parameter
Parameter Description
Description
url Installation package directory
force Enforces upgrade.

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide Use this command to upgrade the VSU system.

Download the program of the latest version to the device before running this command (by using the
copy tftp command).
During one upgrade, do not use the upgrade auto command and other upgrade commands (such as
the upgrade command) at the same time. If auto-upgrade fails, follow the system prompt to restore
the version.
Do not update the installation package (by running the copy tftp command/U disk copy) or perform
other upgrade operation (running the upgrade /upgrade auto command) repetitively.
During auto-upgrade, do not unplug the card, perform hot backup switchover, power off chassis or
change VSU software/hardware configuration.

Configuration The following example upgrades the main package automatically without interrupting the service.
Examples 2015-04-09_09-56-23 Ruijie#upgrade auto usb0:S6220_RGOS11.0(5)B1_install.bin
2015-04-09_09-56-24 Ruijie#*Jan 1 00:23:40: %7:
2015-04-09_09-56-24 *Jan 1 00:23:40: %7: [Slot 1/0]:Upgrade processing is 10%
2015-04-09_09-56-26 Ruijie#show upgrade status
2015-04-09_09-56-26 [Slot 1/0]
2015-04-09_09-56-26 dev_type: s6k
2015-04-09_09-56-26 status : upgrading
2015-04-09_09-56-26 [Slot 2/0]
2015-04-09_09-56-26 dev_type: s6k
2015-04-09_09-56-26 status : transmission

7-13
Command Reference PKG_MGMT Commands

2015-04-09_09-58-20 *Jan 1 00:25:36: %7: [Slot 2/0]:Upgrade processing is 10%

2015-04-09_09-58-30 Ruijie#show upgrade status
2015-04-09_09-58-30 [Slot 1/0]
2015-04-09_09-58-30 dev_type: s6k
2015-04-09_09-58-30 status : upgrading
2015-04-09_09-58-30 [Slot 2/0]
2015-04-09_09-58-30 dev_type: s6k
2015-04-09_09-58-30 status : upgrading
2015-04-09_09-58-39 *Jan 1 00:25:56: %7:
2015-04-09_09-58-39 *Jan 1 00:25:56: %7: [Slot 2/0]:Upgrade processing is 60%
2015-04-09_09-59-19 *Jan 1 00:26:35: %7:
2015-04-09_09-59-19 *Jan 1 00:26:35: %7: [Slot 2/0]:Upgrade processing is 90%
2015-04-09_09-59-19 *Jan 1 00:26:35: %7:
2015-04-09_09-59-19 *Jan 1 00:26:35: %7: [Slot 2/0]:
2015-04-09_09-59-19 *Jan 1 00:26:35: %7: Upgrade info [OK]
2015-04-09_09-59-19 *Jan 1 00:26:36: %7: Kernel
version[2.6.32.6b311610a8eb91->2.6.32.6b31161115502c]
2015-04-09_09-59-19 *Jan 1 00:26:36: %7: Rootfs version[1.0.0.eb75cd01->1.0.0.3d978b6c]
2015-04-09_09-59-19 *Jan 1 00:26:36: %7:
2015-04-09_09-59-19 *Jan 1 00:26:36: %7: [Slot 2/0]:Reload system to take effect!
2015-04-09_09-59-21 *Jan 1 00:26:37: %7:
2015-04-09_09-59-21 *Jan 1 00:26:37: %7: [Slot 2/0]:Upgrade processing is 100%
2015-04-09_10-00-28 Ruijie#show upgrade status
2015-04-09_10-00-28 [Slot 1/0]
2015-04-09_10-00-28 dev_type: s6k
2015-04-09_10-00-28 status : upgrading
2015-04-09_10-00-28 [Slot 2/0]
2015-04-09_10-00-28 dev_type: s6k
2015-04-09_10-00-28 status : success
2015-04-09_10-01-39 *Jan 1 00:28:56: %7:
2015-04-09_10-01-39 *Jan 1 00:28:56: %7: [Slot 1/0]:Upgrade processing is 60%
2015-04-09_10-02-17 *Jan 1 00:29:33: %7:
2015-04-09_10-02-17 *Jan 1 00:29:33: %7: [Slot 1/0]:Upgrade processing is 90%
2015-04-09_10-02-17 *Jan 1 00:29:33: %7:
2015-04-09_10-02-17 *Jan 1 00:29:33: %7: [Slot 1/0]:
2015-04-09_10-02-17 *Jan 1 00:29:34: %7: Upgrade info [OK]
2015-04-09_10-02-17 *Jan 1 00:29:34: %7: Kernel
version[2.6.32.6b311610a8eb91->2.6.32.6b31161115502c]
2015-04-09_10-02-17 *Jan 1 00:29:34: %7: Rootfs version[1.0.0.eb75cd01->1.0.0.3d978b6c]
2015-04-09_10-02-17 *Jan 1 00:29:34: %7:
2015-04-09_10-02-18 *Jan 1 00:29:34: %7: [Slot 1/0]:Reload system to take effect!
2015-04-09_10-02-19 *Jan 1 00:29:35: %7:
2015-04-09_10-02-19 *Jan 1 00:29:35: %7: [Slot 1/0]:Upgrade processing is 100%
2015-04-09_10-02-19 *Jan 1 00:29:36: %7: %PKG_MGMT:auto-sync config synchronization,

7-14
Command Reference PKG_MGMT Commands

Please wait for a moment....

2015-04-09_10-02-20 *Jan 1 00:29:36: %7:
2015-04-09_10-02-20 [ 1784.116069] rtc-pcf8563 6-0051: retrieved date/time is not valid.
2015-04-09_10-02-20 *Jan 1 00:29:36: %7: [Slot 2/0]:auto sync config: space not enough left
57229312, need 114597815
2015-04-09_10-02-20 *Jan 1 00:29:36: %7:
2015-04-09_10-02-20 *Jan 1 00:29:36: %7: [Slot 2/0]:auto sync package config err
2015-04-09_10-02-20 *Jan 1 00:29:37: %7: [Slot 1/0]
2015-04-09_10-02-21 *Jan 1 00:29:37: %7: device_name: s6k
2015-04-09_10-02-21 *Jan 1 00:29:37: %7: status: SUCCESS
2015-04-09_10-02-21 *Jan 1 00:29:37: %7: [Slot 2/0]
2015-04-09_10-02-21 *Jan 1 00:29:37: %7: device_name: s6k
2015-04-09_10-02-21 *Jan 1 00:29:37: %7: status: SUCCESS
2015-04-09_10-02-21 *Jan 1 00:29:38: %7: %Do with dtm callback....
2015-04-09_10-02-21 *Jan 1 00:29:38: %VSU-5-DTM_AUTO_UPGRADE:
Upgrading the system, wait a moment please.

upgrade download tftp

Use this command to download, install and upgrade installation packages from the tftp server.
upgrade download tftp:/path [ force ]
upgrade download oob_tftp:/path [ force ]

Parameter
Parameter Description
Description
The path of installation packages on the tftp server
path
This command is downloaded and upgraded automatically from the server.
force Enforces upgrade.

Command Privileged EXEC mode

Mode

Default Level 2

Usage Guide This command is applicable to installation packages of all subsystem components, chassis devices,
feature components and hot patches. This command is used to perform automatic installation, copy
and upgrade of files.

Configuration The following example upgrades the main package.

Examples Ruijie# upgrade download
tftp://192.168.201.98/eg1000m_main_1.0.0.0f328e91.bin

7-15
Command Reference PKG_MGMT Commands

Accessing tftp://192.168.201.98/eg1000m_main_1.0.0.0f328e91.bin...
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!
Transmission finished, file length 21525888 bytes.
Upgrade processing is 10%
Upgrade processing is 60%
Upgrade processing is 90%
Upgrade info [OK]
Kernel version[2.6.32.91f9d21->2.6.32.9f8b56f]
Rootfs version[1.0.0.2ad02537->1.0.0.1bcc12e8]
Upgrade processing is 100%
Reload to take effect!

Verification Run the show version detail command to check whether the upgrade of a subsystem component is
successful.
Run the show component command to check whether the upgrade of a feature component is
successful.
Run the show patch command to check whether the upgrade is successful of a hot patch package.

Prompt The prompt message of successful running is displayed.

Messages Upgrade info [OK];

The installation package is invalid or damaged and needs to be regained for upgrade command.
Invalid package file

The installation package is not available on the device and needs to be regained for upgrade
command.
Device don't support

There is no need to upgrade the device.

The version in device is newer or the same

When there is insufficient space for upgrade, check USB flash disk attached on the device.
No enough space for decompress

Contact the service center to solve the system problem.

No enough space,rootfs been destroyed. Please upgrade in uboot

The existing patch package needs to be deleted.

Already exist patch, please uninstall before upgrade

7-16
Command Reference PKG_MGMT Commands

The patch package is not compatible on this device. Replace the package..
Patch compatibility err

The upgrade of the patch package is not applied to the device. Regain the package.
Some origin component has change

Platform MGMT ports are supported on NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2 and
Description NBR6215-E but not on NBR6120-E.

upgrade rollback

Use this command to roll a subsystem back to the version before the upgrade.
upgrade rollback

Parameter
Parameter Description
Description
N/A N/A

Command Mode Privileged EXEC mode

Default Level 2

Usage Guide This command is used when the device cannot work properly after subsystem upgrade. It takes
effect only when the last upgrade of subsystem components is successful.

The command is valid after device restart. The recursive rollback cannot be executed
through this command in succession.

Configuration The following example rolls a subsystem back to the version before the upgrade on the box
Examples device.
Ruijie#upgrade rollback
kernel rollback version[2.6.32.9f8b56f->2.6.32.91f9d21][OK]
rootfs rollback version[1.0.0.1bcc12e8->1.0.0.2ad02537][OK]
Rollback success!
Reload system to take effect!

The following example rolls a subsystem back to the version before the upgrade on the chassis
device.
Ruijie#upgrade rollback slot M1
[Slot M1]:
kernel rollback version[2.6.32.9f8b56f->2.6.32.91f9d21][OK]
rootfs rollback version[1.0.0.1bcc12e8->1.0.0.2ad02537][OK]
Rollback success!
Reload system to take effect!

7-17
Command Reference PKG_MGMT Commands

Verification Run the show version detail command to check the result of rolling back subsystem
components after device restart.

Prompt The prompt message of successful running is displayed.

Messages Rollback success!
Restart to take effect !

The rollback operation cannot be performed when subsystem components have not been
upgraded last time.
Not subsys package last upgrade

The rollback operation cannot be performed for the last upgrade is not successful.
Last upgrade err or skip

The upgrade command has not been run or the rollback operation has been performed.
Monitor file lost

Common Errors The last upgrade is not for subsystem components, but for feature packages, hot patch packages
and so on.
Run the rollback command for subsystem once.

7-18
Command Reference CWMP Commands

8 CWMP Commands

acs password

Use this command to configure the ACS password to be authenticated for the CPE to connect to the
ACS. Use the no form of this command to cancel the configuration.
acs password { password | encryption-type encrypted-password }
no acs password

Parameter
Parameter Description
Description
password Configures the ACS user password to be authenticated for the CPE
to connect to the ACS.
encryption-type Specifies the encryption type, which can be set to 0 (indicating that no
encryption is used) or 7 (indicating that simple encryption is used).
encrypted-password Specifies the password in encrypted form.

Defaults encryption-type: 0
encrypted-password: N/A

Command CWMP configuration mode

Mode

Usage Guide Use this command to configure the ACS user password to be authenticated for the CPE to connect to
the ACS. In general, the encryption type does not need to be specified. The encryption type needs to
be specified only when copying and pasting the encrypted password of this command. A valid
password should meet the following format requirements:

The command contains English letters in upper or lower case and numeric characters.

Blanks are allowed at the beginning of the password but will be ignored. Intermediate and
ending blanks, however, are regarded as a part of the password.

Configuration The following example configures the ACS password to be authenticated for the CPE to connect to
Examples the ACS to 123.
Ruijie#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#acs password 123
Ruijie(config-cwmp)#

Related
Command Description
Commands

8-1
Command Reference CWMP Commands

show cwmp configuration Displays the current configuration of CWMP.

show cwmp status Displays the running status of CWMP.
acs username Configures the ACS username to be
authenticated for the CPE to connect to the
ACS.

Platform N/A
Description

acs url

Use this command to configure the URL of the ACS to which the CPE will connect.
Use the no form of this command to restore the default setting.
acs url url
no acs url

Parameter
Parameter Description
Description
url Specifies the URL of the ACS.

Defaults N/A

Command CWMP configuration mode

Mode

Usage Guide Use this command to configure the URL of the ACS to which the CPE will connect. If no ACS URL is
manually specified but a dynamic ACS URL is obtained through DHCP, the CPE initiates a
connection to the ACS using the dynamically obtained ACS URL. The URL of the ACS should meet
the following format requirements:
 The URL of the ACS is formatted as http://host[:port]/path or https://host[:port]/path.
 The URL of the ACS consists of at most 256 characters.

Configuration The following example specifies the URL of the ACS to http://10.10.10.1:8080/acs.
Examples Ruijie#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#acs url http://10.10.10.1:8080/acs
Ruijie(config-cwmp)#

The following example specifies the URL of the ACS to http://www.test.com/service/tr069servlet.

Ruijie#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#acs url http://www.test.com/service/tr069servlet

8-2
Command Reference CWMP Commands

Ruijie(config-cwmp)#

Related
Command Description
Commands
show cwmp configuration Displays the current configuration of CWMP.
show cwmp status Displays the running status of CWMP.

Platform N/A
Description

acs username

Use this command to configure the ACS username to be authenticated for the CPE to connect to the
ACS. Use the no form of this command to restore the default setting.
acs username username
no acs username

Parameter
Parameter Description
Description
username Configures the ACS username to be authenticated for the CPE to
connect to the ACS.

Defaults N/A

Command CWMP configuration mode

Mode

Usage Guide Configures the ACS username to be authenticated for the CPE to connect to the ACS.

Configuration The following example configures the ACS username to be authenticated for the CPE to connect to
Examples the ACS to admin.
Ruijie#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#acs username admin
Ruijie(config-cwmp)#

Related
Command Description
Commands
show cwmp configuration Displays the current configuration of CWMP.
show cwmp status Displays the running status of CWMP.
acs password Configures the ACS password to be
authenticated for the CPE to connect to the

8-3
Command Reference CWMP Commands

ACS.

Platform N/A
Description

cpe back-up
Use this command to configure the backup and restoration of the main program and configuration file
of the CPE.
Use the no form of this command to disable this function.
cpe back-up [ delay-time seconds ]
no cpe back-up

Parameter
Parameter Description
Description
seconds Specifies the delay for backup and restoration of the main program
and configuration file of the CPE, in the range from 30 to 10,000 in
the unit of seconds

Defaults The default is 60 seconds.

Command CWMP configuration mode

Mode

Usage Guide
You can configure the restoration function on a CPE, so that the CPE can restore itself from
exceptions of its main program or configuration file. Then when the CPE fails to connect to the ACS
and breaks away from the NMS after its main program or configuration file is upgraded, the previous
main program or configuration file of the CPE can be restored in time for the ACS to manage the
CPE. This kind of exception is generally caused by delivery of a wrong main program or configuration
file.

Configuration The following example disables the backup and restoration of the main program and configuration file
Examples of the CPE.
Ruijie#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#no cpe back-up
Ruijie(config-cwmp)#

Related
Command Description
Commands
show cwmp configuration Displays the current configuration of CWMP.
show cwmp status Displays the running status of CWMP.

8-4
Command Reference CWMP Commands

Platform N/A
Description

cpe back-up

Use this command to enable the CPE backup function.

Use the no form of this command to restore the default setting.
cpe back-up [delay-time seconds]
no cpe back-up

Parameter
Parameter Description
Description
seconds Sets the backup delay time (30-10,000 seconds).

Defaults The default is 60 seconds.

Command CWMP configuration mode

Mode

Usage Guide After updrading main programs or configurations, CPE cannot communicate with ACS for wrong
configuration delivery. Use this command to recover the previous programs and configurations.

Configuration The following example disables the CPE backup function.

Examples Ruijie#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#no cpe back-up
Ruijie(config-cwmp)#

Platform N/A
Description

cpe inform

Use this command to configure the periodic notification function of the CPE.
Use the no form of this command to restore the default setting
cpe inform [ interval seconds ] [ start-time time ]
no cpe inform

Parameter
Parameter Description
Description
seconds Specifies the periodical notification interval of the CPE in the range

8-5
Command Reference CWMP Commands

from 30 to 3,600 in the unit of seconds.

time Specifies the date and time for starting periodical notification in
yyyy-mm-ddThh:mm:ss format.

Defaults The default is 600 seconds.

Command CWMP configuration mode

Mode

Usage Guide Use this command to configure the periodic notification function of the CPE.

 If the time for starting periodical notification is not specified, periodical notification starts after the
periodical notification function is enabled. The notification is performed once within every
notification interval.

 If the time for starting periodical notification is specified, periodical notification starts at the
specified start time. For instance, if the periodical notification interval is set to 60 seconds and
the start time is 12:00 am next day, periodical notification will start at 12:00 am next day and
once every 60 seconds.

The narrower periodical notification interval allows the ACS to track the latest CPE status more
accurately. However, narrower periodical notification interval brings about more sessions
between the CPE and the ACS, consuming more resources of them. So the user should specify
the periodical notification interval of the CPE to a reasonable value according to the network
performance and the ACS performance.

Configuration The following example specifies the periodical notification interval of the CPE to 60 seconds.
Examples Ruijie#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#cpe inform interval 60
Ruijie(config-cwmp)#

Related
Command Description
Commands
show cwmp configuration Displays the current configuration of CWMP.
show cwmp status Displays the running status of CWMP.

Platform N/A
Description

cpe password

Use this command to configure the CPE password to be authenticated for the ACS to connect to the
CPE. Use the no form of this command to cancel the configuration.

8-6
Command Reference CWMP Commands

cpe password { password | encryption-type encrypted-password }

no cpe password

Parameter
Parameter Description
Description
password Configures the CPE user password to be authenticated for the ACS
to connect to the CPE.
encryption-type Specifies the encryption type, which can be set to 0 (indicating that
no encryption is used) or 7 (indicating that simple encryption is
used).
encrypted-password Specifies the password in encrypted form.

Defaults encryption-type: 0
encrypted-password: N/A

Command CWMP configuration mode

Mode

Usage Guide Use this command to configure the CPE user password to be authenticated for the ACS to connect
to the CPE. In general, the encryption type does not need to be specified. The encryption type needs
to be specified only when copying and pasting the encrypted password of this command. A valid
password should meet the following format requirements:

The command contains English letters in upper or lower case and numeric characters.

Blanks are allowed at the beginning of the password but will be ignored. Intermediate and
ending blanks, however, are regarded as a part of the password.

Configuration The following example configures the CPE password to be authenticated for the ACS to connect to
Examples the CPE to 123.
Ruijie#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#cpe password 123
Ruijie(config-cwmp)#

Related
Command Description
Commands
show cwmp configuration Displays the current configuration of CWMP.
show cwmp status Displays the running status of CWMP.
acs username Configures the CPE username to be
authenticated for the ACS to connect to the
CPE.

Platform N/A

8-7
Command Reference CWMP Commands

Description

cpe url

Use this command to configure the URL of the CPE to which the ACS will connect.
Use the no form of this command to restore default setting.
cpe url url
no cpe url

Parameter
Parameter Description
Description
url Specifies the URL of the CPE.

Defaults N/A

Command CWMP configuration mode

Mode

Usage Guide Use this command to configure the URL of the CPE to which the ACS will connect. If no CPE URL is
manually specified but a dynamic CPE URL is obtained through DHCP, the ACS initiates a
connection to the CPE using the dynamically obtained CPE URL. The URL of the CPE should meet
the following format requirements:
 The URL of the CPE is formatted as http://ip [: port ]/ path.
 The URL of the CPE consists of at most 256 characters.

Configuration The following example specifies the URL of the CPE to http://10.10.10.1:7547/acs.
Examples Ruijie#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#cpe url Hhttp://10.10.10.1:7547/
Ruijie(config-cwmp)#

Related
Command Description
Commands
show cwmp configuration Displays the current configuration of CWMP.
show cwmp status Displays the running status of CWMP.

Platform N/A
Description

cpe username

Use this command to configure the ACS username to be authenticated for the CPE to connect to the

8-8
Command Reference CWMP Commands

ACS.
Use the no form of this command to restore the default setting.
cpe username username
no cpe username

Parameter
Parameter Description
Description
username Configures the CPE username to be authenticated for the ACS to
connect to the CPE.

Defaults N/A

Command CWMP configuration mode

Mode

Usage Guide Configures the CPE username to be authenticated for the ACS to connect to the CPE.

Configuration The following example configures the CPE username to be authenticated for the ACS to connect to
Examples the CPE to admin.
Ruijie#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#cpe username admin
Ruijie(config-cwmp)#

Related
Command Description
Commands
show cwmp configuration Displays the current configuration of CWMP.
show cwmp status Displays the running status of CWMP.
cpe password Configures the CPE password to be
authenticated for the ACS to connect to the
CPE.

Platform N/A
Description

cwmp

Use this command to enable the CWMP function.

Use the no form of this command to disable this function.
cwmp
no cwmp

8-9
Command Reference CWMP Commands

Parameter
Parameter Description
Description
N/A N/A

Defaults By default, this function is enabled.

Command Global configuration mode

Mode

Usage Guide Use this command to enable or disable the CWMP function.

Configuration The following example disables the CWMP function.

Examples Ruijie#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#no cwmp
Ruijie(config)#

Related
Command Description
Commands
show cwmp configuration Displays the current configuration of CWMP.
show cwmp status Displays the running status of CWMP.

Platform N/A
Description

disable download

Use this command to disable the function of downloading main program and configuration files from
the ACS. Use the no form of this command to restore the default setting.
disable download
no disable download

Parameter
Parameter Description
Description
N/A N/A

Defaults By default, the CPE can download main program and configuration files from the ACS.

Command CWMP configuration mode

Mode

Usage Guide N/A

8-10
Command Reference CWMP Commands

Configuration The following example disables the function of downloading main program and configuration files
Examples from the ACS.
Ruijie#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#disable download
Ruijie(config-cwmp)#

Related
Command Description
Commands
show cwmp configuration Displays the current configuration of CWMP.
show cwmp status Displays the running status of CWMP.

Platform N/A
Description

disable upload

Use this command to disable the function of uploading configuration and log files to the ACS.
Use the no form of this command to restore the default setting.
disable upload
no disable upload

Parameter
Parameter Description
Description
N/A N/A

Defaults By default, the CPE can upload its configuration and log files to the ACS.

Command CWMP configuration mode

Mode

Usage Guide Disables the function of uploading configuration and log files to the ACS.

Configuration The following example disables the function of uploading configuration and log file to the ACS.
Examples Ruijie#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#disable upload
Ruijie(config-cwmp)#

Related
Command Description
Commands

8-11
Command Reference CWMP Commands

show cwmp configuration Displays the current configuration of CWMP.

show cwmp status Displays the running status of CWMP.

Platform N/A
Description

show cwmp configuration

Use this command to display the current configuration of CWMP.

show cwmp configuration

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privilege EXEC mode

Mode

Usage Guide

Configuration The following example displays the current configuration of CWMP.

Examples Ruijie(config-cwmp)#show cwmp configuration
CWMP Status : enable
ACS URL : http://www.ruijie.com.cn/acs
ACS username : admin
ACS password : ******
CPE URL : http://10.10.10.2:7547/
CPE username : ruijie
CPE password : ******
CPE inform status : disable
CPE inform interval : 60s
CPE inform start time : 0:0:0 0 0 0
CPE wait timeout : 50s
CPE download status : enable
CPE upload status : enable
CPE back up status : enable
CPE back up delay time : 60s
The descriptions to the fields shown after executing the command show cwmp configuration.
Field Description
CWMP Status Running status of CWMP.
ACS URL URL of the ACS

8-12
Command Reference CWMP Commands

ACS username to be authenticated for the CPE

ACS username
to connect to the ACS.
ACS password to be authenticated for the CPE
ACS password
to connect to the ACS.
CPE URL URL of the CPE
CPE username to be authenticated for the ACS
CPE username
to connect to the CPE.
CPE password to be authenticated for the ACS
CPE pass ord
to connect to the CPE.
CPE inform status Status of CPE periodical notification function.
CPE inform interval CPE periodical notification interval.
CPE wait timeout Timeout period of CPE sessions.
CPE inform start time The start time of periodical notification.
Indicates whether to download main program
CPE download status
and configuration files from the ACS.
Indicates whether to upload configuration files
CPE upload status
and log files to the ACS.
Indicates whether backup and restoration of the
CPE back up status
main program and configuration file is enabled.
Delay time of the backup and restoration of the
CPE back up delay time
main program and configuration files.

Related
Command Description
Commands
show cwmp status Displays the running status of CWMP.

Platform N/A
Description

show cwmp status

Uses this command to display the running status of CWMP

show cwmp status

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

8-13
Command Reference CWMP Commands

Usage Guide N/A

Configuration The following example displays the running status of CWMP.

Examples Ruijie#show cwmp status
CWMP Status : enable
Session status : Close
Last success session : Unknown
Last success session time : Thu Jan 1 00:00:00 1970
Last fail session : Unknown
Last fail session time : Thu Jan 1 00:00:00 1970
Session retry times : 0
The descriptions to the fields shown after executing the command show cwmp configuration.
Field Description
CWMP Status The running status of CWMP
The current status of the session between the
Session status
CPE and the ACS
Last success session The last success session type
Last success session time The last success session time
Last fail session The last failed session type
Last fail session time The last failed session time
Session retry times The number of session retransmission attempts

Related
Command Description
Commands
show cwmp configuration Displays the current configuration of CWMP.

Platform N/A
Description

timer cpe-timeout

Uses this command to configure the session timeout period of the CPE.
timer cpe- timeout seconds
no timer cpe-timeout

Parameter
Parameter Description
Description
seconds Sets the session timeout, in the range from 10 to 600 in the unit of
seconds.

Defaults By default, the session timeout period is 30 seconds.

Command CWMP configuration mode

8-14
Command Reference CWMP Commands

Mode

Usage Guide Use this command to configure the session timeout period of the CPE.
The maximum waiting period that the CPE has when the CPE failed to receive the ACS reply.

Configuration The following example configures the session timeout period of the CPE to 50 seconds.
Examples Ruijie#config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#cwmp
Ruijie(config-cwmp)#timer cpe-timeout 50
Ruijie(config-cwmp)#

Related
Command Description
Commands
show cwmp configuration Displays the current configuration of CWMP.
show cwmp status Displays the running status of CWMP.

Platform N/A
Description

8-15
Command Reference Syslog Commands

9 Syslog Commands

clear logging

Use this command to clear the logs from the buffer in privileged EXEC mode.

clear logging

Parameter Parameter Description

Description N/A N/A

Defaults N/A

Command
Privileged EXEC mode
Mode

Usage Guide This command clears the log packets from the memory buffer. You cannot clear the statistics of the
log packets.

Configuration The following example clears the log packets from the memory buffer.
Examples Ruijie# clear logging

Related Command Function

Commands logging on Turns on the log switch.
show logging Displays the logs in the buffer.
logging buffered Records the logs in the memory buffer.

Platform
N/A
Description

logging

Use this command to send the log message to the specified syslog server.
logging { ip-address } [ udp-port port ]
Use this command to delete the specified syslog server.
no logging { ip-address }
Use this command to restore the default port 514.
no logging { ip-address } udp-port

Parameter
Parameter Description
Description

9-1
Command Reference Syslog Commands

ip-address Sets the IP address of the host receiving log messages.

Sets the port number of the host receiving log messages. The default
udp-port port
is 514.

Defaults No log message is sent to syslog server by default.

Command Global configuration mode

Mode

Usage Guide This command is used to configure a syslog server to receive log messages from the device. You can
configure up to five syslog servers, log messages are sent to all configured syslog servers
simultaneously,

Configuration The following example configures a syslog server with IP address 202.101.11.1.
Examples Ruijie(config)# logging 202.101.11.1
The following example configures a syslog server with IP address 10.1.1.100 and port number 8099.
Ruijie(config)# logging 202.101.11.1 udp-port 8099

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

logging buffered

Use this command to set the memory buffer parameters (log severity, buffer size) for logs at global
configuration layer. Use the no form of the command to disable recording logs in the memory buffer. Use
the default form of this command to restore the default setting.

logging buffered [ buffer-size | level ]

no logging buffered

default logging buffered

Parameter Parameter Description

Description buffer-size Size of the buffer, from 4 K to 128 K Bytes.
Severity of logs, from 0 to 7. The name of the severity or the
level
numeral can be used.

Defaults The buffer size is 4 K Bytes

The log severity is 7.

9-2
Command Reference Syslog Commands

Command
Mode Global configuration mode

Usage Guide The memory buffer for log is used in recycled manner. That is, when the memory buffer with the
specified size is full, the oldest information will be overwritten. To show the log information in the
memory buffer, run the show logging command in privileged user mode.
The logs in the memory buffer are temporary, and will be cleared in case of device restart or the
execution of the clear logging command in privileged user mode. To trace a problem, it is required
to record logs in flash or send them to Syslog Server.
The log information is classified into the following 8 levels (Table 1):
Table-1
Keyword Level Description

Emergency case, system cannot run

Emergencies 0
normally

Alerts 1 Problems that need immediate remedy

Critical 2 Critical conditions

Errors 3 Error message

warnings 4 Alarm information

Information that is normal but needs

Notifications 5
attention

informational 6 Descriptive information

Debugging 7 Debugging messages

Lower value indicates higher level. That is, level 0 indicates the information of the highest level.
When the level of log information to be displayed on devices is specified, the log information at or
below the set level will be allowed to be displayed.

After running the system for a long time, modifying the log buffer size especially in condition of
large buffer may fails due to the insufficent availble continuous memory. The failure message
will be shown. It is recommended to modify the log buffer size as soon as the system starts.

Configuration The following example allows logs at and below severity 6 to be recorded in the memory buffer sized
Examples 10,000 bytes.
Ruijie(config)# logging buffered 10000 6

Related Command Description

Commands logging on Turns on the log switch.
show logging Displays the logs in the buffer.
clear logging Clears the logs in the log buffer.

Platform N/A

9-3
Command Reference Syslog Commands

Description

logging console

Use this command to set the severity of logs that are allowed to be displayed on the console in global
configuration mode. Use the no form of this command to prohibit printing log messages on the console.

logging console [ level ]

no logging console

Parameter Parameter Description

Description Severity of log messages, 0 to 7. The name of the severity or
level the numeral can be used. For the details of log severity, see
table 1.

Defaults The default is debugging (7).

Command
Global configuration mode
Mode

Usage Guide When a log severity is set, the log messages at or below that severity will be displayed on the
console.
The show logging command displays the related setting parameters and statistics of the log.
The log information is classified into the following 8 levels (Table 2):
Table-2
Keyword Level Description

Emergencies 0 Emergency case, system cannot run normally

Alerts 1 Problems that need immediate remedy

Critical 2 Critical conditions

Errors 3 Error message

warnings 4 Alarm information

Notifications 5 Information that is normal but needs attention

informational 6 Descriptive information

Debugging 7 Debugging messages

Configuration The following example sets the severity of log that is allowed to be displayed on the console as 6:
Examples Ruijie(config)# logging console informational

Related Command Description

9-4
Command Reference Syslog Commands

Commands logging on Turns on the log switch.

Displays the logs and related log configuration parameters
show logging
in the buffer.

Platform
N/A
Description

logging count

Use this command to enable the log statistics function in global configuration mode. Use the no form of
this command to restore the default setting.

logging count

no logging count

Parameter Parameter Description

Description
N/A N/A

Defaults The log statistics function is disabled by default.

Command
Global configuration mode
Mode

Usage Guide This command enables the log statistics function. The statistics begins when the function is enabled.
If you run the no logging count command, the statistics function is disabled and the statistics data is
deleted.

Configuration The following example enables the log statistics function:

Examples Ruijie(config)# logging count

Related Command Description

Commands show logging count Displays log information about modules of the system.
Displays basic configuration of log modules and log
show logging
information in the buffer.

Platform
N/A
Description

logging delay-send file

Use this command to set the name of the log file saved locally for delay sending. Use the no form of
this command to restore the default setting.

9-5
Command Reference Syslog Commands

logging delay-send file flash:filename

no logging delay-send file

Parameter
Parameter Description
Description
flash:filename Sets the name of the log file saved locally for delay sending.

Defaults The default name format is as follows: file size_device IP address_index.txt. If you want to change the
file name, the file sent to the remote server should be named as follows: prefix_ file size_device IP
address_index.txt; the file saved locally should be named as follows: prefix_index.txt. The default
prefix is syslog_ftp_server.

Command Global configuration mode

Mode

Usage Guide The file name cannot contain special symbols including . \/ : * ” < > and |.
For example, the file name is log_server, file index 5, file size 1000B and device IP address 10.2.3.5.
The log file sent to the remote server is named log_server_1000_10.2.3.5_5.txt and the log file saved
locally is named log_server_5.txt.
If the device has an IPv6 address, the colon (:) in the IPv6 address is replaced by the hyphen (-).
For example, the is log_server, file index 6, file size 1000B and device IPv6 address 2001::1. The log
file sent to the remote server is named log_server_1000_2001-1_6.txt and the log file saved locally is
named log_server_6.txt.

Configuration The following example sets the name of the log file saved locally to log_server.
Examples Ruijie(config)# logging delay-send file flash:log_server

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

logging delay-send interval

Use this command to set the interval at which log sending is delayed. Use the no form of this
command to restore the default setting.
logging delay-send interval seconds
no logging delay-send interval

Parameter Parameter Description

9-6
Command Reference Syslog Commands

Description
Sets the interval at which log sending is delayed, in the range from
seconds
600 to 65535 seconds.

Defaults The default is 3600.

Command Global configuration mode

Mode

Usage Guide N/A

Configuration The following example sets the the interval at which log sending is delayed to 600 seconds.
Examples Ruijie(config)# logging delay-send interval 600

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

logging delay-send server

Use this command to configure the serve address and log sending mode. Use the no form of this
command to restore the default setting.
logging delay-send server { [ oob ] ip-address | ipv6 ipv6-address } mode { ftp user username
password [ 0 | 7 ] password | tftp }
no logging delay-send server { [ oob ] ip-address | ipv6 ipv6-address }

Parameter
Parameter Description
Description
Indicates that logs are sent to the server through the MGMT port. It is
oob
required that the device have the MGMT port.
ip-address Specifies the IP address of the server.
ipv6 ipv6-address Specifies the IPv6 address of the server.
username Sets the FTP server username.
password Sets the FTP server password.
0 (Optional) The password is displayed in plaintext.
7 The password are encrypted.

Defaults This function is disabled by default,

Command Global configuration mode

9-7
Command Reference Syslog Commands

Mode

Usage Guide This command is used to specify an FTP/TFTP server to receive logs. You can configure five
FTP/TFTP servers. Logs are sent to all configured servers simultaneously.

Configuration The following example specifies an FTP server whose IP address is 192.168.23.12, username admin
Examples and password admin,
Ruijie(config)# logging delay-send server 192.168.23.12 mode ftp user admin
password admin
The following example specifies a TFTP server whose IPv6 address is 2000::1.
Ruijie(config)# logging delay-send server ipv6 2000::1 mode tftp

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

logging delay-send terminal

Use this command to enable delay in sending logs to console and remote terminal. Use the no form
of this command to restore the default setting.
logging delay-send terminal
no logging delay-send terminal

Parameter
Parameter Description
Description
N/A N/A

Defaults This function is disabled by default.

Command Global configuration mode

Mode

Usage Guide N/A

Configuration The following example enables delay in sending logs to console and remote terminal.
Examples Ruijie(config)# logging delay-send terminal

Related
Command Description
Commands
N/A N/A

9-8
Command Reference Syslog Commands

Platform
N/A
Description

logging facility

Use this command to configure the device value of the log information in global configuration mode. Use
the no form of the command to restore the default setting.

logging facility facility-type

no logging facility

Parameter Parameter Description

Description Syslog device value. For specific settings, refer to the usage
facility-type
guide.

Defaults The default is 23 if the RFC5424 format is enabled (Local7, local use).
The default is 16 if the RFC5424 format is disabled (Local0, local use).

Command
Global configuration mode
Mode

Usage Guide The following table (Table-2) is the possible device values of Syslog:
Numerical Code Facility

0 (kern) Kernel messages

1 (user) User-level messages

2 (mail) Mail system

3 (daemon) System daemons

4 (auth1) security/authorization messages

5 (syslog) Messages generated internally by syslogd

6 (lpr) Line printer subsystem

7 (news) USENET news

8 (uucp) Unix-to-Unix copy system

9 (clock1) Clock daemon

10 (auth2) security/authorization messages

11 (ftp) FTP daemon

12 (ntp) NTP subsystem

13 (logaudit) log audit

14 (logalert) log alert

15 (clock2) clock daemon

9-9
Command Reference Syslog Commands

16 (local0) Local use

17 (local1) Local use

18 (local2) Local use

19 (local3) Local use

20 (local4) Local use

21 (local5) Local use

22 (local6) Local use

23 (local7) Local use

The default device value of RGOS is 23 (local 7).

Configuration The following example sets the device value of Syslog as kernel:
Examples Ruijie(config)# logging facility kern

Related Command Description

Commands Sets the severity of logs that are allowed to be displayed
logging console
on the console.

Platform
N/A
Description

logging file

Use this command to save log messages in the log file, which can be saved in hardware disk,
expanded FLASH, USB. Use the no form of this command to restore the default setting,
logging file { sata0:filename | flash:filename | usb0:filename | usb1:filename } [ max-file-size ]
[ level ]
no logging file

Parameter
Parameter Description
Description
sata0: Saves the log file in hardware disk.
flash Saves the log file in expanded FLASH.
Saves the log file in USB0. This parameter is supported by the device
usb0
with one USB connector and the USB extension device.
Saves the log file in USB1, This parameter is supported by the device
usb1
with two USB connectors and the USB extension device.
filename Sets the file name. The file type is omitted, which is fixed as txt.
Sets the maximum file size, in the range from 128K to 6M bytes, The
max-file-size
default is 128K,
Sets the level of the log message saved in the log file, which can be
level
either the level name or the level number. The default is 6. See

9-10
Command Reference Syslog Commands

Usage Guide for details.

Defaults Log messages are not saved in expanded FLASH by default.

Command Global configuration mode

Mode

Usage Guide You can save log messages in expanded FLASH if you don’t want to transmit log messages on the
network or there is no syslog server,
The log file cannot be configured with the suffix, which is fixed as txt.

If there is no expanded FLASH, the logging file flash command is hidden automatically and
cannot be configured.

Keyword Level Description

Emergency case. The system fails to

Emergencies 0
run.

Problem that call for immediate

Alerts 1
solution.

Critical 2 Critical message.

Errors 3 Error message.

warnings 4 Alarm message.

message that is normal but calls for

Notifications 5
attention.

informational 6 Descriptive message.

Debugging 7 Debugging message

Configuration The following example saves the log message in expanded FLASH and sets file name, file size and
Examples log level to syslog.txt, 128K and 6 respectively.
Ruijie(config)# logging file flash:syslog

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

logging file numbers

Use this command to set the number of log files written into FLASH. Use the no form of this
command to restore the default setting.
logging file numbers numbers

9-11
Command Reference Syslog Commands

no logging file numbers

Parameter
Parameter Description
Description
Sets the number of log files written into FLASH, in the range from 2 to
numbers
32.

Defaults The default is 16.

Command Global configuration mode

Mode

Usage Guide The system does not delete previously generated log files even if you change this configuration,
Therefore, you need to delete the log files manually to save FLASH size (you can send log files to the
server through TFTP before that). For example, 16 log files are generated by default before you want
to change the number to 2. New logs are overwritten constantly in log files indexed 0 to 1. However,
log files indexed from 2 to 16 remain. You can delete these log files manually as needed.

Configuration The following example sets the number of log files written into FLASH to 8.
Examples Ruijie(config)# logging file numbers 8

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

logging filter direction

Use this command to filter the log messages destined to a certain direction. Use the no form of this
command to restore the default setting.
logging filter direction { all | buffer | file | server | terminal }
no logging filter direction { all | buffer | file | server | terminal }

Parameter
Parameter Description
Description
Log messages destined to all directions are filtered, including
all
console, VTY terminal, log buffer, log file and log server.
Log messages destined to the log buffer are filtered, including log
buffer
messages displayed by running the show logging command.
file Log messages destined to the log file are filtered.
server Log messages destined to the log server are filtered.

9-12
Command Reference Syslog Commands

Log messages destined to the console and the VTY terminal

terminal
(including Telnet and SSH).

Defaults Log messages destined to all directions are filtered by default.

Command Global configuration mode

Mode

Usage Guide In general, log messages destined to all directions are filtered, including console, VTY terminal, log
buffer, log file and log server. If you want to filter log messages destined to a certain direction, the
terminal for instance, configure the terminal parameter.

Configuration The following example filters log messages destined to the terminal (including the console and the
Examples VTY terminal).
Ruijie(config)# logging filter direction terminal

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

logging filter rule

Use this command to configure the filter rule of the log message,
logging filter rule { exact-match module module-name mnemonic mnemonic-name level level |
single-match [ level level | mnemonic mnemonic-name | module module-name ] }
Use this command to delete the “exact-match” filter rule.
no logging filter rule exact-match [ module module-name mnemonic mnemonic-name level
level ]
Use this command to delete the “single-match” filter rule.
no logging filter rule single-match [ level level | mnemonic mnemonic-name | module
module-name ]

Parameter
Parameter Description
Description
exact-match Exact-match filter rule. Fill in all the following three parameters.
single-match Single-match filter rule. Fill in one of the following three parameters.
module module-name Module name.
mnemonic mnemonic-name Mnemonic name.
level level Log level.

9-13
Command Reference Syslog Commands

Defaults No filter rule is configured by default.

Command Global configuration mode

Mode

Usage Guide If you want to filter a specific log message, use the “exact-match” filter rule and fill in all three
parameters, namely, module name, mnemonic name and log level.
If you want to filter a specific kind of log messages, use the “single-match” filter rule and fill in one of
three parameters, namely, module name, mnemonic name and log level.
When configured with the same module name, mnemonic name or log level, the “single-match” filter
rule has a higher priority than the “exact-match” filter rule.

Configuration The following example configures the “exact-match” filter rule with parameters of module name
Examples LOGIN, log level 5 and mnemonic name LOGOUT.
Ruijie(config)# logging filter rule exact-match module LOGIN mnemonic LOGOUT
level 5
The following example configures the “single-match” filter rule with the parameter of module name
SYS.
Ruijie(config)# logging filter rule single-match module SYS

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

logging filter type

Use this command to configure the filter type of log messages. Use the no form of this command to
restore the default setting.
logging filter type { contains-only | filter-only }
no logging filter type

Parameter
Parameter Description
Description
contains-only The log message containing the key word of the filter rule is printed.
filter-only The log message containing the key word of the filter rule is filtered.

Defaults The default filter type is filter-only.

Command Global configuration mode

Mode

9-14
Command Reference Syslog Commands

Usage Guide 1. When too many log messages are printed, the terminal screen keeps being refreshed. If you are
not concerned with these log messages, use the “filter-only” filter type to filter the log messages,
2. If you are concerned with certain log messages, use the “contains-only” filter type to print log
messages containing the key word of the filter rule, so as to monitor whether certain events
happen.

In real operation, the contains-only and the fitler-only filter types cannot be configured at the
same time.

If you configure the filter direction and the filter type without configuring the filter rule, the log
messages are not filtered.

Configuration The following example sets the filter type to contains-only.

Examples Ruijie(config)# logging filter type contains-only

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

logging flash flush

Use this command to write log messages in the system buffer into the flash file immediately.
logging flash flush

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Global configuration mode

Mode

Usage Guide In general, the log messages are cached in the log buffer. Only when the buffer is full or the timer
expires are log messages written into the flash file. This command is used to write log messages in
the system buffer into the flash file immediately.

The logging flash flush command takes effect only once for each configuration. The log
messages cached in the buffer are written into the flash file immediately after configuration.

Configuration The following example writes log messages in the system buffer into the flash file immediately.
Examples Ruijie(config)# logging flash flush

9-15
Command Reference Syslog Commands

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

logging flash interval

Use this command to set the interval to write log messages into the flash file, Use the no form of this
command to restore the default setting.
logging flash interval seconds
no logging flash interval

Parameter
Parameter Description
Description
interval seconds The interval to write log messages into the flash file, in the range from
1 to 57840 in the unit of seconds.

Defaults The default is 3600.

Command Global configuration mode

Mode

Usage Guide This command is used to set the interval to write log messages into the flash file. The timer starts
after configuration, If you want to restore the interval to 3600 seconds, use the no logging flash
interval command.

To avoid writing log messages into the flash file too frequently, it is not recommended to set a
short interval.

Configuration The following example sets the interval to write log messages into the flash file to 300 seconds.
Examples Ruijie(config)# logging flash interval 300

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

9-16
Command Reference Syslog Commands

logging life-time

Use this command to configure the preservation duration of logs in expanded FLASH. Use the no
form of this command to restore the default setting.
logging life-time level level days
no logging life-time level level

Parameter
Parameter Description
Description
Sets the log level, which can be either the level name or the level
level
number.
days Sets the preservation duration of logs.

Defaults No preservation duration is set by default.

Command Global configuration mode

Mode

Usage Guide Due to difference in expanded FLASH size and log level, logs with different levels can be configured
with different preservation durations.

Once log preservation based on time is enabled, log preservation based on file size is disabled
automatically. The log files are stored under the syslog/ directory of the expanded FLASH,

Configuration The following example sets the preservation duration of logs whose level is 6 to 10 days.
Examples Ruijie(config)# logging life-time level 6 10

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

logging monitor

Use this command to set the severity of logs that are allowed to be displayed on the VTY window (telnet
window, SSH window, etc.) in global configuration mode. Use the no form of this command to disable
this function.

logging monitor [ level ]

no logging monitor

Parameter Parameter Description

9-17
Command Reference Syslog Commands

Description Severity of the log message. The name of the severity or the
level numeral can be used. For the details of log severity, see
Table-1.

Defaults The default is debugging (7).

Command
Global configuration mode
Mode

Usage Guide To print log information on the VTY window, run the terminal monitor command in privileged EXEC
mode. The level of logs to be displayed is defined by logging monitor.
The log level defined with "Logging monitor" is for all VTY windows.
The log information is classified into the following 8 levels:

Keyword Level Description

Emergencies 0 Emergency case, system cannot run normally

Alerts 1 Problems that need immediate remedy

Critical 2 Critical conditions

Errors 3 Error message

warnings 4 Alarm information

Notifications 5 Information that is normal but needs attention

informational 6 Descriptive information

Debugging 7 Debugging messages

Configuration The following example sets the severity of log that is allowed to be printed on the VTY window as 6:
Examples Ruijie(config)# logging monitor informational

Related Command Description

Commands logging on Turns on the log switch.
Displays the log messages and related log configuration
show logging
parameters in the buffer.

Platform N/A
Description

logging on

Use this command globally to allow logs to be displayed on different devices. Use the no form of this
command to disable this fucntion.

9-18
Command Reference Syslog Commands

logging on

no logging on

Parameter Parameter Description

Description
N/A N/A

Defaults Logs are allowed to be displayed on different devices.

Command
Global configuration mode
Mode

Usage Guide Log information can not only be shown in the Console window and VTY window, but also be
recorded in different equipments such as the memory buffer, the expanded FLASH and the Syslog
Server. This command is the total log switch. If this switch is turned off, no log will be displayed or
recorded unless the severity level is greater than 1.

Configuration The following example disables the log switch on the device.
Examples Ruijie(config)# no logging on

Related Command Description

Commands logging buffered Records the logs to a memory buffer.
logging server Sends logs to the Syslog server.
logging file flash: Records logs on the expanded FLASH.
logging console Allows the log level to be displayed on the console.
Allows the log level to be displayed on the VTY window
logging monitor
(such as telnet window) .
logging trap Sets the log level to be sent to the Syslog server.

Platform
N/A
Description

logging policy

Use this command to configure the severity ranking policy. Use the no form of this command to
remove one policy, Use the no logging policy command to remove all policies.
logging policy module module-name [ not-lesser-than ] level direction { all | server | file |
console | monitor | buffer }
no logging policy module module-name [ not-lesser-than ] level direction { all | server | file |
console | monitor | buffer }
no logging policy

Parameter Parameter Description

9-19
Command Reference Syslog Commands

Description
module-name The name of the module applying the ranking policy.
If this parameter is specified, only when the log’s level is not lower
than the configured level can the log be sent. Otherwise, the log is
filtered.
not-lesser-than
If this parameter is not specified, only when the log’s level is not
higher than the configured level can the log be sent. Otherwise, the
log is filtered.
level Severity level
all Applies the ranking policy in all directions.
server Applies the ranking policy to the direction toward the server.
file Applies the ranking policy to the direction toward the log file.
console Applies the ranking policy to the direction toward the console.
monitor Applies the ranking policy to the direction toward the remote server.
buffer Applies the ranking policy to the direction toward the buffer.

Defaults This function is disabled by default.

Command Global configuration mode

Mode

Usage Guide This command is used to send logs to different destinations based on module and severity.

Configuration The following example sends logs of the SYS module leveled above 5 to the console and sends logs
Examples of the SYS module leveled below 3 to the buffer.
Ruijie(config)# logging policy module SYS not-lesser-than 5 direction console
Ruijie(config)# logging policy module SYS 3 direction buffer

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

logging rate-limit

Use this command to enable log rate limit function to limit the output logs in a second in the global
configuration mode. Use the no form of this command to disable this function.

logging rate-limit { number | all number | console { number | all number } } [ except severity ]

no logging rate-limit

Parameter Parameter Description

9-20
Command Reference Syslog Commands

Description The number of logs that can be processed in a second in the

number
range from 1 to 10000.
all Sets rate limit to all the logs with severity level 0 to 7.
Sets the amount of logs that can be shown in the console in a
console
second.
By default, the severity level is error (3). The rate of the log
except whose severity level is less than or equal to error (3) is not
controlled.
Log severity level in the range from 0 to 7. The lower the level
severity
is, the higher the severity is.

Defaults The log rate limit function is disabled by default.

Command
Global configuration mode
Mode

Usage Guide Use this command to control the syslog outpt to prevent the massive log output.

Configuration The following example sets the number of the logs (including debug) that can be processed in a
Examples second as 10. However, the logs with warning or higher severity level are not controlled:
Ruijie(config)#logging rate-limit all 10 except warnings

Related Command Description

Commands show logging count Displays log information about modules of the system.
Displays basic configuration of log modules and log
show logging
information in the buffer.

Platform
N/A
Description

logging server

Use this command to send the logs to the specified Syslog Sever in global configuration mode. Use the
no form of this command to remove the setting. Use the default form of this command to restore the
default setting.

logging server [ oob ] { ip-address } | ipv6 ipv6-address } [ udp-port port ]

no logging server [ oob ] { ip-address | ipv6 ipv6-address }

no logging server { ip-address | ipv6 ipv6-address } udp-port

Parameter Parameter Description

Description oob Specifies out-of-band communication for the logging server.

9-21
Command Reference Syslog Commands

(logs are sent through the MGMT port to the logging server.)
ip-address IP address of the host that receives log information.
ip-address IP address of the host that receives log information.

Specifies the port number for the specified host (The default
udp-port port
port number is 514).

Defaults No log is sent to any syslog server by default.

Command
Global configuration mode
Mode

Usage Guide This command specifies a Syslog server to receive the logs of the device. Users are allowed to
configure up to 5 Syslog Servers. The log information will be sent to all the configured Syslog Servers
at the same time.

Configuration The following example specifies a syslog server of the address 202.101.11.1:
Examples Ruijie(config)# logging server 202.101.11.1

Related Command Description

Commands logging on Turns on the log switch.
Displays log messages and related log configuration
show logging
parameters in the buffer.
logging trap Sets the level of logs allowed to be sent to Syslog server.

Platform MGMT ports are supported on NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2 and
Description NBR6215-E but not on NBR6120-E.

logging server filter

Use this command to configure an exact matching rule for filtering log messages sent from the local
device to the server.
logging server filter rule exact-match module module-name mnemonic mnemonic-name level num
Use the no form of this command to delete an exact matching rule for filtering log messages sent from the
local device to the server.
no logging server filter rule exact-match module module-name mnemonic mnemonic-name level
num
Use this command to configure a fuzzy matching rule for filtering log messages sent from the local device
to the server.
logging server filter rule single-match { module module-name } | { mnemonic mnemonic-name } |

9-22
Command Reference Syslog Commands

{ level num }
Use the no form of this command to delete a fuzzy matching rule for filtering log messages sent from the
local device to the server.
no logging server filter rule single-match { module module-name } | { mnemonic mnemonic-name } |
{ level num }

Parameter
Parameter Description
Description
module-name Module name.
mnemonic-name Module mnemonic name.
num Log level.

Defaults N/A

Command Global configuration mode

Mode

Default Level 14

Usage Guide This command allows you to configure the log messages to be sent to the syslog server in audit mode.
Only the log messages that meet the filter criteria are sent to the syslog server.

Configuration The following example configures an exact matching rule for log filtering in audit mode to enable log
Examples messages with the module name DHCP, module mnemonic name DHCP_LOG, and log level 5
(WARNING) to be sent to the syslog server.

Ruijie#config

Enter configuration commands, one per line. End with CNTL/Z.

Ruijie(config)# logging server mode audit

Ruijie(config)# logging server filter rule exact-match module DHCP mnemonic

DHCP_LOG level 5

The following example configures a fuzzy matching rule for log filtering in audit mode to enable log
messages with the module name DHCP to be sent to the syslog server.

Ruijie#config

Enter configuration commands, one per line. End with CNTL/Z.

Ruijie(config)# logging server mode audit

Ruijie(config)# logging server filter rule single-match module DHCP

The following example configures a fuzzy matching rule for log filtering in audit mode to enable log
messages with the module mnemonic name DHCP_LOG to be sent to the syslog server.

Ruijie#config

Enter configuration commands, one per line. End with CNTL/Z.

9-23
Command Reference Syslog Commands

Ruijie(config)# logging server mode audit

Ruijie(config)# logging server filter rule single-match mnemonic DHCP_LOG

The following example configures a fuzzy matching rule for log filtering in audit mode to enable log
messages with the log level 6 (INFO) to be sent to the syslog server.

Ruijie#config

Enter configuration commands, one per line. End with CNTL/Z.

Ruijie(config)# logging server mode audit

Ruijie(config)# logging server filter rule single-match level 6

Verification Run the show running-config command to display configured filtering rules.

Notifications N/A

Common
N/A
Errors

Platform
N/A
Description

logging server mode

Use this command to configure the mode for sending log messages to the syslog server.
logging server mode { normal | audit }
Use the no form of this command to cancel the configuration and restore the common mode.
no logging server mode
Parameter
Parameter Description
Description
Specifies the common mode. In this mode, log messages that are not filtered
normal
out are sent to the syslog server.
Specifies the audit mode. In this mode, only log messages that meet the
audit
server filter criteria are sent to the syslog server.

Defaults The common mode is used by default.

Command Global configuration mode

Mode

Default Level 14

Usage Guide In common mode, log messages with a log level higher than 7 (DEBUG), which are typically displayed on
serial ports and TTYs, are also sent to the syslog server.
In common mode, the filter configured in the logging filter command is used. In audit mode, the filter
configured in the logging server filter command is used, which does not take effect in common mode.

9-24
Command Reference Syslog Commands

Configuration The following example enables the audit mode to send only log messages of interest to the syslog server.
Examples Ruijie#config

Enter configuration commands, one per line. End with CNTL/Z.

Ruijie(config)# logging server mode audit

Verification Run the show running-config command to display the mode configured for sending log messages to the
syslog server.

Notifications N/A

Common
N/A
Errors

Platform
N/A
Description

logging source interface

Use this command to configure the source interface of logs in global configuration mode. Use the no
form of this command to restore the default setting.

logging source interface interface-type interface-number

no logging source interface

Parameter Description
Parameter
interface-type Interface type.
Description
interface-number Interface number.

Defaults No source interface is configured by default.

Command
Global configuration mode
Mode

Usage Guide By default, the source address of the log messages sent to the syslog server is the address of the
sending interface. For easy tracing and management, this command can be used to fix the source
address of all log messages as an interface address, so that the administrator can identify which
device is sending the message through the unique addresses. If the source interface is not
configured on the device, or no IP address is configured for the source interface, the source address
of the log messages is the address of the sending interface.

Configuration The following example specifies loopback 0 as the source address of the syslog messages:
Examples Ruijie(config)# logging source interface loopback 0

9-25
Command Reference Syslog Commands

Related Command Description

Commands logging server Sends logs to the Syslog server.

Platform
N/A
Description

logging source ip

Use this command to configure the source IP address of logs in global configuration mode. Use the no
form of this command to restore the default setting.

logging source {ip ip-address }

no logging source { ip }

Parameter Parameter Description

Description Specifies the source IPV4 address sending the logs to IPV4
ip-address
log server.

Defaults No source address is configured by default.

Command
Global configuration mode
Mode

Usage Guide By default, the source address of the log messages sent to the syslog server is the address of the
sending interface. For easy tracing and management, this command can be used to fix the source
address of all log messages as an address, so that the administrator can identify which device is
sending the message through the unique addresses. If this IP address is not configured on the
device, the source address of the log messages is the address of the sending interface.

Configuration The following example specifies 192.168.1.1 as the source address of the syslog messages:
Examples Ruijie(config)# logging source ip 192.168.1.1

Related Command Description

Commands logging server Sends the logs to the Syslog server.

Platform
N/A
Description

logging statistic enable

Use this command to enable logging periodically. Use no form of this command to restore the default
setting.
logging statistic enable

9-26
Command Reference Syslog Commands

no logging statistic enable

Parameter
Parameter Description
Description
N/A N/A

Defaults This function is disabled by default.

Command Global configuration mode

Mode

Usage Guide This command is used to send performance statistics at a certain interval for the server to monitor the
system performance.

Configuration The following example enables logging periodically.

Examples Ruijie(config)# logging statistic enable

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

logging statistic interval

Use this command to configure the interval at which logs are sent. Use the no form of this command
to restore the default setting.
logging statistic mnemonic mnemonic interval minutes
no logging statistic mnemonic mnemonic

Parameter
Parameter Description
Description
mnemonic Sets the mnemonics to identify the object.
minutes Sets the interval at which logs are sent, in the unit of minutes.

Defaults The default is 15.

Command Global configuration mode

Mode

Usage Guide The available settings include 0, 15, 30, 60 and 120. 0 indicates this function is disabled.

9-27
Command Reference Syslog Commands

Configuration The following example set the interval at which logs are sent to 30 minutes.
Examples Ruijie(config)# logging statistic mnemonic TUNNEL_STAT interval 30

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

logging statistic terminal

Use this command to enable logs to be sent to the console and the remote terminal periodically. Use
the no form of this command to restore the default setting.
logging statistic terminal
no logging statistic terminal

Parameter
Parameter Description
Description
N/A N/A

Defaults This function is disabled by default.

Command Global configuration mode

Mode

Usage Guide N/A

Configuration The following example enable logs to be sent to the console and the remote terminal.
Examples Ruijie(config)# logging statistic terminal

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

logging synchronous

Use this command to enable synchronization function between user input and log output in line
configuration mode to prevent interruption when the user is keying in characters. Use the no form of this
command to restore the default setting.

9-28
Command Reference Syslog Commands

logging synchronous

no logging synchronous

Parameter Parameter Description

Description
N/A N/A

Defaults The synchronization function between user input and log output is disabled by default.

Command
Line configuration mode
Mode

Usage Guide This command enables synchronization function between user input and log output, preventing the
user from interrupting when keying in the characters.
Print UP-DOWN logs on the port when keying in the command, the input command will be output
again:
Ruijie# configure terminal
Oct 9 23:40:55 %LINK-5-CHANGED: Interface GigabitEthernet 0/1, changed state
to down
Oct 9 23:40:55 %LINEPROTO-5-UPDOWN: Line protocol on Interface
GigabitEthernet 0/1, changed state to DOWN
Ruijie# configure terminal//----the input command by the user is output again
rather than being intererupted.

Configuration Ruijie(config)#line console 0

Examples Ruijie(config-line)#logging synchronous
Print UP-DOWN logs on the port when keying in the command, the input command will be output
again:
Ruijie# configure terminal
Oct 9 23:40:55 %LINK-5-CHANGED: Interface GigabitEthernet 0/1, changed state
to down
Oct 9 23:40:55 %LINEPROTO-5-UPDOWN: Line protocol on Interface
GigabitEthernet 0/1, changed state to DOWN
Ruijie# configure terminal//----the input command by the user is output
again rather than being intererupted.

Related Command Description

Commands show running-config Displays the configuration.

Platform
N/A
Description

9-29
Command Reference Syslog Commands

logging trap

Use this command to set the severity of logs that are allowed to be sent to the syslog server in global
configuration mode. Use the no form of this command to prohibit sending log messages to the Syslog
server.

logging trap [level]

no logging trap

Parameter Parameter Description

Description Severity of the log message. The name of the severity or the
level
numeral can be used. For the details of log severity, see Table 1.

Defaults The default is informational(6)

Command
Global configuration mode
Mode

Usage Guide To send logs to the Syslog Server, run the logging command in global configuration mode to
configure the Syslog Server. Then, run the logging trap command to specify the severity level of
logs to be sent.
The show logging command displays the configured related parameters and statistics of the log.
Keyword Level Description

Emergencies 0 Emergency case, system cannot run normally

Alerts 1 Problems that need immediate remedy

Critical 2 Critical conditions

Errors 3 Error message

warnings 4 Alarm information

Notifications 5 Information that is normal but needs attention

informational 6 Descriptive information

Debugging 7 Debugging messages

Configuration The following example enables logs at severity 6 to be sent to the Syslog Server with the address of
Examples 202.101.11.22:
Ruijie(config)# logging 202.101.11.22
Ruijie(config)# logging trap informational

Related Command Description

Commands logging on Turns on the log switch.

9-30
Command Reference Syslog Commands

logging Sends logs to the Syslog server.

Displays the log messages and related log configuration
show logging
parameters in the buffer.

Platform
N/A
Description

logging userinfo

Use this command to enable the logging function to record user log/exit. Use the no form of this
command to restore the default setting.
logging userinfo
no logging userinfo

Parameter
Parameter Description
Description
N/A N/A

Defaults The log message is printed recording user log/exit by default.

Command Global configuration mode

Mode

Usage Guide This command is used to print the log message to remind the administrator of user login. The log
message is in the format as follows:
Mar 22 14:05:45 %LOGIN-5-LOGIN_SUCCESS: User login from vty0 (192.168.23.68)
OK.

Configuration The following example enables the logging function to record user log/exit.
Examples Ruijie(config)# logging user-info

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

logging userinfo command-log

Use this command to enable the logging function to record user operation. Use the no form of this
command to restore the default setting.
logging userinfo command-log

9-31
Command Reference Syslog Commands

no logging userinfo command-log

Parameter
Parameter Description
Description
N/A N/A

Defaults No log message is printed recording user operation by default.

Command Global configuration mode

Mode

Usage Guide This command is used to print the log message to remind the administrator of configuration change.
The log message is in the format as follows:
Mar 22 14:10:40 %CLI-5-EXEC_CMD: Configured from vty0 (192.168.23.68)
command-log: logging server 192.168.23.68.

Configuration The following example enables the logging function to record user operation.
Examples Ruijie(config)# logging user-info command-log

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

service log-format rfc5424

Use this command to enable the RFC5424 format. Use the no form of this command to restore the
default setting.
service log-format rfc5424
no service log-format rfc5424

Parameter
Parameter Description
Description
N/A N/A

Defaults The RFC3164 format is used by default.

Command Global configuration mode

Mode

9-32
Command Reference Syslog Commands

Usage Guide After the RFC5424 format is enabled, the service sequence-numbers, service sysname, service
timestamps, service private-syslog and service standard-syslog commands become invalid and
hidden.
After switching back to the RFC3164 format, the logging delay-send, logging policy and logging
statistic commands become invalid and hidden.
After switching the log format, the results of running the show logging and show logging config
commands change,

Configuration The following example enables the RFC5424 format.

Examples Ruijie(config)# service log-format rfc5424

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

service private-syslog

Use this command to set the syslog format to the private syslog format. Use the no form of this
command to restore the default setting.
service private-syslog
no service private-syslog

Parameter
Parameter Description
Description
N/A N/A

Defaults The syslog is displayed in the default format.

Command Global configuration mode

Mode

Usage Guide By default, the syslog is displayed in the format as follows:

*timestamp: %facility-severity-mnemonic: description
Here is an example:
*May 31 23:25:21: %SYS-5-CONFIG_I: Configured from console by console
With this function enabled, the syslog is displayed in the format as follows:
timestamp facility-severity-mnemonic: description
Here is an example:
May 31 23:31:28 SYS-5-CONFIG_I: Configured from console by console
The difference between the private syslog format and the default syslog format lies in the following
marks:

9-33
Command Reference Syslog Commands

The private syslog does not have “*” before the timestamp, “:” after the timestamp and “%” before the
identifying string.

Configuration The following example sets the private syslog format.

Examples Ruijie(config)# service private-syslog

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

service sequence-numbers

Use this command to attach serial numbers into the logs in global configuration mode. Use the no form
of this command to restore the default setting.

service sequence-numbers

no service sequence-numbers

Parameter Parameter Description

Description N/A N/A

Defaults No serial number is contained in the logs by default.

Command
Global configuration mode
Mode

Usage Guide In addition to the timestamp, you can add serial numbers to the logs, numbering from 1. Then, it is
clearly known whether the logs are lost or not and their sequence.

Configuration The following example adds serial numbers to the logs.

Examples Ruijie(config)# service sequence-numbers

Related Command Description

Commands logging on Turns on the log switch.
service timestamps Attaches timestamps to the logs.

Platform
N/A
Description

9-34
Command Reference Syslog Commands

service standard-syslog

Use this command to set the syslog format to the standard syslog format defined in RFC3164. Use
the no form of this command to restore the default setting.
service standard-syslog
no service standard-syslog

Parameter
Parameter Description
Description
N/A N/A

Defaults The syslog is displayed in the default format.

Command Global configuration mode

Mode

Usage Guide By default, the syslog is displayed in the format as follows:

*timestamp: %facility-severity-mnemonic: description
Here is an example:
*May 31 23:25:21: %SYS-5-CONFIG_I: Configured from console by console
With this function enabled, the syslog is displayed in the format as follows:
timestamp %facility-severity-mnemonic: description
Here is an example:
May 31 23:31:28 %SYS-5-CONFIG_I: Configured from console by console
The difference between the standard syslog format and the default syslog format lies in the following
marks:
The standard syslog does not have “*” before the timestamp and “:” after the timestamp.

Configuration The following example sets the standard syslog format.

Examples Ruijie(config)# service standard-syslog

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

service sysname

Use this command to attach system name to logs in global configuration mode. Use the no form of this
command to restore the default setting.

service sysname

9-35
Command Reference Syslog Commands

no service sysname

Parameter Parameter Description

Description
N/A N/A

Defaults No system name is attached to logs by default.

Command
Global configuration mode
Mode

Usage Guide This command allows you to decide whether to add system name in the log information.

Configuration The following example adds a system name in the log information:
Examples Mar 22 15:28:02 %SYS-5-CONFIG: Configured from console by console
Ruijie #config terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie (config)#service sysname
Ruijie (config)#end
Ruijie #
Mar 22 15:35:57 S3250 %SYS-5-CONFIG: Configured from console by console

Command Function
Related
Displays basic configuration of log modules and
Commands show logging
log information in the buffer.

Platform
N/A
Description

service timestamps

Use this command to attach timestamp into logs in global configuration mode. Use the no form of this
command to remove the timestamp from the logs. Use the default form of this command to restore the
default setting.

service timestamps [ message-type [ uptime | datetime [ msec | year ] ] ]

no service timestamps [ message-type ]

default service timestamps [ message-type ]

Parameter Parameter Description

Description The log type, including Log and Debug. The log type
message-type indicates the log information with severity levels of 0 to 6. The
debug type indicates that with severity level 7.
uptime Device start time in the format of *Day*Hour*Minute*Second,

9-36
Command Reference Syslog Commands

for example, 07:00:10:41.

Current time of the device in the format of
datetime Month*Date*Hour*Minute*Second, for example, Jul 27
16:53:07.
Current time of the device in the format of
msec Month*Date*Hour*Minute*Second*milisecond, for example,
Jul 27 16:53:07.299
Current time of the device in the format of
year Year*Month*Date*Hour*Minute*Second, for example, 2007
Jul 27 16:53:07

Defaults The time stamp in the log information is the current time of the device. If the device has no RTC, the
time stamp is automatically set to the device start time.

Command
Global configuration mode
Mode

Usage Guide When the uptime option is used, the time format is the running period from the last start of the device
to the present time, in seconds. When the datetime option is used, the time format is the date of the
current device, in the format of YY-MM-DD, HH:MM:SS.

Configuration The following example enables the timestamp for log and debug information, in format of Datetime,
Examples supporting millisecond display.
Ruijie(config)# service timestamps debug datetime msec
Ruijie(config)# service timestamps log datetime msec
Ruijie(config)# end
Ruijie(config)# Oct 8 23:04:58.301 %SYS-5-CONFIG I: configured from console
by console

Related Command Description

Commands logging on Turns on the log switch.
service sequence-numbers Enables serial numbers of logs.

Platform
N/A
Description

show logging

Use this command to display configured parameters and statistics of logs and log messages in the
memory buffer at privileged user layer. The log messages are sorted by the timestamp from before to
now.

show logging

9-37
Command Reference Syslog Commands

Parameter Parameter Description

Description N/A N/A

Defaults N/A

Command
Privileged EXEC mode
Mode

Usage Guide N/A

Configuration The following command displays the result of the show logging command with RFC5424 format
Examples disabled.
Ruijie# show logging
Syslog logging: enabled
Console logging: level debugging, 75 messages logged
Monitor logging: level debugging, 0 messages logged
Buffer logging: level debugging, 75 messages logged
File logging: level informational, 73 messages logged
File name:syslog/syslog.txt, size 128 Kbytes, the 1 file is currently being
written
Standard format:false
Timestamp debug messages: datetime
Timestamp log messages: datetime
Sequence-number log messages: disable
Sysname log messages: disable
Count log messages: disable
Trap logging: level informational, 73 message lines logged,0 fail
logging to 127.0.0.1
Log Buffer (Total 65535 Bytes): have written 6956,
*May 16 09:07:15: %BSP_PRODUCT-4-INIT: Thermal warn temperatue threshold is
80 degree centigrade.
*May 16 09:07:15: %IPSEC-7-INIT_CRYPTO_LOG_FAILED: Ipsec initialize crypto
log failed, NO hard disk, usb, and config path.
*May 16 09:07:15: %VPDN-4-UMOUNT_DISK: Vpdn log can not be stored without hard
disk or usb.
*May 16 09:07:17: %NETDEFEND-4-ATTACK_LOG: No memory to save attacked log file
*May 16 09:07:17: %WAS-3-UMOUNT_DISK: Disk or partition not Found!
*May 16 09:07:21: %SSLVPN-4-LOG_SERVER: No external storage.
*May 16 09:07:24: %GRPC-6-INFO: subscription 10.51.209.241:30001 state change
from INIT to IDLE
*May 16 09:07:24: %GRPC-6-INFO: subscription 10.51.209.241:30001 state change
from IDLE to CONNECTING

9-38
Command Reference Syslog Commands

*May 16 09:07:24: %GRPC-6-INFO: subscription 10.51.209.241:30001 state change

from CONNECTING to TRANSIENT_FAILURE
*May 16 09:07:25: %ROUTE_DB-5-UPDATE: System updates route-db database
successfully.
*May 16 09:07:25: %LINK-3-UPDOWN: Interface GigabitEthernet 0/7, changed state
to up.
*May 16 09:07:25: %LINEPROTO-5-UPDOWN: Line protocol on Interface
GigabitEthernet 0/7, changed state to up.
*May 16 09:07:36: %LINEPROTO-5-UPDOWN: Line protocol on Interface SSLVPN 0,
changed state to up.
Log information description:

Field Description

Syslog logging Logging flag: enabled or disabled

Level of the logs printed on the console, and

Console logging
statistics

Level of the logs printed on the VTY window,

Monitor logging
and statistics

Level of the logs recorded in the memory

Buffer logging
buffer, and statistics.

Standard format Standard log format.

Timestamp debug messages Timestamp format of the Debug messages

Timestamp log messages Timestamp format of the Log messages

Sequence-number log
Serial number switch
messages

Sequence log messages Attaches system names to the logs.

Count log messages Log statistics function

Level of the logs sent to the syslog server,

Trap logging
and statistics

Log Buffer Log files recorded in the memory buffer

The following example displays the result of the show logging command with RFC5424 format
enabled.
Ruijie# show logging
Syslog logging: enabled
Console logging: level debugging, 4740 messages logged
Monitor logging: level debugging, 0 messages logged
Buffer logging: level debugging, 4745 messages logged
Statistic log messages: disable
Statistic log messages to terminal: disable
Delay-send file name:syslog_ftp_server, Current write index:3, Current send

9-39
Command Reference Syslog Commands

index:3, Cycle:10 seconds

Count log messages: enable
Trap logging: level informational, 2641 message lines logged,4155 fail
logging to 192.168.23.89
logging to 2000::1
Delay-send logging: 2641 message lines logged
logging to 192.168.23.89 by tftp
Log Buffer (Total 4096 Bytes): have written 4096, Overwritten 3292
<135>1 2013-07-24T12:19:33.130290Z ruijie - 7 - - Please config the IP address
for capwap.
<132>1 2013-07-24T12:20:02.80313Z ruijie CAPWAP 4 NO_IP_ADDR - No ip address
for capwap.
<135>1 2013-07-24T12:20:02.80343Z ruijie - 7 - - Please config the IP address
for capwap.
<132>1 2013-07-24T12:20:32.250265Z ruijie CAPWAP 4 NO_IP_ADDR - No ip address
for capwap.
<134>1 2013-07-24T12:29:33.410123Z ruijie SYS 6 SHELL_LOGIN [USER@4881
name="" type="" from="console"] user login success.
<134>1 2013-07-24T12:29:34.343763Z ruijie SYS 6 SHELL_CMD [USER@4881
name=""][CMD@4881 task="rl_con" cmd="enable"]
Field Description
Syslog logging Logging flag: enabled or disabled
Console logging Level of the logs printed on the console, and statistics
Level of the logs printed on the VTY window, and
Monitor logging
statistics
Level of the logs recorded in the memory buffer, and
Buffer logging
statistics.
Count log messages Log statistics function

Statistic log messages Enables/disables log sending periodically

Enables/ disables log sending to console and remote

Statistic log messages to terminal
terminal
Local filename of log delay-sending cache, index of
Delay-send file name
write file and delay interval
Trap logging Level of the logs sent to the syslog server and statistics

Delay-send logging The server address, log sending mode and statistics

Log Buffer Log files recorded in the memory buffer

Related Command Function

Commands logging on Turns on the log switch.
clear logging Clears the log messages in the buffer.

Platform
N/A
Description

9-40
Command Reference Syslog Commands

show logging config

Use this command to display log configuration and statistics.

show logging config

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide N/A

Configuration The following example displays the outcome of running the show logging config command with
Examples RFC5424 disabled.
Ruijie# show logging config
Syslog logging: enabled
Console logging: level debugging, 15495 messages logged
Monitor logging: level debugging, 0 messages logged
Buffer logging: level debugging, 15496 messages logged
Standard format: false
Timestamp debug messages: datetime
Timestamp log messages: datetime
Sequence-number log messages: enable
Sysname log messages: enable
Count log messages: enable
Trap logging: level informational, 15242 message lines logged,0 fail
logging to 202.101.11.22
logging to 192.168.200.112
Field Description
Syslog logging Whether the logging function is enabled or disabled.
The level and statistics of the log message printed on
Console logging
the console.
The level and statistics of the log message printed on
Monitor logging
the VTY window.
The level and statistics of the log message recorded in
Buffer logging
the memory buffer.
Standard format Standard log format.
Timestamp debug messages Timestamp format of debugging message.
Timestamp log messages Timestamp format of log message.

9-41
Command Reference Syslog Commands

Whether the sequence number function is enabled or

Sequence-number log messages
disabled.
Sysname log messages Adds the system name to the log message.
Count log messages Log-counting function
The level and statistics of the log message sent to the
Trap logging
syslog server.
The following example displays the outcome of running the show logging config command with
RFC5424 enabled.
Ruijie# show logging
Syslog logging: enabled
Console logging: level debugging, 4740 messages logged
Monitor logging: level debugging, 0 messages logged
Buffer logging: level debugging, 4745 messages logged
Statistic log messages: disable
Statistic log messages to terminal: disable
Delay-send file name:syslog_ftp_server, Current write index:3, Current send
index:3, Cycle:10 seconds
Count log messages: enable
Trap logging: level informational, 2641 message lines logged,4155 fail
logging to 192.168.23.89
logging to 2000::1
Delay-send logging: 2641 message lines logged
logging to 192.168.23.89 by tftp
Field Description
Syslog logging Logging flag: enabled or disabled
Console logging Level of the logs printed on the console, and statistics
Level of the logs printed on the VTY window, and
Monitor logging
statistics
Level of the logs recorded in the memory buffer, and
Buffer logging
statistics.
Count log messages Log statistics function

Statistic log messages Enables/disables log sending periodically

Enables/ disables log sending to output console and

Statistic log messages to terminal
remove terminal
Local filename of log delay-sending cache, index of
Delay-send file name
write file and delay interval
Trap logging Level of the logs sent to the syslog server and statistics

Delay-send logging The server address, log sending way and statistics

Related
Command Description
Commands
N/A N/A

9-42
Command Reference Syslog Commands

Platform N/A
Description

show logging count

Use this command to display the statistics about occurrence times, and the last occurrence time of each
module log in the system in privileged mode.

show logging count

Parameter Parameter Description

Description
N/A N/A

Defaults N/A

Command
Privileged EXEC mode
Mode

Usage Guide To use the log packet statistics function, run the logging count command in global configuration
mode. The show logging count command can show the information of a specific log, occurrence
times, and the last occurrence time.
You can use the show logging command to check whether the log statistics function is enabled.

Configuration The following example displays the result of the show logging count command:
Examples Ruijie# show logging count
Module Name Message Name Sev Occur Last Time
SYS CONFIG_I 5 1 Jul 6 10:29:57
SYS TOTAL 1

Related Command Function

Commands logging count Enables the log statistics function.
Displays basic configuration of log modules and
show logging
log information in the buffer.
clear logging Clears the logs in the buffer.

Platform
N/A
Description

show logging reverse

Use this command to display configured parameters and statistics of logs and log messages in the
memory buffer at privileged user layer. The log messages are sorted by the timestamp from now to

9-43
Command Reference Syslog Commands

before.
show logging reverse

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

Mode

Usage Guide

Configuration The following command displays the result of the show logging reverse command with RFC5424
Examples format disabled.
Syslog logging: enabled
Console logging: level debugging, 75 messages logged
Monitor logging: level debugging, 0 messages logged
Buffer logging: level debugging, 75 messages logged
File logging: level informational, 73 messages logged
File name:syslog/syslog.txt, size 128 Kbytes, the 1 file is currently being
written
Standard format:false
Timestamp debug messages: datetime
Timestamp log messages: datetime
Sequence-number log messages: disable
Sysname log messages: disable
Count log messages: disable
Trap logging: level informational, 73 message lines logged,0 fail
logging to 127.0.0.1
Log Buffer (Total 65535 Bytes): have written 6956,
*May 17 16:15:22: %LOGIN-5-LOGIN_SUCCESS: User (admin) login from
vty1(10.52.0.77) OK.
*May 17 16:14:19: %LOGIN-5-LOGOUT: User (admin) logout from vty1(10.52.0.77).
*May 17 16:14:19: %SYS-5-CONFIG_I: Configured from console by admin on
vty1(10.52.0.77)
*May 17 16:01:08: %CLI-5-EXEC_CMD: Configured from vty1(10.52.0.77) by admin
command: exit
*May 17 16:00:42: %CLI-5-EXEC_CMD: Configured from vty1(10.52.0.77) by admin
command: interface GigabitEthernet 0/1

Field Description

Syslog logging Logging flag: enabled or disabled

9-44
Command Reference Syslog Commands

Level of the logs printed on the console, and

Console logging
statistics

Level of the logs printed on the VTY window,

Monitor logging
and statistics

Level of the logs recorded in the memory

Buffer logging
buffer, and statistics.

Standard format Standard log format.

Timestamp debug messages Timestamp format of the Debug messages

Timestamp log messages Timestamp format of the Log messages

Sequence-number log
Serial number switch
messages

Sequence log messages Attaches system names to the logs.

Count log messages Log statistics function

Level of the logs sent to the syslog server,

Trap logging
and statistics

Log Buffer Log files recorded in the memory buffer

The following example displays the result of the show logging reverse command with RFC5424
format enabled.
Ruijie# show logging reverse
Syslog logging: enabled
Console logging: level debugging, 4740 messages logged
Monitor logging: level debugging, 0 messages logged
Buffer logging: level debugging, 4745 messages logged
Statistic log messages: disable
Statistic log messages to terminal: disable
Delay-send file name:syslog_ftp_server, Current write index:3, Current send
index:3, Cycle:10 seconds
Count log messages: enable
Trap logging: level informational, 2641 message lines logged,4155 fail
logging to 192.168.23.89
logging to 2000::1
Delay-send logging: 2641 message lines logged
logging to 192.168.23.89 by tftp
Log Buffer (Total 4096 Bytes): have written 4096, Overwritten 3292
<134>1 2013-07-24T12:29:34.343763Z ruijie SYS 6 SHELL_CMD [USER@4881
name=""][CMD@4881 task="rl_con" cmd="enable"]
<134>1 2013-07-24T12:29:33.410123Z ruijie SYS 6 SHELL_LOGIN [USER@4881 name=""
type="" from="console"] user login success.
<132>1 2013-07-24T12:20:32.250265Z ruijie CAPWAP 4 NO_IP_ADDR - No ip address
for capwap.

9-45
Command Reference Syslog Commands

<135>1 2013-07-24T12:20:02.80343Z ruijie - 7 - - Please config the IP address

for capwap.
<132>1 2013-07-24T12:20:02.80313Z ruijie CAPWAP 4 NO_IP_ADDR - No ip address
for capwap.
<135>1 2013-07-24T12:19:33.130290Z ruijie - 7 - - Please config the
IP address for capwap.
Field Description
Syslog logging Logging flag: enabled or disabled
Console logging Level of the logs printed on the console, and statistics
Level of the logs printed on the VTY window, and
Monitor logging
statistics
Level of the logs recorded in the memory buffer, and
Buffer logging
statistics.
Count log messages Log statistics function

Statistic log messages Enables/disables log sending periodically

Enables/ disables log sending to console and remote

Statistic log messages to terminal
terminal
Local filename of log delay-sending cache, index of
Delay-send file name
write file and delay interval
Trap logging Level of the logs sent to the syslog server and statistics

Delay-send logging The server address, log sending mode and statistics

Log Buffer Log files recorded in the memory buffer

Related
Command Description
Commands
N/A N/A

Platform
N/A
Description

terminal monitor

Use this command to show logs on the current VTY window. Use the no form of this command to restore
the default setting.

terminal monitor

terminal no monitor

Parameter Parameter Description

Description
N/A N/A

Defaults Log information is not allowed to be displayed on the VTY window by default.

9-46
Command Reference Syslog Commands

Command
Privileged EXEC mode
Mode

Usage Guide This command only sets the temporary attributes of the current VTY. As the temporary attribute, it is
not stored permanently. At the end of the VTY terminal session, the system will use the default
setting, and the temporary setting is invalid. This command can be also executed on the console, but
it does not take effect.

Configuration The following example allows log information to be printed on the current VTY window:
Examples Ruijie# terminal monitor

Related Command Description

Commands N/A N/A

Platform
N/A
Description

Command Version Description

History N/A N/A

logging language

Use this command to configure the syslog language. Use the no form of this command to restore the
default settings.

logging language { Chinese | English }

no logging language

Parameter Parameter Description

Description Chinese The language is Chinese.
English The language is English.

Defaults The default language is Chinese.

Defaults The default language is English.

Command
Global configuration mode
Mode

Usage Guide N/A

9-47
Command Reference Syslog Commands

Configuration The following example sets the syslog language to English.

Examples Ruijie(config)# logging language English

Related Command Function

Commands N/A N/A

Platform
N/A
Description

9-48
Command Reference LED Commands

10 LED Commands

led on

Use this command to turn on LEDs for AP location.

Use the no form of this command to restore the default setting.
led on [slot slot-id]
no led on [slot slot-id]

Parameter
Parameter Description
Description
slot-id Slot ID corresponding to the RF card

Defaults This function is disabled by default.

Command AP configuration mode

Mode

Usage Guide For rack APs, specify the slot ID for every RF card. For non-rack APs, the slot-id parameter is invalid.

Configuration The following example turns on LEDs for AP location.

Examples Ruijie(config)#ap-config 00d0.f822.33bc
Ruijie(config-ap)#led on

The following example turns off LEDs for AP location.

Ruijie(config)#ap-config 00d0.f822.33bc
Ruijie(config-ap)#no led on

Platform
N/A
Description

quiet-mode session

Use this command to configure LED quiet mode.

Use the no form of this command to restore the default setting.
quiet-mode session session-num
no quiet-mode session session-num

Parameter Parameter Description

Description
session-num Session ID.

10-1
Command Reference LED Commands

Defaults This function is disabled by default.

Command AP configuration mode

Mode

Usage Guide Use this command to turn off all LEDs on the AP.

Configuration The following example configures LED quiet mode from 23:00 that night to 7:00 next day.
Examples Ruijie(config)#schedule session 1
Ruijie(config)#schedule session 1 time-range 1 period Mon time 23:00 to 7:00
Ruijie(config)#ap-config 00d0.f822.33bc
Ruijie(config-ap)#quiet-mode session 1

The following example disables LED quiet mode.

Ruijie(config)#ap-config 00d0.f822.33bc
Ruijie(config-ap)#no quiet-mode session 1

Platform
N/A
Description

10-2
Command Reference Exception Alarm Commands

11 Exception Alarm Commands

feedback frequency

Use this command to configure a mailing frequency.

feedback frequency min

Use the no form of this command to restore the default configuration.

no feedback frequency

Parameter
Parameter Description
Description
Indicates a mailing frequency in minutes. The value range is from 5 to
frequency min
10,080. The default value is 60.

Defaults 60

Command Global configuration mode

Mode

Usage Guide To receive emails as soon as possible, set this parameter to a small value. A smaller value indicates
more timely receiving of emails. If there is a great amount of exception information, emails will be
received frequently.
To avoid frequently receiving emails, set this parameter to a large value, for example, 1440 minutes.
Then, exception information will be sent once a day. In this case, the administrator will not be notified in
a timely manner if an exception occurs.

Set the mailing frequency as required.

Configuration #Set the mailing frequency to 120 minutes.

Example Ruijie(config)# feedback frequency 120

Verification Run the show run command to display the configuration result.

feedback ignore item

Use this command to set the ID of an alarm option to be ignored.

feedback ignore-item item-id

Use the no form of this command to delete the configuration.

no feedback ignore-item item-id

11-1
Command Reference Exception Alarm Commands

Parameter
Parameter Description
Description
Sets the ID of an alarm option to be ignored. The value range is from 0 to
ignore-item item-id
8.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide
No exception about the ignored alarm option will be emailed to the administrator.

Configuration #Set the mailing frequency to 120 minutes.

Example Ruijie(config)# feedback frequency 120

Verification Run the show run command to display the configuration result.

feedback subscriber

Use this command to configure a receiving mailbox.

feedback subscriber mail-addr

Use the no form of this command to delete the configuration.

no feedback subscriber mail-addr

Parameter
Parameter Description
Description
Configures a receiving mailbox. A maximum of six receiving mailboxes
subscriber mail-addr
can be configured.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide To send the exception information to multiple users by email, repeat the command.

Configuration #Configure a recipient.

Example Ruijie(config)# feedback subscriber [email protected]

11-2
Command Reference Exception Alarm Commands

Verification Run the show run command to display the configuration result.

feedback user enable

Use this command to enable the exception alarm function.

feedback user enable

Use the no form of this command to disable the exception alarm function.
no feedback user enable

Parameter
Parameter Description
Description
N/A N/A

Defaults This function is disabled by default.

Command Global configuration mode

Mode

Usage Guide Enable this function before using it.

The exception alarm function must be supported by the following functions at the same time:
 Mail service
 SMTP server
 Email sending address and password
 Receiving mailbox

Configuration #Enable the exception alarm function.

Example Ruijie(config)# feedback user enable

Verification Run the show run command to display the configuration result.

mail-client check

Use this command to check email-related configurations.

mail-client check

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

11-3
Command Reference Exception Alarm Commands

Command Privileged EXEC mode

Mode

Usage Guide Use this command to check whether the SMTP server and email address and password are successfully
configured.
If yes, a test email will be received.

Configuration #Check the email configuration.

Example Ruijie# mail-client check

Connect to smtp server. OK!

Login to smtp server. OK!

Send a test mail. OK!

Check OK!

Verification Log in to the mailbox through a browser to check whether a test email is received.

mail-client smtp server

Use this command to configure an SMTP server.

mail-client smtp server addr [ port value ]

Use the no form of this command to delete the configuration.

no mail-client smtp server

Parameter
Parameter Description
Description
addr Indicates the IP address of the SMTP server.
Indicates the port number of the SMTP server. The value range is from 1
value
to 65,535.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide The SMTP server must be configured in order to send emails about exceptions.
The URL of the SMTP server can be queried from a mailbox website, for example, smtp.qq.com or
smtp.126.com.
The SMTP service of some mailbox (for example, QQ email) is disabled by default. Log in to the mailbox
through a browser, and enable the SMTP service.

11-4
Command Reference Exception Alarm Commands

Configuration #Configure an SMTP server.

Example Ruijie(config)# mail-client server smtp.126.com

Verification Log in to the mailbox through a browser to check whether a test email is received.

mail-client username

Use this command to configure the email address and password.

mail-client username mail-addr password pw-string

Use the no form of this command to delete the configuration.

no mail-client username mail-addr password pw-string

Parameter
Parameter Description
Description
Indicates an email address in the format of xxx@yyy. This command
username mail-addr
does not check the format.
password pw-string Indicates a password.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide Check the following:

1. The email address is applied for from a commonly used mailbox website. At present, mailboxes
that pass verification are suffixed by 163.com, 126.com, 139.com, sina.com, qq.com, and tom.com.
Other unverified mailboxes may also be used.
2. The mailbox supports the SMTP service. The mailboxes mentioned above all support the SMTP
service.
3. Log in to the mailbox through a browser to check whether the SMTP service is enabled.
4. Log in to the mailbox website to check the IP address of the SMTP server.

Configuration #Configure the email address and password.

Example Ruijie(config)# mail-client username [email protected] password ******

Verification Run the show run command to display the configuration result.

mail-service enable

Use this command to enable the mail service.

11-5
Command Reference Exception Alarm Commands

mail-service enable

Use the no form of this command to disable the mail service.

no mail-service enable

Parameter
Parameter Description
Description
N/A N/A

Defaults The mail service is enabled by default.

Command Global configuration mode

Mode

Usage Guide Mail-related functions must be supported by the mail service.

Configuration #Enable the mail service.

Example Ruijie(config)# mail-service enable

Verification Run the show run command to display the configuration result.

mail-service source

Use this command to configure a source IP address of the mail service.

mail-service source ip

Use the no form of this command to delete the source IP address of the mail service.
no mail-service source

Parameter
Parameter Description
Description
ip Indicates the source IP address.

Defaults N/A

Command Global configuration mode

Mode

Usage Guide The source IP address must be configured in public network mode, and it is generally set to the IP
address of an intranet port.

Configuration
#Set the source IP address of the mail service to 1.1.1.1.
Example

11-6
Command Reference Exception Alarm Commands

Ruijie(config)# mail-service source 1.1.1.1

Verification Run the show run command to display the configuration result.

show feedback items

Use this command to display the alarm options.

show feedback items

Parameter
Parameter Description
Description
N/A N/A

Command Privileged EXEC mode, global configuration mode, and interface configuration mode
Mode

Usage Guide Use this command to display the alarm options supported by the gateway.

Configuration #Display the alarm options supported by the gateway.

Example Ruijie#show feedback items

no. name ignore

-------------------------------------------

4, high CPU temperature, NO

5, device attack, NO

6, total bandwidth exceeding the limit, NO

7, flow control exception, NO

8, high main board temperature, NO

Field description:
Field Description
no. Indicates an option ID.
name Indicates an option name.
ignore Ignores the option.

11-7
Command Reference HTTP Service Commands

12 HTTP Service Commands

enable service web-server

Use this command to enable the HTTP service function.

Use the no or default form of this command to disable the HTTP service function.
enable service web-server [ http | https | all ]
no enable service web-server [ http | https ]
default enable service web-server [ http | https ]

Parameter
Parameter Description
Description
http Enables the HTTP service.
https Enables the HTTPS service.
all Enables both the HTTP service and the HTTPS service.

Defaults By default, the HTTP service function is disabled.

Command Global configuration mode.

mode

Usage Guide If run a command ends with the keyword all or without keyword, it indicates enabling both the HTTP
service and the HTTPS service; if run a command ends with keyword http, it indicates enabling the
HTTP service; if run a command ends with keyword https, it indicates enabling the HTTPS service.
Use the command no enable service web-server to disable the corresponding HTTP service.

Configuration The following example enables both the HTTP service and the HTTPS service:
Examples Ruijie(config)# enable service web-server

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

http check-version

Use this command to detect the available upgrade files on the HTTP server.
http check-version

12-1
Command Reference HTTP Service Commands

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

mode

Usage Guide Use this command to detect the available upgrade files. The detected upgrade files version is later
than that of local files.

Configuration The following example demonstrates the version of the detected HTTP upgrade file.
Examples Ruijie# http check-version

Business modules need to be updated: character-db, route-db

app name:web

app-name version filename

--------------- -------------------- ------------------------

character-db 2014.02.09.14.02.09 app_sub_1.exe

character-db 2014.02.09.14.02.09 app_file_list.txt

character-db 2014.02.09.14.02.09 app_sub_3.exe

character-db 2014.02.09.14.02.09 app_sub_2.exe

route-db 2013.12.01.00 route-choose.db

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

http update

Use this command to manually upgrade files.

http update { all | string }

Parameter
Parameter Description
Description
string Name of the service to be upgraded. You can enter multiple services,
and separate them with spaces.

12-2
Command Reference HTTP Service Commands

all Upgrade all services.

Defaults N/A

Command Privileged EXEC mode

mode

Usage Guide N/A

Configuration The following example upgrades the route-db and url-db files.
Examples Ruijie# http update route-db

Downloading updated files, please wait...

Press Ctrl+C to quit

route-db: download and notify successfully.

Related
Command Description
Commands
http check-vesion Detects the available update package on the
HTTP server.

Platform N/A
Description

http update mode

Use this command to configure the HTTP upgrade mode to manual mode. Use the no form of this
command to restore the default upgrade mode, namely, auto mode.
http update mode manual
no http update mode

Parameter
Parameter Description
Description
manual Configures the manual upgrade mode.

Defaults The default update mode is auto mode.

Command Global configuration mode.

mode

Usage Guide Use this command to configure the HTTP upgrade mode to manual mode.

Configuration The following example enables manual HTTP upgrade mode:

12-3
Command Reference HTTP Service Commands

Examples Ruijie#configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#http update mode manual

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

http update server

Use this command to configure the IP address and the HTTP port number of the HTTP server.
http update server { host-name | ip-address } [ port port-number ]
no http update server

Parameter
Parameter Description
Description
host-name Host name of the HTTP server.
ip-address IP address of the HTTP server.
port-number Port number of the HTTP server. The range is from 1 to 65,535.

Defaults By default, the IP address of the HTTP remote upgrade server is 0.0.0.0 and the port number is 80.

Command Global configuration mode.

mode

Usage Guide Use this command to configure the IP address and the HTTP port number of the HTTP server. When
processing upgrade, the user-configured server address is preferentially used. If the connection fails,
the server address in store in the local upgrade record file will be used to establish the connection.
When all the above connection fails, upgrade will be suspended.
At least one IP address of upgrade server is stored in the local upgrade record file, and this IP
address cannot be modified.

The HTTP upgrade server address is not need to be configured because the local upgrade
record file records available upgrade server addresses.

If the server domain needs to be configured, enable the DNS function on the device and
configure the DNS server address.

Configuration The following example configures the IP address and the HTTP port number of the HTTP server:

12-4
Command Reference HTTP Service Commands

Examples Ruijie#configure terminal

Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#http update server 10.83.132.1 port 90

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

http update set oob

Use this command to enable HTTP upgrade on the MGMT port. Use the no form of this command to
restore the default setting.
http update set oob
no http update set oob

Parameter
Parameter Description
Description
N/A N/A

Defaults By default, HTTP upgrade is performed on the common port.

Command Global configuration mode.

mode

Usage Guide This command is supported only on the device supporting the MGMT ports.

Configuration The following example enables HTTP upgrade on the MGMT port:
Examples Ruijie(config)# http update set oob

Related
Command Description
Commands
N/A N/A

Platform MGMT ports are supported on NBR6205-E, NBR6205-E V2, NBR6210-E, NBR6210-E V2 and
Description NBR6215-E but not on NBR6120-E.

http update time

Use this command to configure the HTTP auto-detection time. Use the no form of this command to
restore the default auto-detection time.

12-5
Command Reference HTTP Service Commands

http update time daily hh:mm

no http update time

Parameter
Parameter Description
Description
hh:mm Specified auto-detection time; (24-hour system); accurate to minute.

Defaults The default HTTP auto-detection time is random.

Command Global configuration mode.

mode

Usage Guide Use this command to configure the HTTP auto-detection time. The device detects the files available
for upgrade on the server at the specified detection time. Use can read these detected file information
through Web interface.
Use the no form of this command to reset the auto-detection time as random.

Configuration The following example configures the HTTP auto-detection time：

Examples Ruijie#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#http update time daily 23:40

Related
Command Description
Commands
http update mode Configures the HTTP update mode

Platform N/A
Description

ip http port

Use this command to configure the HTTP port number.

Use the no form of this command to restore the default HTTP port number.
ip http port port-number
no ip http port

Parameter
Parameter Description
Description
port-number Configures the HTTP port number. The value includes 80, 1025 to
65,535.

Defaults The default HTTP port number is 80.

12-6
Command Reference HTTP Service Commands

Command Global configuration mode.

mode

Usage Guide Use this command to configure the HTTP port number.

Configuration The following example configures the HTTP port number as 8080:
Examples Ruijie#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#ip http port 8080

Related
Command Description
Commands
N/A N/A

Platform N/A
Description

ip http secure-port

Use this command to configure the HTTPS port number.

Use the no form of this command to restore the default HTTPS port number.
ip http secure-port port-number
no ip http secure-port

Parameter
Parameter Description
Description
port-number Configures the HTTPS port number. The value includes 443, 1025 to
65,535.

Defaults The default HTTP port number is 443.

Command Global configuration mode.

mode

Usage Guide Use this command to configure the HTTPS port number.

Configuration The following example configures the HTTPS port number as 4443:
Examples Ruijie#configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
Ruijie(config)#ip http secure-port 4443

Related
Command Description
Commands

12-7
Command Reference HTTP Service Commands

enable service web-server Enables the HTTP service.

show web-server status Displays the configuration and status of the
Web service.

Platform N/A
Description

show web-server

Use this command to display the configuration and status of the Web service.
show web-server

Parameter
Parameter Description
Description
N/A N/A

Defaults N/A

Command Privileged EXEC mode

mode

Usage Guide N/A

Configuration The following example displays the configuration and status of the Web service:
Examples Ruijie# show web-service
webservice:
http : enable
: port(80)
https : enable
: port(4430)

Related
Command Description
Commands
enable service web-server Enables the HTTP service.
http port Configures the HTTP port number.
http secure-port Configures the HTTPS port number.

Platform N/A
Description

12-8
Command Reference PATCH-UPGRADE Commands

13 PATCH-UPGRADE Commands

patch-upgrade

Use this command to set the patch upgrade mode to automatic or manual.
patch-upgrade set-mode { auto | manual }

Use this command to set the automatic patch loading period.

patch-upgrade set-active-time start hh:mm end hh:mm

Use this command to set manual patch upgrade.

patch-upgrade manual-active

Use this command to set manual patch uninstallation and deletion.

patch-upgrade delete

Parameter
Parameter Description
Description
hh:mm Specifies the hour and minute.

Defaults The automatic patch upgrade mode is enabled by default, and the default automatic patch loading period is
03:00 to 04:00 every day.

Command Privileged EXEC mode

Mode

Default Level 14

Usage Guide If the automatic patch upgrade mode is used, the patch package is automatically installed and loaded.
Manual patch upgrade can be performed only when the device has downloaded and installed a patch
package.

Configuration The following example sets automatic patch upgrade.

Examples Ruijie# patch-upgrade set-mode auto

The following example sets the automatic patch loading period to 12:00–13:00.
Ruijie# patch-upgrade set-active-time start 12:00 end 13:00

Verification Run the show patch-upgrade state command to display the configuration.

13-1
Command Reference PATCH-UPGRADE Commands

show patch-upgrade state

Use this command to display configuration and status of PATCH-UPGRADE.

show patch-upgrade state

Parameter
Parameter Description
Description

Command Privileged EXEC mode

Mode

Default Level 14

Usage Guide This command is used to display the status and configuration of PATCH-UPGRADE.

Configuration The following example displays the status and configuration of PATCH-UPGRADE.
Examples Ruijie# show patch-upgrade state
show patch update info:
----------------------------
mode :auto
patch state :uninstall
next state :
outer state :
active time :NULL
check start :03:00
check end :04:00
check quiet :5
need reboot :0
version :notpatch
per version :notpatch
----------------------------

show patch-upgrade log

Use this command to display logs of PATCH-UPGRADE.

show patch-upgrade log

Parameter
Parameter Description
Description

13-2
Command Reference PATCH-UPGRADE Commands

Command Privileged EXEC mode

Mode

Default Level 14

Usage Guide This command is used to display logs of PATCH-UPGRADE.

Configuration The following example displays logs of PATCH-UPGRADE.

Examples Ruijie# show patch-upgrade log
show patch log info
2017-08-16 11:49:32, [auto] patch install success
2017-08-16 12:00:03, [auto] patch active success
2017-08-16 14:04:43, [manual] patch running success
2017-08-16 17:12:33, [manual] patch install fail
2017-08-16 17:16:53, [manual] patch install success
2017-08-16 17:16:53, [manual] patch active success
2017-08-16 17:16:54, [manual] patch running success
2017-08-16 17:21:43, [manual] patch install fail
2017-08-16 17:31:37, [manual] patch install fail
2017-08-16 17:35:56, [manual] patch install fail
…

13-3
Command Reference WEB-UPGRADE Commands

14 WEB-UPGRADE Commands

web-upgrade

Use this command to install and upgrade the web package in the local file system.
web-upgrade url [ force ]

Parameter Parameter Description

Description
url Indicates the local path for storing the web package.
force Indicates that an upgrade is forcibly performed without considering
version comparison.

Defaults N/A

Command Privileged EXEC mode

Mode

Default Level 14

Usage Guide This command is used to upgrade the web package locally.
Before running this command, copy the web package to a specific directory of the device's file system.
When running this command, locate the web package based on the input path and upgrade it.
The following table lists available URL formats.
Parameter Description
tmp:url Path /tmp/vsd/0/
path url Custom local file path

By default, an upgrade is not performed when the web package versions are the same. To ignore version
comparison, carry the force parameter.
Configuration The following example upgrades the web package.
Examples Ruijie# web-upgrade tmp:web.gz
Upgrade web package start...
MD5 a310c329b917fdc992864f8287d83681
Web version[2018.6.8.07->2018.6.8.10]
Upgrade info [OK]
Upgrade web package succeeded.

Verification Run the show web-upgrade command to display web package information. If the information is updated,
the upgrade is successful.
Common
The web package path or name is incorrect.
Errors

14-1
Command Reference WEB-UPGRADE Commands

show web-upgrade

Use this command to display version information of the web package.

show web-upgrade

Parameter
Parameter Description
Description
N/A N/A

Command Privileged EXEC mode, global configuration mode, or interface configuration mode
Mode

Default Level N/A

Usage Guide N/A

Configuration The following example displays version information of the web package.
Examples Ruijie# show web-upgrade
Version : 2018.6.8.10
Md5 : a310c329b917fdc992864f8287d83681
Size : 9012807
Build : 2018-06-08 10:37:41
Compatible : NBR*
Incompatible : NBR6120-E
The package information fields are described below.
Field Description
Version Package version
Md5 MD5 of the package
Size Package size
Build Package compilation and generation time
Compatible Product models supported by the package
Incompatible Product models not supported by the package

14-2