Ruijie RG-S29 Series Installation manual

RG-S29 Series Switch
RGOS Command Reference, Release 11.4(1)B12

·
Copyright Statement
Ruijie Networks©2018
Ruijie Networks reserves all copyrights of this document. Any reproduction, excerption, backup, modification,
transmission, translation or commercial use of this document or any portion of this document, in any form or by any means,
without the prior written consent of Ruijie Networks is prohibited.
Exemption Statement
This document is provided “as is”. The contents of this document are subject to change without any notice. Please obtain
the latest information through the Ruijie Networks website. Ruijie Networks endeavors to ensure content accuracy and will
not shoulder any responsibility for losses and damages caused due to content omissions, inaccuracies or errors.

·
Preface
Thank you for using our products. This manual matches the RGOS Release 11.4(1)B12.
Audience
This manual is intended for:
Network engineers
Technical support and servicing engineers
Network administrators
Obtaining Technical Assistance
Ruijie Networks Website: https://www.ruijienetworks.com/
Technical Support Website: https://ruijienetworks.com/support
Case Portal: http://caseportal.ruijienetworks.com
Community: http://community.ruijienetworks.com
Technical Support Email: s[email protected]
Skype: [email protected]
Related Documents
Documents
Description
Configuration Guide
Describes network protocols and related mechanisms that supported by the
product, with configuration examples.
Hardware Installation and Reference
Guide
Describes the functional and physical features and provides the device
installation steps, hardware troubleshooting, module technical specifications,
and specifications and usage guidelines for cables and connectors.
Conventions
This manual uses the following conventions:
Convention
Description
boldface font
Commands, command options, and keywords are in boldface.
italic font
Arguments for which you supply values are in italics.
[ ]
Elements in square brackets are optional.
{ x | y | z }
Alternative keywords are grouped in braces and separated by vertical bars.

·
[ x | y | z ]
Optional alternative keywords are grouped in brackets and separated by
vertical bars.
Symbols
Means reader take note. Notes contain helpful suggestions or references.
Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of
data.

System Configuration Commands
1. Command Line Interface Commands
2. Basic Configuration Management Commands
3. Line Commands
4. File System Commands
5. SYS Commands
6. Time Range Commands
7. HTTP Service Commands
8. Syslog Commands
9. CWMP Commands
10.CA-MONITOR Commands
11.ZAM Commands
12.Module Hot-plugging/Unplugging Commands
13.Supervisor Module Redundancy Commands
14.PoE Management Commands
15.PKG-MGMT Command

Command Reference Command Line Interface Commands
1 Command Line Interface Commands
1.1 alias
Use this command to configure a command alias in global configuration mode. Use the no or default
form of this command to restore the default setting.
alias mode command-alias original-command
no alias mode command-alias
default alias mode [command-alias]
Parameter
Description
Parameter
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
Mode
Global configuration 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
......

Command Reference Command Line Interface Commands
The alias also has its help information that is displayed after * in the following format:
*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
Examples
The following example uses def-route to represent the default route setting of ip route 0.0.0.0 0.0.0.0
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
Commands
Command
Description
show aliases
Displays the aliases settings.
Platform
Description
N/A

Command Reference Command Line Interface Commands
1.2 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
Description
Parameter
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
Mode
Global configuration 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
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
Configuration
Examples
The following example sets the password of CLI level 1 as test and attribute the reload rights to reset
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

Command Reference Command Line Interface Commands
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
Commands
Command
Description
enable secret
Sets the CLI-level password.
Platform
Description
N/A.
1.3 show aliases
Use this command to show all the command aliases or aliases in special command modes.
show aliases [ mode ]
Parameter
Description
Parameter
Description
mode
Mode of the command represented by the alias.
Defaults
N/A.
Command
Mode
Privileged EXEC mode.
Usage Guide
This command displays the configuration of all aliases if no command mode is input.
Configuration
Examples
The following example displays the command alias in privileged EXEC mode:
Ruijie#show aliases exec
exec mode alias:
h help
p ping
s show
u undebug
un undebug
Related
Commands
Command
Description
alias
Sets a command alias.

Command Reference Command Line Interface Commands
Platform
Description
N/A.

Command Reference Basic Configuration Management Commands
2 Basic Configuration Management Commands
2.1 <1-99>
Use this command to restore the suspended Telnet Client session.
<1-99>
Parameter
Description
Parameter
Description
N/A
N/A
Defaults
N/A
Command
Mode
User EXEC 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 session command to display the session.
Configuration
Examples
The following example restores the suspended Telnet Client session.
Ruijie# 1
Related
Commands
Command
Description
N/A
N/A
Platform
Description
N/A
2.2 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
Description
Parameter
Description
c
Separator of the message. Delimiters are not allowed in the
message.

Command Reference Basic Configuration Management Commands
message
Contents of the message.
Defaults
N/A
Command
Mode
Global configuration 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
Examples
The following example configures a welcome message.
Ruijie(config)# banner exec $ Welcome $
Related
Commands
Command
Description
N/A
N/A
Platform
Description
N/A
2.3 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
Description
Parameter
Description
c
Separator of the message. Delimiters are not allowed in the
message.
message
Contents of the message.
Defaults
N/A
Command
Mode
Global configuration mode

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
Examples
The following example configures a prompt message for reverse Telnet session.
Ruijie(config)# banner incoming $ Welcome $
Related
Commands
Command
Description
N/A
N/A
Platform
Description
N/A
2.4 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
Description
Parameter
Description
c
Separator of the message contained in the login banner. Delimiters
are not allowed in the MOTD.
message
Contents of the login banner
Defaults
N/A
Command
Mode
Global configuration 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
Examples
The following example configures a login banner.
Ruijie(config)# banner login $ enter your password $
Related
Commands
Command
Description
N/A
N/A

Command Reference Basic Configuration Management Commands
Platform
Description
N/A
2.5 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
Description
Parameter
Description
c
Separator of the MOTD. Delimiters are not allowed in the MOTD.
message
Contents of an MOTD
Defaults
N/A
Command
Mode
Global configuration mode
Usage Guide
This command sets the MOTD, which is displayed at login. The letters that follow the separator will
be discarded.
Configuration
Examples
The following example configures the MOTD.
Ruijie(config)# banner motd $ hello,world $
Related
Commands
Command
Description
N/A
N/A
Platform
Description
N/A
2.6 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
Description
Parameter
Description
c
Separator of the message. Delimiters are not allowed in the

Command Reference Basic Configuration Management Commands
message.
message
Contents of the message.
Defaults
N/A
Command
Mode
Global configuration 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
Examples
The following example configures the prompt-timeout message to notify timeout.
Ruijie(config)# banner exec $ authentication timeout $
Related
Commands
Command
Description
N/A
N/A
Platform
Description
N/A
2.7 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
Description
Parameter
Description
c
Separator of the message. Delimiters are not allowed in the
message.
message
Contents of the message.
Defaults
N/A
Command
Mode
Global configuration 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.
When the SLIP/PPP session is created, the slip-ppp message is displayed on the corresponding
terminal.

Command Reference Basic Configuration Management Commands
Configuration
Examples
The following example configures the banner slip-ppp message for the SLIP/PPP session.
Ruijie(config)# banner slip-ppp $ Welcome $
Related
Commands
Command
Description
N/A
N/A
Platform
Description
N/A
2.8 boot configure
Use this command to modify the path for saving startup configurations and the corresponding file
name.
boot config { flash:filename }
no boot config
Parameter
Description
Parameter
Description
flash
Saves the startup configuration file in the extensible Flash.
Defaults
By default, startup configuration file of a device is saved in Flash:/config.text
Command
Mode
Privileged EXEC mode
Usage Guide
The startup configuration file name follows a slash ''/'', for example, Flash:/ruijie.text.
The startup configuration file name consists of a path and a file name. The path is mandatory.
Otherwise, configurations cannot be saved by using the write command. Take
Flash:/ruijie/ruijie.text as examples, where the Flash:/ruijie folder must exist. In master-slave
mode, all device paths are required.
Configuration
Examples
The following example sets the startup configuration file path to flash:/ruijie.text..
Ruijie(config)#boot config flash:/ruijie.text
Related
Commands
Command
Description
N/A
N/A
Platform
Description
N/A

Command Reference Basic Configuration Management Commands
2.9 configure
Use this command to enter global configuration mode.
configure [ terminal ]
Parameter
Description
Parameter
Description
N/A
N/A
Defaults
N/A
Command
Mode
Privileged EXEC mode
Usage Guide
N/A
Configuration
Examples
The following example enters global configuration mode.
Ruijie# configure
Ruijie(config)#
Related
Commands
Command
Description
N/A
N/A
Platform
Description
N/A
2.10 disable
Use this command to switch from privileged EXEC mode to user EXEC mode or lower the privilege
level.
disable [privilege-level ]
Parameter
Description
Parameter
Description
privilege-level
Privilege level
Defaults
N/A
Command
Mode
User EXEC mode

Command Reference Basic Configuration Management Commands
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
Examples
The following example lowers the current privilege level of the device to level 10.
Ruijie# disable 10
Related
Commands
Command
Description
enable
Moves from user EXEC mode enter to
privileged EXEC mode or reaches a higher
level of authority.
Platform
Description
N/A
2.11 disconnect
Use this command to disconnect the Telnet Client session.
disconnect session-id
Parameter
Description
Parameter
Description
session-id
Telnet Client session ID.
Defaults
N/A
Command
Mode
User EXEC mode
Usage Guide
This command is used to disconnect the Telnet Client session by setting the session ID.
Configuration
Examples
The following example disconnects the Telnet Client session by setting the session ID.
Ruijie# disconnect 1
Related
Commands
Command
Description
N/A
N/A
Platform
Description
N/A

Command Reference Basic Configuration Management Commands
2.12 do telnet
Use this command to login to Telnet server.
do telnet host [ port ] [ /source { ip A.B.C.D | ipv6 X:X:X:X::X | interface interface-name }]
Parameter
Description
Parameter
Description
host
IPv4, IPv6 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
Mode
User EXEC mode/Privileged EXEC mode/Interface configuration mode
Usage Guide
N/A
Configuration
Examples
The following example configures destination IPv6 address 2AAA:BBBB::CCCC.
Ruijie(config)# do telnet 2AAA:BBBB::CCCC
Related
Commands
Command
Description
N/A
N/A
Platform
Description
N/A
2.13 enable
Use this command to enter privileged EXEC mode.
Enable [ privilege-level ]
Parameter
Description
Parameter
Description
privilege-level
Privilege level
Defaults
N/A
Command
User EXEC mode

Command Reference Basic Configuration Management Commands
Mode
Usage Guide
Use this command to enter privileged EXEX mode from User EXEC mode. You can raise or lower the
privilege level by specifying the privilege level.
Configuration
Examples
The following example lowers the privilege level to 14:
Ruijie> enable 14
Password:
Related
Commands
Command
Description
N/A
N/A
Platform
Description
N/A
2.14 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 ]{ [ 0] password | 7 encrypted-password }
no enable password [ level leve l ]
Parameter
Description
Parameter
Description
password
Password for the user to enter the EXEC configuration layer
level
User's level.
0
The password is in plain text.
7encrypted-password
The password is encrypted.
Defaults
N/A
Command
Mode
Global configuration 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