ZyXEL Communications XS3800-28 Cli Reference Manual page 4

Warnings and Notes
These are how warnings and notes are shown in this CLI Reference Guide.
Warnings tell you about things that could harm you or your device. See
your User's Guide for product specific warnings.
Note: 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 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
courier new font
• Required input values are in angle brackets <>; for example,
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.
• In some commands you specify slots or interfaces by the Access ID <aid>, use "?" to show which
types of interfaces you can specify. For example, you might be able to use: slot-<slot> |
<ge|msc>-<slot>-<port> | <ge|msc>-<slot>-<port>&&-<port>.
• Use "msc-<slot>-<port>" for an uplink slot on the management switch card.
• Use "ge-<slot>-<port>" for a Gigabit Ethernet port or switch settings on a PON interface.
• Use "pon-<slot>-<port>" to configure PON interface settings.
• A "slot" is a chassis slot.
• The "port" is 1-N where N is the number of ports on the card.
• Use && to specify a range of ports.
• 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.
Document Conventions
Document Conventions
.
Ethernet Switch CLI Reference Guide
4
means that you must
ping < >
ip