ZyXEL Communications ES-2024PWR User Manual
Ethernet Switch
CLI Reference Guide
Version 3.90
7/2009
Edition 6
DEFAULT LOGIN
In-band IP Address http://192.168.1.1
Out-of-band IP Address http://192.168.0.1
User Name admin
Password 1234
www.zyxel.com
About This CLI Reference Guide
About This CLI Reference Guide
Intended Audience
This manual is intended for people who want to configure ZyXEL Switches via Command
Line Interface (CLI).
The version number on the cover page refers to the latest firmware version supported by the
ZyXEL Switches. This guide applies to version 3.79, 3.80 and 3.90 at the time of writing.
" This guide is intended as a command reference for a series of products.
Therefore many commands in this guide may not be available in your product.
See your User’s Guide for a list of supported features and details about feature
implementation.
Please refer to www.zyxel.com or your product’s CD for product specific User Guides and
product certifications.
How To Use This Guide
•Read the How to Access the CLI chapter for an overview of various ways you can get to
the command interface on your Switch.
• Use the Reference section in this guide for command syntax, description and examples.
Each chapter describes commands related to a feature.
• To find specific information in this guide, use the Contents Overview, the Index of
Commands, or search the PDF file. E-mail techwriters@zyxel.com.tw if you cannot find
the information you require.
CLI Reference Guide Feedback
Help us help you. Send all Reference Guide-related comments, questions or suggestions for
improvement to the following address, or use e-mail instead. Thank you!
The Technical Writing Team,
ZyXEL Communications Corp.,
6 Innovation Road II,
Science-Based Industrial Park,
Hsinchu, 300, Taiwan.
E-mail: techwriters@zyxel.com.tw
Ethernet Switch CLI Reference Guide
3
About This CLI Reference Guide
Customer Support
In the event of problems that cannot be solved by using this manual, you should contact your
vendor. If you cannot contact your vendor, then contact a ZyXEL office for the region in
which you bought the device. See http://www.zyxel.com/web/contact_us.php for contact
information. Please have the following information ready when you contact an office.
• Product model and serial number.
• Warranty Information.
• Date that you received your device.
• Brief description of the problem and the steps you took to solve it.
4
Ethernet Switch CLI Reference Guide
Document Conventions
Document Conventions
Warnings and Notes
These are how warnings and notes are shown in this CLI Reference Guide.
1 Warnings tell you about things that could harm you or your device. See your
User’s Guide for product specific warnings.
" Notes tell you other important information (for example, other things you may
need to configure or helpful tips) or recommendations.
Syntax Conventions
This manual follows these general conventions:
• ZyXEL’s switches (such as the ES-2024A, ES-2108, GS-3012, and so on) may be referred
to as the “Switch”, the “device”, the “system” or the “product” in this Reference Guide.
• Units of measurement may denote the “metric” value or the “scientific” value. For
example, “k” for kilo may denote “1000” or “1024”, “M” for mega may denote “1000000”
or “1048576” and so on.
Command descriptions follow these conventions:
• Commands are in
• Required input values are in angle brackets <>; for example,
must specify an IP address for this command.
• Optional fields are in square brackets []; for instance show logins [name], the name
field is optional.
The following is an example of a required field within an optional field: snmp-server
[contact <system contact>], the contact field is optional. However, if you
use contact, then you must provide the system contact information.
• Lists (such as <port-list>) consist of one or more elements separated by commas.
Each element might be a single value (1, 2, 3, ...) or a range of values (1-2, 3-5, ...)
separated by a dash.
•The | (bar) symbol means “or”.
• italic terms represent user-defined input values; for example, in snmp-server
[contact <system contact>], system contact can be replaced by the
administrator’s name.
• A key stroke is denoted by square brackets and uppercase text, for example, [ENTER]
means the “Enter” or “Return” key on your keyboard.
courier new font.
ping <ip> means that you
Ethernet Switch CLI Reference Guide
5
Document Conventions
• <cr> means press the [ENTER] key.
• An arrow (-->) indicates that this line is a continuation of the previous line.
Command summary tables are organized as follows:
Table 1 Example: Command Summary Table
COMMAND DESCRIPTION M P
show vlan Displays the status of all VLANs. E 3
vlan <1-4094> Enters config-vlan mode for the specified VLAN. Creates the
VLAN, if necessary.
inactive Disables the specified VLAN. C 13
no inactive Enables the specified VLAN. C 13
no vlan <1-4094> Deletes a VLAN. C 13
C13
The Table title identifies commands or the specific feature that the commands configure.
The COMMAND column shows the syntax of the command.
• If a command is not indented, you run it in the enable or config mode. See Chapter 2 on
page 19 for more information on command modes.
• If a command is indented, you run it in a sub-command mode.
The DESCRIPTION column explains what the command does. It also identifies legal input
values, if necessary.
The M column identifies the mode in which you run the command.
• E: The command is available in enable mode. It is also available in user mode if the
privilege level (P) is less than 13.
• C: The command is available in config (not indented) or one of the sub-command modes
(indented).
The P column identifies the privilege level of the command. If you don’t have a high enough
privilege level you may not be able to view or execute some of the commands. See Chapter 2
on page 19 for more information on privilege levels.
6
Ethernet Switch CLI Reference Guide
Document Conventions
Icons Used in Figures
Figures in this guide may use the following generic icons. The Switch icon is not an exact
representation of your device.
Switch Computer Notebook computer
Server DSLAM Firewall
Telephone Switch Router
Ethernet Switch CLI Reference Guide
7
Document Conventions
8
Ethernet Switch CLI Reference Guide
Contents Overview
Contents Overview
Introduction ............................................................................................................................13
How to Access and Use the CLI ................................................................................................ 15
Privilege Level and Command Mode ......................................................................................... 19
Initial Setup ................................................................................................................................ 25
Reference A-G ........................................................................................................................29
AAA Commands ........................................................................................................................ 31
ARP Commands ........................................................................................................................ 33
ARP Inspection Commands ...................................................................................................... 35
Bandwidth Commands .............................................................................................................. 41
Broadcast Storm Commands .................................................................................................... 45
CFM Commands ....................................................................................................................... 49
Classifier Commands ................................................................................................................ 59
Cluster Commands .................................................................................................................... 63
Date and Time Commands ........................................................................................................ 67
DHCP Commands ..................................................................................................................... 71
DHCP Snooping & DHCP VLAN Commands ............................................................................ 75
DiffServ Commands .................................................................................................................. 79
DVMRP Commands .................................................................................................................. 81
Ethernet OAM Commands ........................................................................................................ 83
GARP Commands ..................................................................................................................... 89
GVRP Commands ..................................................................................................................... 91
Reference H-M ........................................................................................................................93
HTTPS Server Commands ........................................................................................................ 95
IEEE 802.1x Authentication Commands ................................................................................... 99
IGMP and Multicasting Commands ......................................................................................... 101
IGMP Snooping Commands .................................................................................................... 105
IGMP Filtering Commands ...................................................................................................... 111
Interface Commands ............................................................................................................... 113
Interface Route-domain Mode ................................................................................................. 117
IP Commands .......................................................................................................................... 119
IP Source Binding Commands ................................................................................................ 123
Layer 2 Protocol Tunnel (L2PT) Commands ........................................................................... 125
Link Layer Discovery Protocol (LLDP) Commands ................................................................. 129
Logging Commands ................................................................................................................ 133
Login Account Commands ...................................................................................................... 135
Ethernet Switch CLI Reference Guide
9
Contents Overview
Loopguard Commands ............................................................................................................ 137
MAC Address Commands ....................................................................................................... 139
MAC Authentication Commands ............................................................................................. 141
MAC Filter Commands ............................................................................................................143
MAC Forward Commands ....................................................................................................... 145
Mirror Commands .................................................................................................................... 147
MRSTP Commands .................................................................................................................151
MSTP Commands ................................................................................................................... 153
Multiple Login Commands ....................................................................................................... 157
MVR Commands ..................................................................................................................... 159
Reference N-S ...................................................................................................................... 161
OSPF Commands ................................................................................................................... 163
Password Commands ............................................................................................................. 169
PoE Commands ...................................................................................................................... 171
Policy Commands .................................................................................................................... 175
Port Security Commands .........................................................................................................179
Port-based VLAN Commands ................................................................................................. 181
Protocol-based VLAN Commands ........................................................................................... 183
Queuing Commands ................................................................................................................ 185
RADIUS Commands ................................................................................................................189
Remote Management Commands ........................................................................................... 191
RIP Commands ....................................................................................................................... 193
Running Configuration Commands ......................................................................................... 195
SNMP Server Commands ....................................................................................................... 197
STP and RSTP Commands ..................................................................................................... 201
SSH Commands ...................................................................................................................... 205
Static Multicast Commands ..................................................................................................... 207
Static Route Commands ..........................................................................................................209
Subnet-based VLAN Commands ............................................................................................ 213
Syslog Commands .................................................................................................................. 215
Reference T-Z .......................................................................................................................217
TACACS+ Commands ............................................................................................................. 219
TFTP Commands .................................................................................................................... 221
Trunk Commands .................................................................................................................... 223
trTCM Commands ................................................................................................................... 227
VLAN Commands .................................................................................................................... 229
VLAN IP Commands ...............................................................................................................235
VLAN Mapping Commands ..................................................................................................... 237
VLAN Port Isolation Commands .............................................................................................. 239
VLAN Stacking Commands ..................................................................................................... 241
VLAN Trunking Commands ..................................................................................................... 245
10
Ethernet Switch CLI Reference Guide
Contents Overview
VRRP Commands ................................................................................................................... 247
Additional Commands ............................................................................................................. 251
Appendices and Index of Commands ................................................................................ 261
Ethernet Switch CLI Reference Guide
11
Contents Overview
12
Ethernet Switch CLI Reference Guide
PART I
Introduction
How to Access and Use the CLI (15)
Privilege Level and Command Mode (19)
Initial Setup (25)
13
14
CHAPTER 1
How to Access and Use the CLI
This chapter introduces the command line interface (CLI).
1.1 Accessing the CLI
Use any of the following methods to access the CLI.
1.1.1 Console Port
1 Connect your computer to the console port on the Switch using the appropriate cable.
2 Use terminal emulation software with the following settings:
Table 2 Default Settings for the Console Port
SETTING DEFAULT VALUE
Terminal Emulation VT100
Baud Rate 9600 bps
Parity None
Number of Data Bits 8
Number of Stop Bits 1
Flow Control None
3 Press [ENTER] to open the login screen.
1.1.2 Telnet
1 Connect your computer to one of the Ethernet ports.
2 Open a Telnet session to the Switch’s IP address. If this is your first login, use the default
values.
Table 3 Default Management IP Address
SETTING DEFAULT VALUE
IP Address 192.168.1.1
Subnet Mask 255.255.255.0
Make sure your computer IP address is in the same subnet, unless you are accessing the
Switch through one or more routers.
Ethernet Switch CLI Reference Guide
15
Chapter 1 How to Access and Use the CLI
1.1.3 SSH
1 Connect your computer to one of the Ethernet ports.
2 Use a SSH client program to access the Switch. If this is your first login, use the default
values in Table 3 on page 15 and Table 4 on page 16. Make sure your computer IP
address is in the same subnet, unless you are accessing the Switch through one or more
routers.
1.2 Logging in
Use the administrator username and password. If this is your first login, use the default values.
Table 4 Default User Name and Password
SETTING DEFAULT VALUE
User Name admin
Password 1234
" The Switch automatically logs you out of the management interface after five
minutes of inactivity. If this happens to you, simply log back in again.
1.3 Using Shortcuts and Getting Help
This table identifies some shortcuts in the CLI, as well as how to get help.
Table 5 CLI Shortcuts and Help
COMMAND / KEY(S) DESCRIPTION
history Displays a list of recently-used commands.
yz (up/down arrow keys) Scrolls through the list of recently-used commands. You can edit
[CTRL]+U Clears the current command.
[TAB] Auto-completes the keyword you are typing if possible. For
? Displays the keywords and/or input values that are allowed in
help Displays the (full) commands that are allowed in place of help.
any command or press [ENTER] to run it again.
example, type config, and press [TAB]. The Switch finishes the
word configure.
place of the ?.
16
Ethernet Switch CLI Reference Guide
Chapter 1 How to Access and Use the CLI
1.4 Saving Your Configuration
When you run a command, the Switch saves any changes to its run-time memory. The Switch
loses these changes if it is turned off or loses power. Use the
enable mode to save the current configuration permanently to non-volatile memory.
sysname# write memory
write memory command in
" You should save your changes after each CLI session. All unsaved
configuration changes are lost once you restart the Switch.
1.5 Logging Out
Enter logout to log out of the CLI. You have to be in user, enable, or config mode. See
Chapter 2 on page 19 for more information about modes.
Ethernet Switch CLI Reference Guide
17
Chapter 1 How to Access and Use the CLI
18
Ethernet Switch CLI Reference Guide
CHAPTER 2
Privilege Level and Command
Mode
This chapter introduces the CLI privilege levels and command modes.
• The privilege level determines whether or not a user can run a particular command.
• If a user can run a particular command, the user has to run it in the correct mode.
2.1 Privilege Levels
Every command has a privilege level (0-14). Users can run a command if the session’s
privilege level is greater than or equal to the command’s privilege level. The session’s
privilege level initially comes from the login account’s privilege level, though it is possible to
change the session’s privilege level after logging in.
2.1.1 Privilege Levels for Commands
The privilege level of each command is listed in the Reference A-G chapters on page 29.
At the time of writing, commands have a privilege level of 0, 3, 13, or 14. The following table
summarizes the types of commands at each of these privilege levels.
Table 6 Types of Commands at Different Privilege Levels
PRIVILEGE LEVEL TYPES OF COMMANDS AT THIS PRIVILEGE LEVEL
0 Display basic system information.
3 Display configuration or status.
13 Configure features except for login accounts, the authentication method
sequence and authorization settings, multiple logins, and administrator and
enable passwords.
14 Configure login accounts, the authentication method sequence and
authorization settings, multiple logins, and administrator and enable passwords.
2.1.2 Privilege Levels for Login Accounts
You can manage the privilege levels for login accounts in the following ways:
• Using commands. Login accounts can be configured by the admin account or any login
account with a privilege level of 14. See Chapter 32 on page 135.
• Using vendor-specific attributes in an external authentication server. See the User’s Guide
for more information.
Ethernet Switch CLI Reference Guide
19
Chapter 2 Privilege Level and Command Mode
The admin account has a privilege level of 14, so the administrator can run every command.
You cannot change the privilege level of the admin account.
2.1.3 Privilege Levels for Sessions
The session’s privilege level initially comes from the privilege level of the login account the
user used to log in to the Switch. After logging in, the user can use the following commands to
change the session’s privilege level.
2.1.3.1 enable Command
This command raises the session’s privilege level to 14. It also changes the session to enable
mode (if not already in enable mode). This command is available in user mode or enable
mode, and users have to know the enable password.
In the following example, the login account user0 has a privilege level of 0 but knows that the
enable password is 123456. Afterwards, the session’s privilege level is 14, instead of 0, and
the session changes to enable mode.
sysname> enable
Password: 123456
sysname#
The default enable password is 1234. Use this command to set the enable password.
password <password>
<password> consists of 1-32 alphanumeric characters. For example, the following
command sets the enable password to 123456. See Chapter 73 on page 251 for more
information about this command.
sysname(config)# password 123456
2.1.3.2 enable <0-14> Command
This command raises the session’s privilege level to the specified level. It also changes the
session to enable mode, if the specified level is 13 or 14. This command is available in user
mode or enable mode, and users have to know the password for the specified privilege level.
In the following example, the login account user0 has a privilege level of 0 but knows that the
password for privilege level 13 is pswd13. Afterwards, the session’s privilege level is 13,
instead of 0, and the session changes to enable mode.
sysname> enable 13
Password: pswd13
sysname#
20
Users cannot use this command until you create passwords for specific privilege levels. Use
the following command to create passwords for specific privilege levels.
password <password> privilege <0-14>
Ethernet Switch CLI Reference Guide
<password> consists of 1-32 alphanumeric characters. For example, the following
command sets the password for privilege level 13 to pswd13. See Chapter 73 on page 251 for
more information about this command.
sysname(config)# password pswd13 privilege 13
2.1.3.3 disable Command
This command reduces the session’s privilege level to 0. It also changes the session to user
mode. This command is available in enable mode.
2.1.3.4 show privilege command
This command displays the session’s current privilege level. This command is available in
user mode or enable mode.
sysname# show privilege
Current privilege level : 14
Chapter 2 Privilege Level and Command Mode
2.2 Command Modes
The CLI is divided into several modes. If a user has enough privilege to run a particular
command, the user has to run the command in the correct mode. The modes that are available
depend on the session’s privilege level.
2.2.1 Command Modes for Privilege Levels 0-12
If the session’s privilege level is 0-12, the user and all of the allowed commands are in user
mode. Users do not have to change modes to run any allowed commands.
2.2.2 Command Modes for Privilege Levels 13-14
If the session’s privilege level is 13-14, the allowed commands are in one of several modes.
Table 7 Command Modes for Privilege Levels 13-14 and the Types of Commands in Each One
MODE PROMPT COMMAND FUNCTIONS IN THIS MODE
enable sysname# Display current configuration, diagnostics, maintenance.
config sysname(config)# Configure features other than those below.
config-interface sysname(config-interface)# Configure ports.
config-mvr sysname(config-mvr)# Configure multicast VLAN.
config-routedomain
config-dvmrp sysname(config-dvmrp)# Configure Distance Vector Multicast Routing Protocol
config-igmp sysname(config-igmp)# Configure Internet Group Management Protocol (IGMP).
config-ospf sysname(config-ospf)# Configure Open Shortest Path First (OSPF) protocol.
sysname(config-if)# Enable and enter configuration mode for an IP routing
domain.
(DVRMP).
Ethernet Switch CLI Reference Guide
21
Chapter 2 Privilege Level and Command Mode
Table 7 Command Modes for Privilege Levels 13-14 and the Types of Commands in Each One
MODE PROMPT COMMAND FUNCTIONS IN THIS MODE
config-rip sysname(config-rip)# Configure Routing Information Protocol (RIP).
config-vrrp sysname(config-vrrp)# Configure Virtual Router Redundancy Protocol (VRRP).
Each command is usually in one and only one mode. If a user wants to run a particular
command, the user has to change to the appropriate mode. The command modes are organized
like a tree, and users start in enable mode. The following table explains how to change from
one mode to another.
Table 8 Changing Between Command Modes for Privilege Levels 13-14
MODE ENTER MODE LEAVE MODE
enable -- --
config configure exit
config-interface interface port-channel <port-list> exit
config-mvr mvr <1-4094> exit
config-vlan vlan <1-4094> exit
config-route-domain interface route domain <ip-address>/<mask-bits> exit
config-dvmrp router dvmrp exit
config-igmp router igmp exit
config-ospf router ospf <router-id> exit
config-rip router rip exit
config-vrrp router vrrp network <ip-address>/<mask-bits>
vr-id <1~7> uplink-gateway <ip-address>
exit
2.3 Listing Available Commands
Use the help command to view the executable commands on the Switch. You must have the
highest privilege level in order to view all the commands. Follow these steps to create a list of
supported commands:
1 Log into the CLI. This takes you to the enable mode.
22
Ethernet Switch CLI Reference Guide
Chapter 2 Privilege Level and Command Mode
2 Type help and press [ENTER]. A list comes up which shows all the commands
available in enable mode. The example shown next has been edited for brevity’s sake.
sysname# help
Commands available:
help
logout
exit
history
enable <0-14>
enable <cr>
.
.
traceroute <ip|host-name> [vlan <vlan-id>][..]
traceroute help
ssh <1|2> <[user@]dest-ip> <cr>
ssh <1|2> <[user@]dest-ip> [command </>]
sysname#
3 Copy and paste the results into a text editor of your choice. This creates a list of all the
executable commands in the user and enable modes.
4 Type configure and press [ENTER]. This takes you to the config mode.
5 Type help and press [ENTER]. A list is displayed which shows all the commands
available in config mode and all the sub-commands. The sub-commands are preceded by
the command necessary to enter that sub-command mode. For example, the command
name <name-str> as shown next, is preceded by the command used to enter the
config-vlan sub-mode:
vlan <1-4094>.
sysname# help
.
.
no arp inspection log-buffer logs
no arp inspection filter-aging-time
no arp inspection <cr>
vlan <1-4094>
vlan <1-4094> name <name-str>
vlan <1-4094> normal <port-list>
vlan <1-4094> fixed <port-list>
6 Copy and paste the results into a text editor of your choice. This creates a list of all the
executable commands in config and the other submodes, for example, the config-vlan
mode.
Ethernet Switch CLI Reference Guide
23
Chapter 2 Privilege Level and Command Mode
24
Ethernet Switch CLI Reference Guide
CHAPTER 3
Initial Setup
This chapter identifies tasks you might want to do when you first configure the Switch.
3.1 Changing the Administrator Password
" It is recommended you change the default administrator password.
Use this command to change the administrator password.
admin-password <pw-string> <Confirm-string>
where <pw-string> may be 1-32 alphanumeric characters long.
sysname# configure
sysname(config)# admin-password t1g2y7i9 t1g2y7i9
3.2 Changing the Enable Password
" It is recommended you change the default enable password.
Use this command to change the enable password.
password <password>
where <password> may be 1-32 alphanumeric characters long.
sysname# configure
sysname(config)# password k8s8s3dl0
Ethernet Switch CLI Reference Guide
25
Chapter 3 Initial Setup
3.3 Prohibiting Concurrent Logins
By default, multiple CLI sessions are allowed via the console port or Telnet. See the User’s
Guide for the maximum number of concurrent sessions for your Switch. Use this command to
prohibit concurrent logins.
no multi-login
Console port has higher priority than Telnet. See Chapter 41 on page 157 for more multi-
login
commands.
sysname# configure
sysname(config)# no multi-login
3.4 Changing the Management IP Address
The Switch has a different IP address in each VLAN. By default, the Switch has VLAN 1 with
IP address 192.168.1.1 and subnet mask 255.255.255.0. Use this command in config-vlan
mode to change the management IP address in a specific VLAN.
ip address <ip> <mask>
This example shows you how to change the management IP address in VLAN 1 to 172.16.0.1
with subnet mask 255.255.255.0.
sysname# configure
sysname(config)# vlan 1
sysname(config-vlan)# ip address 172.16.0.1 255.255.255.0
" Afterwards, you have to use the new IP address to access the Switch.
3.5 Changing the Out-of-band Management IP Address
If your Switch has a MGMT port (also referred to as the out-of-band management port), then
the Switch can also be managed via this interface. By default, the MGMT port IP address is
192.168.0.1 and the subnet mask is 255.255.255.0. Use this command in config mode to
change the out-of-band management IP address.
ip address <ip> <mask>
This example shows you how to change the out-of-band management IP address to 10.10.10.1
with subnet mask 255.255.255.0 and the default gateway 10.10.10.254
26
sysname# configure
sysname(config)# ip address 10.10.10.1 255.255.255.0
sysname(config)# ip address default-gateway 10.10.10.254
Ethernet Switch CLI Reference Guide
3.6 Looking at Basic System Information
Use this command to look at general system information about the Switch.
show system-information
This is illustrated in the following example.
sysname# show system-information
System Name : sysname
System Contact :
System Location :
Ethernet Address : 00:13:49:ae:fb:7a
ZyNOS F/W Version : V3.80(AII.0)b0 | 04/18/2007
RomRasSize : 1746416
System up Time : 280:32:52 (605186d ticks)
Bootbase Version : V1.00 | 05/17/2006
ZyNOS CODE : RAS Apr 18 2007 19:59:49
Product Model : ES-2024PWR
Chapter 3 Initial Setup
See Chapter 73 on page 251 for more information about these attributes.
3.7 Looking at the Operating Configuration
Use this command to look at the current operating configuration.
show running-config
This is illustrated in the following example.
sysname# show running-config
Building configuration...
Current configuration:
vlan 1
name 1
normal ""
fixed 1-9
forbidden ""
untagged 1-9
ip address default-management 172.16.37.206 255.255.255.0
ip address default-gateway 172.16.37.254
exit
Ethernet Switch CLI Reference Guide
27
Chapter 3 Initial Setup
28
Ethernet Switch CLI Reference Guide
PART II
Reference A-G
AAA Commands (31)
ARP Commands (33)
ARP Inspection Commands (35)
Bandwidth Commands (41)
Broadcast Storm Commands (45)
Classifier Commands (59)
Cluster Commands (63)
Date and Time Commands (67)
DHCP Commands (71)
DHCP Snooping & DHCP VLAN Commands (75)
DiffServ Commands (79)
DVMRP Commands (81)
Ethernet OAM Commands (83)
GARP Commands (89)
GVRP Commands (91)
29
30
Loading...