RGS Series: CLI Reference Guide
RGS Series: CLI Reference Guide
Version 1
Edition 3, 02/2023
i
IMPORTANT!
This is a Reference Guide for a series of products intended for people who want to configure the Switch
through Command Line Interface (CLI).
Note: Some commands or command options in this guide may not be available in your
product. See your product's User’s Guide for a list of supported features. Every effort has been
made to ensure that the information in this guide is accurate.
Related Documentation
• Quick Start Guide
The Quick Start Guide shows you how to connect the Switch and access the Web Configurator.
• User’s Guide
The User’s Guide explains how to use the Web Configurator to configure the Switch.
Note: It is recommended you use the Web Configurator to configure the Switch.
• More Information
Go to https://support.zyxel.com/ to find other information on the Switch.
ii
CONTENTS
1 SCOPE .................................................................................................................................................. 2
1.1 SCOPE ................................................................................................................................................................... 2
1.2 AUDIENCE .............................................................................................................................................................. 2
1.3 PRE-REQUIRED KNOWLEDGE ...................................................................................................................................... 2
1.4 ACCESS TO HARDWARE INTERFACE .............................................................................................................................. 2
1.5 RELATED DOCUMENTS .............................................................................................................................................. 2
2 OPERATOR INTERFACE ......................................................................................................................... 4
2.1 INTRODUCTION ....................................................................................................................................................... 4
2.2 CONNECT INTERFACE ................................................................................................................................................ 4
2.3 SCREEN DESCRIPTION ............................................................................................................................................... 4
2.4 EXECUTION MODES ................................................................................................................................................. 5
2.5 GETTING HELP ........................................................................................................................................................ 6
2.6 TERMINAL KEY FUNCTION ......................................................................................................................................... 6
2.7 NOTATION CONVENTIONS ......................................................................................................................................... 6
3 COMMANDS DESCRIPTIONS ............................................................................................................... 8
3.1 INITIALIZE MODE COMMANDS ................................................................................................................................... 8
3.1.1 exit ................................................................................................................................................ 8
3.1.2 configure terminal ...................................................................................................................... 8
3.1.3 enable .......................................................................................................................................... 8
3.1.4 Show terminal .............................................................................................................................. 8
3.1.5 Show history ................................................................................................................................. 8
3.1.6 Show clock .................................................................................................................................. 8
3.1.7 Show clock detail ....................................................................................................................... 8
3.2 ENABLE MODE COMMANDS ...................................................................................................................................... 8
3.2.1 configure terminal ...................................................................................................................... 8
3.2.2 disable .......................................................................................................................................... 9
3.2.3 show aaa ..................................................................................................................................... 9
3.2.4 show access management....................................................................................................... 9
3.2.5 show access-list ........................................................................................................................... 9
3.2.6 show aggregation ...................................................................................................................... 9
3.2.7 show alarm .................................................................................................................................. 9
3.2.8 show cpu-load .......................................................................................................................... 10
3.2.9 show green-ethernet ................................................................................................................ 10
3.2.10 show ip ....................................................................................................................................... 10
3.2.11 show ipmc ................................................................................................................................. 10
3.2.12 show ipv6 ................................................................................................................................... 10
3.2.13 show lacp .................................................................................................................................. 11
3.2.14 show line .................................................................................................................................... 11
3.2.15 show logging ............................................................................................................................. 11
3.2.16 show loop-protec ..................................................................................................................... 11
3.2.17 show ntp status.......................................................................................................................... 11
3.2.18 show users .................................................................................................................................. 11
3.2.19 show running-cfg ...................................................................................................................... 11
3.2.20 show running-config interface Gigabit .................................................................................. 12
3.2.21 show running-config interface vlan........................................................................................ 12
3.2.22 show running-config all-defaults ............................................................................................. 12
3.2.23 show running-config feature ................................................................................................... 12
3.2.24 show running-config line .......................................................................................................... 12
3.2.25 show running-config vlan ........................................................................................................ 12
iii
3.2.26 show version .............................................................................................................................. 12
3.2.27 show clock ................................................................................................................................. 13
3.2.28 show ddmi ................................................................................................................................. 13
3.2.29 show version .............................................................................................................................. 13
3.2.30 show system inventory.............................................................................................................. 13
3.2.31 show mac address table aging-time ..................................................................................... 13
3.2.32 show mac address table ......................................................................................................... 13
3.2.33 show mac address table conf ................................................................................................ 13
3.2.34 show mac address table count .............................................................................................. 13
3.2.35 show mac address table learning .......................................................................................... 13
3.2.36 show mac address table static ............................................................................................... 14
3.2.37 show mac address table interface ........................................................................................ 14
3.2.38 show mac address vlan <vlanid> ........................................................................................... 14
3.2.39 show mvr .................................................................................................................................... 14
3.2.40 show fdb static table ................................................................................................................ 14
3.2.41 show fdbstatic interface gigabit <portNo> ........................................................................... 14
3.2.42 show fdbstatic vlan <vlanid> .................................................................................................. 15
3.2.43 show interface port < port_type_list > .................................................................................... 15
3.2.44 show interface port <portNo> statistics.................................................................................. 15
3.2.45 show platform phy .................................................................................................................... 15
3.2.46 show poe ................................................................................................................................... 15
3.2.47 show port-security ..................................................................................................................... 15
3.2.48 show profile alarm .................................................................................................................... 16
3.2.49 show snmp ................................................................................................................................. 16
3.2.50 show spanning-tree .................................................................................................................. 17
3.2.51 show switchport forbidden ...................................................................................................... 17
3.2.52 show tacacs-server................................................................................................................... 17
3.2.53 show vlan ................................................................................................................................... 17
3.2.54 show vlan id ............................................................................................................................... 17
3.2.55 show vlan name........................................................................................................................ 17
3.2.56 show vlan brief .......................................................................................................................... 17
3.2.57 show vlan status ........................................................................................................................ 18
3.2.58 show qos-queue-mapping ...................................................................................................... 18
3.2.59 show interface ports <portNo> priority ................................................................................... 18
3.2.60 show qos .................................................................................................................................... 18
3.2.61 show queue-shaper.................................................................................................................. 18
3.2.62 show port-shaper ...................................................................................................................... 18
3.2.63 show interface gigabit <portNo> storm-control ................................................................... 18
3.2.64 show interface gigabit <portNo> transceiver ....................................................................... 19
3.2.65 show qos interface ................................................................................................................... 19
3.2.66 show qos maps ......................................................................................................................... 19
3.2.67 show qos qce ............................................................................................................................ 19
3.2.68 show qos storm {unknown-uc|unknown-mc|broadcast} .................................................. 19
3.2.69 show port-mirror ........................................................................................................................ 19
3.2.70 show rmon ................................................................................................................................. 20
3.2.71 show interface gigabit <portNo> ........................................................................................... 20
3.2.72 show interface vlan .................................................................................................................. 20
3.2.73 show interface vlan <vlanid> .................................................................................................. 20
3.2.74 show interface gigabit <portNo> vlan ................................................................................... 20
3.2.75 show multicast-fdb ................................................................................................................... 20
3.2.76 show dot1x................................................................................................................................. 20
3.2.77 show dot1x status...................................................................................................................... 21
3.2.78 show dot1x statistics ................................................................................................................. 21
3.2.79 show radius-server [ statistics ] ................................................................................................. 21
3.2.80 show voice................................................................................................................................. 21
3.2.81 show web................................................................................................................................... 21
iv
3.3 CONFIGURE MODE COMMANDS............................................................................................................................... 22
3.3.1 interface gigabit <portNo> ..................................................................................................... 22
3.3.2 interface vlan <vlanid> ............................................................................................................ 22
3.3.3 aaa ............................................................................................................................................. 22
3.3.4 access ........................................................................................................................................ 22
3.3.5 access-list ................................................................................................................................... 22
3.3.6 aggregation mode................................................................................................................... 22
3.3.7 alarm history clear .................................................................................................................... 22
3.3.8 banner........................................................................................................................................ 22
3.3.9 ddmi ........................................................................................................................................... 23
3.3.10 default access-list rate-limiter.................................................................................................. 23
3.3.11 profile sch................................................................................................................................... 23
3.3.12 ntp server <1-5> ip-address <ip> ............................................................................................. 23
3.3.13 clock timezone.......................................................................................................................... 23
3.3.14 clock summer-time set [start-time] [end-time] ...................................................................... 23
3.3.15 account add <username> ...................................................................................................... 24
3.3.16 account delete <username> .................................................................................................. 24
3.3.17 configuration save and replace ............................................................................................. 24
3.3.18 clear ip igmp snooping statistics ............................................................................................. 24
3.3.19 clear logging ............................................................................................................................. 24
3.3.20 clear mac address-table ......................................................................................................... 24
3.3.21 debug ........................................................................................................................................ 25
3.3.22 delete ......................................................................................................................................... 25
3.3.23 dir ................................................................................................................................................ 25
3.3.24 do................................................................................................................................................ 25
3.3.25 duplex ........................................................................................................................................ 25
3.3.26 editing ........................................................................................................................................ 25
3.3.27 firmware ..................................................................................................................................... 25
3.3.28 flowcontrol ................................................................................................................................. 25
3.3.29 frame-sizes ................................................................................................................................. 26
3.3.30 green-etherneteee ................................................................................................................... 26
3.3.31 green-etherneteee urgent-queues ........................................................................................ 26
3.3.32 help ............................................................................................................................................. 26
3.3.33 iparp inspection ........................................................................................................................ 26
3.3.34 ip arp inspection translate ....................................................................................................... 26
3.3.35 ip arp inspection entry ............................................................................................................. 26
3.3.36 ip arp inspection vlan ............................................................................................................... 27
3.3.37 ip dns proxy ............................................................................................................................... 27
3.3.38 ip http secure-redirect ............................................................................................................. 27
3.3.39 ip http secure-server ................................................................................................................. 27
3.3.40 ip source binding interface ..................................................................................................... 27
3.3.41 ip ssh* .......................................................................................................................................... 27
3.3.42 ip name-server .......................................................................................................................... 27
3.3.43 ip route ....................................................................................................................................... 27
3.3.44 ip verify ....................................................................................................................................... 28
3.3.45 ipmc profile................................................................................................................................ 28
3.3.46 ipmc range ................................................................................................................................ 28
3.3.47 lacp ............................................................................................................................................ 28
3.3.48 line .............................................................................................................................................. 28
3.3.49 login host .................................................................................................................................... 28
3.3.50 login level ................................................................................................................................... 29
3.3.51 login on ...................................................................................................................................... 29
3.3.52 logout ......................................................................................................................................... 29
3.3.53 mac address-table aging-time ............................................................................................... 29
3.3.54 mac address-table static ......................................................................................................... 29
3.3.55 more ........................................................................................................................................... 29
v
3.3.56 no ................................................................................................................................................ 29
3.3.57 ping............................................................................................................................................. 29
3.3.58 port-security ............................................................................................................................... 30
3.3.59 privilege...................................................................................................................................... 30
3.3.60 reload ......................................................................................................................................... 30
3.3.61 rmon ........................................................................................................................................... 30
3.3.62 rmon alarm ................................................................................................................................ 30
3.3.63 rmon alarm ................................................................................................................................ 31
3.3.64 terminal ...................................................................................................................................... 31
3.3.65 vlan <vlanid> ............................................................................................................................. 31
3.3.66 vlan <vlanid> <name> ............................................................................................................. 32
3.3.67 vlan disable <vlanid> ............................................................................................................... 32
3.3.68 mac address-table aging-time <time> .................................................................................. 32
3.3.69 mtu <value> .............................................................................................................................. 32
3.3.70 media-type ................................................................................................................................ 32
3.3.71 monitor destination interface .................................................................................................. 32
3.3.72 monitor source interface ......................................................................................................... 32
3.3.73 monitor source cpu .................................................................................................................. 33
3.3.74 speed ......................................................................................................................................... 33
3.3.75 tacacs-server host .................................................................................................................... 33
3.3.76 tacacs-server key...................................................................................................................... 33
3.3.77 tacacs-server timeout .............................................................................................................. 33
3.3.78 traps ............................................................................................................................................ 33
3.3.79 upnp ........................................................................................................................................... 34
3.3.80 upnp advertising-duration ....................................................................................................... 34
3.3.81 upnp ttl ....................................................................................................................................... 34
3.3.82 username ................................................................................................................................... 34
3.3.83 web............................................................................................................................................. 34
3.3.84 flow-control {enable|disble} ................................................................................................... 35
3.3.85 speed ......................................................................................................................................... 35
3.3.86 port {enable/disable} ............................................................................................................... 35
3.3.87 Date/Time .................................................................................................................................. 35
3.4 VLAN MODE COMMANDS...................................................................................................................................... 35
3.4.1 vlan ............................................................................................................................................. 35
3.4.2 vlan ethertype s-custom-port .................................................................................................. 36
3.4.3 vlan-trunking .............................................................................................................................. 36
3.4.4 switchport access vlan............................................................................................................. 36
3.4.5 switchport forbidden vlan........................................................................................................ 36
3.4.6 switchport hybrid acceptable-frame-type ........................................................................... 36
3.4.7 switchport hybrid allowed vlan ............................................................................................... 36
3.4.8 switchport hybrid egress-tag ................................................................................................... 36
3.4.9 switchport hybrid ingress-filtering ............................................................................................ 37
3.4.10 switchport mode ....................................................................................................................... 37
3.4.11 switchport trunk allowed vlan ................................................................................................. 37
3.5 INTERFACE VLAN MODE COMMANDS ....................................................................................................................... 37
3.5.1 interface .................................................................................................................................... 37
3.5.2 interface vlan ............................................................................................................................ 37
3.5.3 ip address................................................................................................................................... 37
3.5.4 ip name-server .......................................................................................................................... 38
3.5.5 ip dhcp relay ............................................................................................................................. 38
3.5.6 ip dhcp relay information option ............................................................................................ 38
3.5.7 ip dhcp snooping ..................................................................................................................... 38
3.5.8 ip helper-address ...................................................................................................................... 38
3.5.9 ipv6 address .............................................................................................................................. 38
3.5.10 ipv6mtu ...................................................................................................................................... 38
3.6 RINGV2 GROUP MODE COMMANDS ........................................................................................................................ 39
vi
3.6.1 ringv2 protect ............................................................................................................................ 39
3.6.2 guard-time ................................................................................................................................. 39
3.6.3 mode .......................................................................................................................................... 39
3.6.4 node1 interface GigabitEthernet <portNo>} ........................................................................ 39
3.6.5 node2 interface GigabitEthernet <portNo>} ........................................................................ 39
3.6.6 role .............................................................................................................................................. 39
3.7 SPANNING TREE COMMANDS................................................................................................................................... 40
3.7.1 spanning-tree ............................................................................................................................ 40
3.7.2 spanning-tree aggregation ..................................................................................................... 40
3.7.3 spanning-tree auto-edge ........................................................................................................ 40
3.7.4 spanning-tree bpdu-guard...................................................................................................... 40
3.7.5 spanning-tree edge ................................................................................................................. 40
3.7.6 spanning-tree edge bpdu-filter .............................................................................................. 40
3.7.7 spanning-tree mode ................................................................................................................ 40
3.7.8 spanning-tree mst cost ............................................................................................................. 41
3.7.9 spanning-tree mst port-priority ................................................................................................ 41
3.7.10 spanning-tree mst priority ........................................................................................................ 41
3.7.11 spanning-tree mst vlan............................................................................................................. 41
3.7.12 spanning-tree mst forward-time ............................................................................................. 41
3.7.13 spanning-tree mst max-age .................................................................................................... 41
3.7.14 spanning-tree mst max-hops ................................................................................................... 41
3.7.15 spanning-tree mst name.......................................................................................................... 42
3.7.16 spanning-tree mst <instance> ................................................................................................. 42
3.7.17 spanning-tree recovery ........................................................................................................... 42
3.7.18 spanning-tree transmit ............................................................................................................. 42
3.8 SNMP CONFIGURE COMMANDS .............................................................................................................................. 42
3.8.1 snmp-server ............................................................................................................................... 42
3.8.2 snmp-server access .................................................................................................................. 42
3.8.3 snmp-server community v2c ................................................................................................... 43
3.8.4 snmp-server community v3...................................................................................................... 43
3.8.5 snmp-server host ....................................................................................................................... 43
3.8.6 snmp-server host traps.............................................................................................................. 43
3.8.7 snmp-server trap ....................................................................................................................... 43
3.8.8 snmp-server user ....................................................................................................................... 43
3.8.9 snmp-server version .................................................................................................................. 44
3.8.10 snmp-server view ...................................................................................................................... 44
3.8.11 SNMP trap receive ipv6 host ................................................................................................... 44
3.8.12 snmp-server contact ................................................................................................................ 44
3.8.13 snmp-server engine-id .............................................................................................................. 44
3.8.14 snmp-server location ................................................................................................................ 44
3.8.15 snmp-server security-to-group................................................................................................. 45
3.8.16 SNMP trap receive ipv4 host ................................................................................................... 45
3.9 QOS FUNCTION COMMAND .................................................................................................................................... 45
3.9.1 qos qce ...................................................................................................................................... 45
3.9.2 qos storm .................................................................................................................................... 45
3.9.3 qos cos ....................................................................................................................................... 45
3.9.4 qos dscp-classify ....................................................................................................................... 46
3.9.5 qos dscp-remark ....................................................................................................................... 46
3.9.6 qos dscp-translate .................................................................................................................... 46
3.9.7 qos map cos-dscp .................................................................................................................... 46
3.9.8 qos map cos-dscp .................................................................................................................... 46
3.9.9 qos map dscp-egress-translation ........................................................................................... 46
3.9.10 qos map dscp-ingress-translation ........................................................................................... 47
3.9.11 qos policer ................................................................................................................................. 47
3.9.12 qos wrr ........................................................................................................................................ 47
3.9.13 qos queue-shaper .................................................................................................................... 48
vii
3.9.14 qos queue-policer .................................................................................................................... 48
3.9.15 qos shaper <unit> ..................................................................................................................... 48
3.10 IGMP FUNCTIONAL COMMANDS ............................................................................................................................. 48
3.10.1 ip igmp host-proxy [ leave-proxy ] .......................................................................................... 48
3.10.2 ip igmp snooping ...................................................................................................................... 48
3.10.3 ip igmp snooping immediate-leave ....................................................................................... 48
3.10.4 ip igmp snooping last-member-query-interval...................................................................... 48
3.10.5 ip igmp snooping max-groups ................................................................................................ 48
3.10.6 ip igmp snooping mrouter ....................................................................................................... 49
3.10.7 ip igmp snooping querier ......................................................................................................... 49
3.10.8 ip igmp snooping query-interval ............................................................................................. 49
3.10.9 ip igmp snooping vlan.............................................................................................................. 49
3.10.10 ip igmp ssm-range .................................................................................................................... 49
3.10.11 ip igmp unknown-flooding ...................................................................................................... 49
3.10.12 clear ip igmp snooping statistics ............................................................................................. 49
3.11 MVR FUNCTIONAL COMMANDS .............................................................................................................................. 50
3.11.1 mvr .............................................................................................................................................. 50
3.11.2 mvr immediate-leave ............................................................................................................... 50
3.11.3 mvr name channel ................................................................................................................... 50
3.11.4 mvr frame priority ...................................................................................................................... 50
3.11.5 mvr name <word16> frame tagged ...................................................................................... 50
3.11.6 mvr name <word16> igmp-address <ipv4_ucast> ............................................................... 50
3.11.7 mvr name <word16> last-member-query-interval <0-31744> ............................................. 50
3.11.8 mvr name <word16> mode..................................................................................................... 50
3.11.9 mvr name <word16> type ....................................................................................................... 51
3.11.10 mvr vlan ..................................................................................................................................... 51
3.11.11 mvr vlan <vlan_list> channel ................................................................................................... 51
3.11.12 mvr vlan <vlan_list> frame priority ........................................................................................... 51
3.11.13 mvr vlan <vlan_list> frame tagged ......................................................................................... 51
3.11.14 mvr vlan <vlan_list> igmp-address .......................................................................................... 51
3.11.15 mvr vlan <vlan_list> mode ....................................................................................................... 51
3.11.16 mvr vlan <vlan_list> type .......................................................................................................... 52
3.12 MLD FUNCTIONAL COMMANDS............................................................................................................................... 52
3.12.1 ipv6 mld host-proxy................................................................................................................... 52
3.12.2 ipv6 mld snooping .................................................................................................................... 52
3.12.3 ipv6 mld snooping compatibility............................................................................................. 52
3.12.4 ipv6 mld snooping immediate-leave ..................................................................................... 52
3.12.5 ipv6 mld snooping last-member-query-interval .................................................................... 52
3.12.6 ipv6 mld snooping max-groups............................................................................................... 52
3.12.7 ipv6 mld snooping mrouter ...................................................................................................... 53
3.12.8 ipv6 mld snooping query-interval ........................................................................................... 53
3.12.9 ipv6 mld snooping query-max-response-time ....................................................................... 53
3.12.10 ipv6 mld snooping vlan ............................................................................................................ 53
3.12.11 ipv6 mld ssm-range................................................................................................................... 53
3.12.12 ipv6 mld unknown-flooding ..................................................................................................... 53
3.12.13 ipv6 route ................................................................................................................................... 53
3.13 AUTHENTICATE MODE COMMANDS .......................................................................................................................... 54
3.13.1 radius-server attribute 32 ......................................................................................................... 54
3.13.2 radius-server attribute 4 ........................................................................................................... 54
3.13.3 radius-server attribute 95 ......................................................................................................... 54
3.13.4 radius-server deadtime ............................................................................................................ 54
3.13.5 radius-server host [ auth-port] [ acct-port ] [ timeout ] [ retransmit ] [ key] ...................... 54
3.13.6 radius -server key ...................................................................................................................... 54
3.13.7 radius-server retransmit ............................................................................................................ 54
3.13.8 radius-server timeout ................................................................................................................ 55
3.13.9 tacacs-server deadtime <1-1440> ......................................................................................... 55
viii
3.13.10 tacacs-server host [ auth-port] [ timeout ] [ key] .................................................................. 55
3.13.11 tacacs-server deadtime <1-1440> ......................................................................................... 55
3.13.12 tacacs-server deadtime <1-1440> ......................................................................................... 55
3.13.13 dot1x feature ............................................................................................................................. 55
3.13.14 dot1x authentication timer ...................................................................................................... 55
3.13.15 dot1x max-reauth-req .............................................................................................................. 56
3.13.16 dot1x re-authentication ........................................................................................................... 56
3.13.17 dot1x system-auth-controln ..................................................................................................... 56
3.13.18 dot1x timeout ............................................................................................................................ 56
3.13.19 dot1x guest-vlan ....................................................................................................................... 56
3.13.20 dot1x initialize ............................................................................................................................ 56
3.13.21 dot1x port-control ..................................................................................................................... 56
3.13.22 dot1x radius-vlan....................................................................................................................... 57
3.13.23 show radius-server [ statistics ] ................................................................................................. 57
3.13.24 enable ........................................................................................................................................ 57
3.13.25 end ............................................................................................................................................. 57
3.13.26 exit .............................................................................................................................................. 57
3.13.27 hostname ................................................................................................................................... 57
3.14 LOOP-PROTECTION CONFIGURE COMMANDS .............................................................................................................. 57
3.14.1 loop-protect .............................................................................................................................. 57
3.14.2 loop-protect action .................................................................................................................. 57
3.14.3 loop-protect shutdown-time ................................................................................................... 57
3.14.4 loop-protect transmit-time ...................................................................................................... 58
3.14.5 loop-protect tx-mode .............................................................................................................. 58
3.15 LLDP CONFIGURE COMMANDS ................................................................................................................................ 58
3.15.1 lldp holdtime.............................................................................................................................. 58
3.15.2 lldp med ..................................................................................................................................... 58
3.15.3 lldp receive ................................................................................................................................ 58
3.15.4 lldp reinit <1-10> ........................................................................................................................ 59
3.15.5 lldp timer <5-32768>.................................................................................................................. 59
3.15.6 lldp tlv-select ............................................................................................................................. 59
3.15.7 lldp transmission-delay ............................................................................................................. 59
3.15.8 lldp transmit ............................................................................................................................... 59
3.16 RFC2544 TESTING CONFIGURE COMMANDS ............................................................................................................. 59
3.16.1 rfc2544 profile <word32>.......................................................................................................... 59
3.16.2 rfc2544 rename profile ............................................................................................................. 59
3.16.3 rfc2544 save <word32> <word> .............................................................................................. 60
3.16.4 rfc2544 start <word32> profile <word32> [ desc <line128> ] ............................................... 60
3.16.5 rfc2544 stop <word32> ............................................................................................................. 60
3.16.6 show rfc2544 profile [ <word32> ] ........................................................................................... 60
3.17 GVRP CONFIGURE COMMANDS............................................................................................................................... 60
3.17.1 gvrp ............................................................................................................................................ 60
3.17.2 gvrpjoin request vlan ................................................................................................................ 60
3.17.3 gvrpleave request vlan ............................................................................................................ 60
3.17.4 gvrp max-vlans .......................................................................................................................... 61
3.17.5 gvrp time { [ join-time <1-20> ] [ leave-time <60-300> ] [ leave-all-time <1000-50>] ........ 61
3.18 VOICE VLAN CONFIGURE COMMANDS ...................................................................................................................... 61
3.18.1 voice vlan .................................................................................................................................. 61
3.18.2 voice vlan aging-time .............................................................................................................. 61
3.18.3 voice vlan class ......................................................................................................................... 61
3.18.4 voice vlan oui ............................................................................................................................ 61
3.18.5 voice vlan vid ............................................................................................................................ 61
3.19 PROFILE ALARM COMMANDS ................................................................................................................................... 62
3.19.1 profile alarm .............................................................................................................................. 62
3.19.2 alarm .......................................................................................................................................... 62
3.20 POE COMMANDS .................................................................................................................................................. 62
ix
3.20.1 poe management mode ........................................................................................................ 62
3.20.2 poe supply ................................................................................................................................. 62
3.20.3 poe 4pairs .................................................................................................................................. 63
3.20.4 poe mode.................................................................................................................................. 63
3.20.5 poe operation ........................................................................................................................... 63
3.20.6 poe power ................................................................................................................................. 63
3.20.7 poe priority................................................................................................................................. 63
3.20.8 poe reset .................................................................................................................................... 63
3.20.9 poe schedule ............................................................................................................................ 64
[LIST OF TABLES]
Table 2-1 List of Execution Modes .................................................................................................................. 5
Table 2-2 List of Terminal Keys ....................................................................................................................... 6
[LIST OF FIGURES]
Figure 2-1 Screen Description ........................................................................................................................ 5
x
1. Scope
1.1 Scope
1.2 Audience
1
1 Scope
1.1 Scope
This user guide describes the commands and parameters of the Command Line
Interface (CLI) as implemented in the current version of RGS series software. These
commands are used to set-up, administer and maintain the system.
1.2 Audience
The guide is intended for operating personnel (sometimes called craft persons) who
want to configure the Switch through Command Line Interface (CLI).
2
2. Operator Interface
2.1 Introduction
3
2 Operator Interface
2.1 Introduction
Access to the Switch is protected by a logon security system. You can log on to the
switch with the user name and password. After three failed logon attempts, the
system refuses further attempts.
After you log on, the system monitors the interface for periods of inactivity. If the
interface is inactive for too long, you are automatically logged off.
The CLI initial user name is (admin) and none password (). You should change the
password as soon as possible, because the initial password is known to anyone who
reads this manual. You can also change the user name or add additional user
names. Use the “account add” command to enter a new user identification,
password and authorization level.
4
Figure 2-1 Screen Description
5
2.5 Getting Help
The user can get help by entering a question mark ‘?’ at each position in the
command. The displayed result depends on the execution mode and previous
input.
6
3. Commands Descriptions
7
3 Commands Descriptions
3.1.1 exit
Description Exit current mode and quit CLI
Syntax exit
Parameter None
3.1.3 enable
Description Enter enable mode
Syntax enable
Parameter None
8
3.2.2 disable
Description Enter init mode
Syntax disable
Parameter None
3.2.10 show ip
Description IP information
Syntax show ip
Parameter
Name Description
arp Address Resolution Protocol
dhcp Dynamic Host Configuration Protocol
http Hypertext Transfer Protocol
igmp Internet Group Management Protocol
interface IP interface status and configuration
name-server Domain Name System
route Display the current IP routing table
source source command
statistics Traffic statistics
verify verify command
10
mld Multicast Listener Discovery
neighbor IPv6 neighbors
route IPv6 routes
statistics Traffic statistics
11
3.2.20 show running-config interface Gigabit
Description Show port config
Syntax show running-config interface ( <port_type> [ <list> ] ) [ all-defaults ]
Parameter
Name Description
list <port_type_list> Port list in 1/1-14
all-defaults Include most/all default values
17
Name Description
id VLAN status by VLAN id
vlan_list <vlan_list> VLAN IDs 1-4095
name VLAN status by VLAN name
name <vword32> A VLAN name
brief VLAN summary information
18
Name Description
<port_type> Port type in Fast, Gigabit Ethernet
<portNo> Valid values: 1~12
Type: Mandatory
20
3.2.77 show dot1x status
Description Show dot1x stats
Syntax show dot1x status [ interface <port_type> [ <port_type_list> ] ] [ brief ]
Parameter None
21
3.3 Configure Mode Commands
Commands that can be executed under Configure Mode
3.3.3 aaa
Description Authentication
Syntax aaa authentication
Parameter
Name Description
authentication Authentication
3.3.4 access
Description Management configuration
Syntax access management
Parameter
Name Description
management Access management configuration
3.3.5 access-list
Description Enter ACL Profile Config Mode
Syntax profile acl
Parameter Name Description
<vlanid> Valid values: 1 ~ 4094
Type: Mandatory
Parameter None
3.3.8 banner
Description Banner control
22
Syntax banner { LINE | exec | login | motd }
Parameter
Name Description
LINE c banner-text c, where 'c' is a delimiting character
exec Set EXEC process creation banner
login Set login banner
motd Set Message of the Day banner
3.3.9 ddmi
Description Enable DDMI function
Syntax ddmi
Parameter None
24
3.3.21 debug
Description Set prompt for testing
Syntax debug prompt
Parameter
Name Description
<word> Word for prompt in 32 characters
3.3.22 delete
Description Delete one file in flash: file system
Syntax delete <word>
Parameter
Name Description
<word> Name of file to delete
3.3.23 dir
Description Directory of all files in flash: file system
Syntax dir
Parameter
3.3.24 do
Description To run exec commands in config mode
Syntax do <line>
Parameter
Name Description
<line> Exec Command
3.3.25 duplex
Description Set duplex mode
Syntax duplex { half | full | auto [ half | full ] }
Parameter
Name Description
half Forced half duplex
full Forced full duplex
auto Auto negotiation of duplex mode
[ half | full ] Advertise half/full duplex
3.3.26 editing
Description Enable command line editing
Syntax editing
Parameter
3.3.27 firmware
Description Firmware swap and upgrade
Syntax firmware { swap | upgrade }
Parameter
Name Description
swap Swap between Active and Alternate firmware image
upgrade Firmware upgrade
3.3.28 flowcontrol
Description Enable/disable flow control
Syntax flowcontrol { on | off }
Parameter
Name Description
on Enable flow control
off Disable flow control
25
3.3.29 frame-sizes
Description Select the frame sizes that the enabled tests will loop through
Syntax frame-sizes { [ 64 ] [ 128 ] [ 256 ] [ 512 ] [ 1024 ] [ 1280 ] [ 1518 ] [ 2000 ] [ 9600 ] }
Parameter
Name Description
64 Enable testing with 64-byte TST PDUs
128 Enable testing with 128-byte TST PDUs
256 Enable testing with 256-byte TST PDUs
512 Enable testing with 512-byte TST PDUs
1024 Enable testing with 1024-byte TST PDUs
1280 Enable testing with 1280-byte TST PDUs
1518 Enable testing with 1518-byte TST PDUs
2000 Enable testing with 2000-byte TST PDUs
9600 Enable testing with 9600-byte TST PDUs
3.3.30 green-etherneteee
Description Powering down of PHYs when there is no traffic.
Syntax green-etherneteee
Parameter
3.3.32 help
Description Description of the interactive help system
Syntax help
Parameter
26
in_port_type_id Port ID in the format of switch-no/port-no
vlan_var Select a VLAN id to configure
mac_var Select a MAC address to configure
ipv4_var Select an IP address to configure
3.3.41 ip ssh*
Description IP Secure Shell
Syntax ipssh
Parameter
* The SSH feature is removed after V1.00 FCS+2.
3.3.42 ip name-server
Description IP name server
Syntax ip name-server { <v_ipv4_ucast> | dhcp [ interface vlan <v_vlan_id> ] }
Parameter
Name Description
v_ipv4_ucast A valid IPv4 unicast address
dhcp Dynamic Host Configuration Protocol
v_vlan_id VLAN identifier(s): VID
3.3.43 ip route
Description IP Route
Syntax ip route <v_ipv4_addr> <v_ipv4_netmask> <v_ipv4_gw>
Parameter
27
Name Description
v_ipv4_addr Network
v_ipv4_netmask Netmask
v_ipv4_gw Gateway
3.3.44 ip verify
Description IP verify
Syntax ip verify [source] [translate]
Parameter
Name Description
source verify source
translate IP address verify source translate all entries
3.3.47 lacp
Description LACP system priority
Syntax lacp system-priority <v_1_to_65535>
Parameter
Name Description
system-priority System priority
<v_1_to_65535> Priority value, lower means higher priority
3.3.48 line
Description Console terminal control
Syntax line { <0~16> | console 0 | vty <0~15> }
Parameter
Name Description
<0~16> List of line numbers
console Console terminal line
vty Virtual terminal
28
3.3.50 login level
Description Log level
Syntax logging level { info | warning | error }
Parameter
Name Description
error Error
info Information
warning Warning
3.3.51 login on
Description System log in
Syntax logging on
Parameter
3.3.52 logout
Description System logout
Syntax logout
Parameter
3.3.55 more
Description File in FLASH or on TFTP server
Syntax more <Path>
Parameter
3.3.56 no
Description Function disable
Syntax no { debug | port-securit | terminal }
Parameter
Name Description
debug Debugging functions
port-securit Port security (psec limit)
terminal Set terminal line parameters
3.3.57 ping
Description The ping function
Syntax ping { ip | ipv6 }
Parameter
Name Description
ip IP (ICMP) echo
ipv6 IPv6 (ICMPv6) echo
29
3.3.58 port-security
Description Port security
Syntax port-security [aging] [time <v_10_to_10000000>]
Parameter
Name Description
aging Enable/disable port security aging
time Time in seconds between check for activity on learned
MAC addresses
v_10_to_10000000 <10-10000000> seconds
3.3.59 privilege
Description
Syntax privilege { exec | configure | config-vlan | line | interface | if-vlan |
ipmc-profile | snmps-host | stp-aggr | dhcp-pool | rfc2544-profile } level
<privilege> <cmd>
Parameter
Name Description
config-vlan VLAN configuration mode
configure Global configuration mod
dhcp-pool DHCP Pool configuration mode
exec Exec mode
if-vlan VLAN Interface mode
interface Port List Interface mode
ipmc-profile IPMC Profile mode
line Line configuration mode
rfc2544-profile RFC2544 Profile mode
snmps-host SNMP Server Host mode
stp-aggr STP Aggregation mode
3.3.60 reload
Description System or configuration reset
Syntax reload { cold | default }
Parameter
Name Description
cold Reload cold
defaults Reload defaults without rebooting
3.3.61 rmon
Description RMON
Syntax rmon {alarm | event}
Parameter
Name Description
alarm Configure an RMON alarm
event Configure an RMON event
30
ifInNUcastPkts The number of broad-cast and multi-cast packets
delivered to a higher-layer protocol
ifInOctets The total number of octets received on the interface,
including framing characters
ifInUcastPkts The number of uni-cast packets delivered to a
higher-layer protocol
ifInUnknownProtos The number of the inbound packets that were discarded
because of the unknown or un-support protocol
ifOutDiscards The number of outbound packets that are discarded
event the packets is normal
ifOutErrors The number of outbound packets that could not be
transmitted because of errors
ifOutNUcastPkts The number of broad-cast and multi-cast packets that
request to transmit
ifOutOctets The number of octets transmitted out of the interface,
including framing characters
ifOutUcastPkts The number of uni-cast packets that request to transmit
interval Sample interval
absolute Test each sample directly
delta Test delta between samples
rising_threshold <-2147483648-2147483647> rising threshold value
rising_event_id <0-65535> Event to fire on rising threshold crossing
falling_threshold <-2147483648-2147483647> falling threshold value
falling_event_id <0-65535> Event to fire on falling threshold crossing
both Trigger alarm when the first value is larger than the rising
threshold or less than the falling threshold (default)
falling Trigger alarm when the first value is less than the falling
threshold
rising Trigger alarm when the first value is larger than the rising
threshold
3.3.64 terminal
Description Terminal control
Syntax terminal { editing | exec-timeout | help | history | length | width }
Parameter
Name Description
editing Enable command line editing
exec-timeout Set the EXEC timeout
help Description of the interactive help system
history Control the command history function
length Set number of lines on a screen
width Set width of the display terminal
31
3.3.66 vlan <vlanid> <name>
Description Configure VLAN’s name
Syntax vlan <vlanid> <name>
Parameter
Name Description
<vlanid> Create an empty VLAN index.
Valid values: 1 ~ 4094
Type: Mandatory
<name> VLAN Name (0~31)
String Size:0~31
Type: Mandatory
3.3.70 media-type
Description Configure media-type
Syntax media-type { rj45 | sfp | dual }
Parameter
Name Description
rj45 RJ-45 interface (copper interface)
sfp SFP interface (fiber interface)
dual Dual media interface (copper and fiber
interface)
32
Syntax monitor source { { interface ( <port_type> [ <v_port_type_list> ] ) }
Parameter
Name Description
port_type 1 Gigabit Ethernet Port
v_port_type_lis Port list
3.3.74 speed
Description Configures interface speed. If you use 10, 100, or 1000 keywords with the auto
keyword the port will only advertise the specified speeds.
Syntax speed { 10g | 2500 | 1000 | 100 | 10 | auto { [ 10 ] [ 100 ] [ 1000 ] } }
Parameter
Name Description
1000 1 Gbps
100 100 Mbps
10 10 Mbps
auto Auto negotiation
[ 10 ] 10 Mbps
[ 10 0] 100 Mbps
[ 1000 ] 1 Gbps
3.3.78 traps
Description trap event configuration
Syntax traps [ aaa authentication ] [ system [ coldstart ] [ warmstart ] ] [ switch [ stp ]
[ rmon ] ]
33
Parameter
Name Description
aaa authentication AAA authentication fail event
coldstart Cold start event
warmstart Warm start event
stp STP event
rmon RMON event
3.3.79 upnp
Description Set UPnP's configurations
Syntax upnp
Parameter
3.3.82 username
Description User account
Syntax username <username> privilege <priv> password encrypted <encry_password>
username <username> privilege <priv> password none
username <username> privilege <priv> password unencrypted <password>
Parameter
Name Description
username <Username : word31> User name allows letters, numbers and
underscores
privilege Set user privilege level
priv User privilege level
password Specify the password for the user
encrypted Specifies an ENCRYPTED password will follow
none NULL password
unencrypted Specifies an UNENCRYPTED password will follow
3.3.83 web
Description
Syntax web privilege group <group_name> level { [ cro <cro> ] [ crw <crw> ] [ sro <sro> ]
[ srw <srw> ] }*1
Parameter
Name Description
privilege Web privilege
group Web privilege group
group_name Valid words are 'Aggregation' 'DHCP' 'Debug' 'Dhcp_Client'
'Diagnostics' 'EEE' 'Green_Ethernet' 'IP2' 'IPMC_Snooping' 'LACP'
'LLDP' 'Loop_Protect' 'MAC_Table' 'MVR' 'Maintenance' 'Mirroring'
'NTP' 'Ports' 'Private_VLANs' 'QoS' 'RPC' 'Security' 'Spanning_Tree'
'System' 'Timer' 'VCL' 'VLANs' 'Voice_VLAN' 'XXRP' 'sFlow'
level Web privilege group level
cro Configuration Read-only level
crw Configuration Read-write level
34
sro Status/Statistics Read-only level
srw Status/Statistics Read-write level
cro <Cro : 0-15>
crw <Crw : 0-15>
sro <Sro : 0-15>
srw <Srw : 0-15>
3.3.85 speed
Description Configure gigabit Ethernet speed and Copper/SFP for gigabit port 7~8
(port1~6 Only support copper, no SFP)
(port 9, 10 only support auto)
Syntax speed
{auto|full-l000mbps|full-100mbps|full-10mbps|half-100mbps|half-10mbps}
Parameter
Name Description
auto Auto negotiation
full-l000mbps Set 1000Mbps full duplexing
full-100mbps Set 100Mbps full duplexing
full-10mbps Set 10Mbps full duplexing
half-100mbps Set 100Mbps half duplexing
half-10mbps Set 10Mbps half duplexing
3.3.87 Date/Time
Description Set device date and time
Syntax clock datetime <2000-2037> <1-12> <1-31> <0-23> <0-59> <0-59>
Parameter
Name Description
<2000-2037> year
<1-12> month
<1-31> date
<0-23> hour
<0-59> minute
<0-59> second
35
vlan_lis ISL VLAN IDs 1~4095
3.4.3 vlan-trunking
Description Change whether trunking of unknown VLANs is enabled
Syntax vlan-trunking
Parameter
36
none No egress tagging
all Tag all frames
except-native Tag all frames except frames classified to native VLAN of
the hybrid port
3.5.3 ip address
Description IPv4 address configurations
Syntax ip address { { <ipv4_addr><ipv4_netmask> } | { dhcp [ fallback
<ipv4_addr><ipv4_netmask> [ timeout <uint> ] ] } }
Parameter
Name Description
37
ipv4_addr IP address
ipv4_netmask IP netmask
dhcp Enable DHCP
fallback DHCP fallback settings
ipv4_addr DHCP fallback address
ipv4_netmask DHCP fallback netmask
timeout DHCP fallback timeout
uint DHCP fallback timeout in seconds
3.5.4 ip name-server
Description Interface Internet Protocol config commands Domain Name System
Syntax ip name-server { <ipv4_ucast> | dhcp [ interface vlan<vlan_id> ] }
Parameter
Name Description
ipv4_ucast A valid IPv4 unicast address
vlan_id VLAN identifier(s): VID
3.5.8 ip helper-address
Description DHCP relay server
Syntax ip helper-address <v_ipv4_ucast>
Parameter
Name Description
Ip : ipv4_ucast IP address of the DHCP relay server
3.5.10 ipv6mtu
Description IPv6 Maximum transmission unit
Syntax ipv6 mtu<1280-1500>
Parameter
Name Description
1280-1500 MTU value in bytes
38
3.6 RingV2 Group Mode Commands
3.6.2 guard-time
Description Set guard time
Syntax guard-time { <ringGuardTimerDef> }
Parameter
Name Description
ringGuardTimerDef <10-3600>, unit: seconds. Default is 10 seconds
3.6.3 mode
Description Enable/disable ring group
Syntax mode { disable | enable }
Parameter
Name Description
disable Set the specified Ring group to Disabled
enable Set the specified Ring group to Enabled
3.6.6 role
Description Set role for group
Syntax role { ring-master | ring-slave | coupling-primary | coupling-backup |
dual-homing | chain-head | chain-tail | chain-member | b-chain-terminal-1 |
b-chain-terminal-2 | b-chain-central-block | b-chain-member}
Parameter
Name Description
ring-master Set role to ring master
ring-slave Set role to ring slave
coupling-primary Set role to coupling primary
coupling-backup Set role to coupling backup
dual-homing Set role to dual homing
chain-head Set role to chain head
chain-member Set role to chain member
chain-tail Set role to chain tail
b-chain-central-block Set role to balancing chain central block
b-chain-member Set role to balancing chain member
39
b-chain-terminal-1 Set role to balancing chain terminal 1
b-chain-terminal-2 Set role to balancing chain terminal 2
42
< v1 | v2c | v3 | any > V1~V3 security model
< level > security level
{ auth | noauth | priv } authNoPriv Security Level
noAuthNoPriv Security Level
authPriv Security Level
read specify a read view for the group
<word255> read view name
43
Name Description
<Username > 32 words
<Engine ID octet string> word10-32
MD5 Set MD5 protocol
sha Set SHA protocol
<word8-40> SHA password
priv Set Privacy
{ des | aes } Set DES/AES protocol
<word8-32> Set privacy password
44
3.8.15 snmp-server security-to-group
Description SNMP server security
Syntax snmp-server security-to-group model { v1 | v2c | v3 } name <security_name>
group <group_name>
Parameter
Name Description
model security model
v1 v1 security model
v2c v2c security model
v3 v3 security model
name security user
security_name <SecurityName : word32> security user name
group security group
group_name <GroupName : word32> security group name
45
3.9.4 qos dscp-classify
Description Set QoS DSCP-classify
Syntax qos dscp-classify { zero | selected | any }
Parameter
Name Description
47
3.9.13 qos queue-shaper
Description Configure queue-shaper command
Syntax qos queue-shaper queue <0~7> <uint> [ excess ]
Parameter
Name Description
<1-100> Every level proportion
<unit> Traffic meter
[ excess ] Agree the shaper could be excess or not
48
Name Description
1-10 Maximum number of IGMP group registration
49
3.11 MVR Functional Commands
3.11.1 mvr
Description Multicast VLAN Registration configuration
Syntax mvr
Parameter
Name Description
50
Syntax mvr name <word16> mode { dynamic | compatible }
Parameter
Name Description
dynamic Dynamic MVR operation mode
compatible Compatible MVR operation mode
52
3.12.7 ipv6 mld snooping mrouter
Description IPv6 mld snooping multicast router port configuration
Syntax ipv6 mld snooping mrouter
Parameter
53
3.13 Authenticate Mode Commands
55
re-authenticate The period between re-authentication attempts in
seconds
56
3.13.22 dot1x radius-vlan
Description Enables/disables per-port state of RADIUS-assigned VLAN
Syntax dot1x radius-vlan
Parameter
3.13.24 enable
Description Privilege level control
Syntax Enable { password [ level <priv> ] <password>} | { secret { 0 | 5 } [ level <priv> ]
<password>}
Parameter
Name Description
password Assign the privileged level clear password
secret Assign the privileged level secret
3.13.25 end
Description Level exit
Syntax end
Parameter
3.13.26 exit
Description Level exit
Syntax end
Parameter
3.13.27 hostname
Description This system's network name
Syntax hostname <hostname>
Parameter
57
Parameter
Name Description
0-604800 Shutdown time in second
58
3.15.4 lldp reinit <1-10>
Description LLDP TX re-initialization delay in seconds
Syntax lldp reinit <1-10>
Parameter
Name Description
<1-10> Re-initialization delay time
59
profile <word32> Old profile name
<word32> New profile name
60
3.17.4 gvrp max-vlans
Description GVRP maximum number of VLANs
Syntax gvrp max-vlans<1-4095>
Parameter
Name Description
<1-4095> A valid range is from 1-4095
3.19.2 alarm
Description Set alarm content
Syntax alarm <alarmId> { mask | unmask | major | minor }
Parameter 101~114: GE-1~14 Port link down (for 14 port model)
Name Description
alarmId 151: set Power alarm
mask Set alarm as mask, it means event will not be send notify
unmask Set alarm as un-mask, it means event will be send notify
major Set alarm level as major
minor Set alarm level as minor
62
3.20.3 poe 4pairs
Description Enable 4pairs mode
Syntax poe 4pairs
Parameter
63
<0-59> Minute
<range_list> Day(s).(1:Sunday, 2:Monday, 3:Tuesday,
4:Wednesday, 5:Thuesday, 6:Friday, 7:Saturday)
64