Brocade, the B-wing symbol, BigIron, DCX, Fabric OS, FastIron, IronPoint, IronShield, IronView, IronWare, JetCore, NetIron,
SecureIron, ServerIron, StorageX, and TurboIron are registered trademarks, and DCFM, Extraordinary Networks, and SAN Health
are trademarks of Brocade Communications Systems, Inc., in the United States and/or in other countries. All other brands,
products, or service names are or may be trademarks or service marks of, and are used to identify, products or services of their
respective owners.
Notice: This document is for informational purposes only and does not set forth any warranty, expressed or implied, concerning
any equipment, equipment feature, or service offered or to be offered by Brocade. Brocade reserves the right to make changes to
this document at any time, without notice, and assumes no responsibility for its use. This informational document describes
features that may not be currently available. Contact a Brocade sales office for information on feature and product availability.
Export of technical data contained in this document may require an export license from the United States government.
The authors and Brocade Communications Systems, Inc. shall have no liability or responsibility to any person or entity with
respect to any loss, cost, liability, or damages arising from the information contained in this book or the computer programs that
accompany it.
The product described by this document may contain “open source” software covered by the GNU General Public License or other
open source license agreements. To find out which open source software is included in Brocade products, view the licensing
terms applicable to the open source software, and obtain a copy of the programming source code, please visit
http://www.brocade.com/support/oscd.
Brocade Communications Systems, Incorporated
Corporate and Latin American Headquarters
Brocade Communications Systems, Inc.
130 Holger Way
San Jose, CA 95134
Tel: 1-408-333-8000
Fax: 1-408-333-8101
E-mail: info@brocade.com
European Headquarters
Brocade Communications Switzerland Sàrl
Centre Swissair
Tour B - 4ème étage
29, Route de l'Aéroport
Case Postale 105
CH-1215 Genève 15
Switzerland
Tel: +41 22 799 5640
Fax: +41 22 799 5641
E-mail: emea-info@brocade.com
Asia-Pacific Headquarters
Brocade Communications Systems China HK, Ltd.
No. 1 Guanghua Road
Chao Yang District
Units 2718 and 2818
Beijing 100020, China
Tel: +8610 6588 8888
Fax: +8610 6588 9999
E-mail: china-info@brocade.com
Asia-Pacific Headquarters
Brocade Communications Systems Co., Ltd. (Shenzhen WFOE)
Citic Plaza
No. 233 Tian He Road North
Unit 1308 – 13th Floor
Guangzhou, China
Tel: +8620 3891 2000
Fax: +8620 3891 2111
E-mail: china-info@brocade.com
This document is organized to help you find the information that you want as quickly and easily as
possible.
The document contains the following components:
• Chapter 1, “CLI Basics” describes how to access the switch and the CEE CLI command modes.
• Chapter 2, “CEE Commands” describes thecommands to manage the configuration files and
includes other file management commands.
Supported hardware and software
This document includes updated information specific to Fabric OS 7.0.0. The following hardware
platforms are supported in this release of the CEE Administrator’s Guide:
• Brocade 8000
The following blades are supported by this release of the CEE Administrator’s Guide:
• Brocade FCOE10-24 blade
Within this manual, any appearance of the term “Brocade FCoE hardware” is referring to:
Although many different software and hardware configurations are tested and supported by
Brocade Communications Systems, Inc. for Fabric OS 7.0.0, documenting all possible
configurations and scenarios is beyond the scope of this document.
To obtain information about an OS version other than Fabric OS v7.0.0, refer to the documentation
specific to that OS version.
What’s new in this document
This document has been updated for for Fabric OS v7.0.0.
This document has been updated with corrections and updates for defects discovered since the
release of the previous version.
For further information about new features and documentation updates for this release, refer to
the release notes.
Document conventions
This section describes text formatting conventions and important notice formats used in this
document.
Text formatting
The narrative-text formatting conventions that are used are as follows:
bold textIdentifies command names
Identifies the names of user-manipulated GUI elements
Identifies keywords and operands
Identifies text to enter at the GUI or CLI
italic textProvides emphasis
Identifies variables
Identifies paths and Internet addresses
Identifies document titles
code textIdentifies CLI output
Identifies command syntax examples
For readability, command names in the narrative portions of this guide are presented in mixed
lettercase: for example, switchShow. In actual examples, command lettercase is all lowercase.
xiiConverged Enhanced Ethernet Command Reference
53-1002164-01
.Command syntax conventions
NOTE
ATTENTION
CAUTION
DANGER
Command syntax in this manual follows these conventions:
TABLE 1Command syntax conventions
ConventionDescription
[ ]Default responses to system prompts appear in square brackets.
{x | y | z} A choice of required keywords appears in braces separated by vertical
bars. You must select one.
screen fontExamples of information displayed on the screen.
<>Nonprinting characters, for example passwords, appear in angle
brackets
[ ]Keywords or arguments that appear within square brackets are
optional.
bold face font Commands and keywords.
italicVariables for which you supply values.
Notes, cautions, and warnings
The following notices and statements are used in this manual. They are listed below in order of
increasing severity of potential hazards.
A note provides a tip, guidance, or advice, emphasizes important information, or provides a
reference to related information.
An Attention statement indicates potential damage to hardware or data.
A Caution statement alerts you to situations that can be potentially hazardous to you or cause
damage to hardware, firmware, software, or data.
A Danger statement indicates conditions or situations that can be potentially lethal or extremely
hazardous to you. Safety labels are also attached directly to products to warn of these conditions
or situations.
Key terms
For definitions specific to Brocade and Fibre Channel, see the technical glossaries on Brocade
Connect. See “Brocade resources” on page xiv for instructions on accessing Brocade Connect.
This document may contain references to the trademarks of the following corporations. These
trademarks are the properties of their respective companies and corporations.
These references are made for informational purposes only.
CorporationReferenced Trademarks and Products
Microsoft CorporationWindows, Windows NT, Internet Explorer
Oracle CorporationOracle, Java
Netscape Communications CorporationNetscape
Red Hat, Inc.Red Hat, Red Hat Network, Maximum RPM, Linux Undercover
Additional information
This section lists additional Brocade and industry-specific documentation that you might find
helpful.
Brocade resources
To get up-to-the-minute information, go to http://my.brocade.com and register at no cost for a user
ID and password.
White papers, online demonstrations, and data sheets are available through the Brocade website
at:
For additional Brocade documentation, visit the Brocade website:
http://www.brocade.com
Release notes are available on the MyBrocade website and are also bundled with the Fabric OS
firmware.
Other industry resources
For additional resource information, visit the Technical Committee T11 website. This website
provides interface standards for high-performance and mass storage applications for Fibre
Channel, storage management, and other applications:
http://www.t11.org
For information about the Fibre Channel industry, visit the Fibre Channel Industry Association
website:
http://www.fibrechannel.org
xivConverged Enhanced Ethernet Command Reference
53-1002164-01
Getting technical help
Contact your switch support supplier for hardware, firmware, and software support, including
product repairs and part ordering. To expedite your call, have the following information available:
1. General Information
• Switch model
• Switch operating system version
• Error numbers and messages received
• supportSave command output
• Detailed description of the problem, including the switch or fabric behavior immediately
following the problem, and specific questions
• Description of any troubleshooting steps already performed and the results
• Serial console and Telnet session logs
• syslog message logs
2. Switch Serial Number
The switch serial number and corresponding bar code are provided on the serial number label,
as illustrated below:
*FT00X0054E9*
FT00X0054E9
The serial number label is located as follows:
• Brocade 8000 —On the switch ID pull-out tab located inside the chassis on the port side
on the left.
3. World Wide Name (WWN)
Use the licenseIdShow command to display the WWN of the chassis.
If you cannot use the licenseIdShow command because the switch is inoperable, you can get
the WWN from the same place as the serial number, except for the Brocade DCX. For the
Brocade DCX, access the numbers on the WWN cards by removing the Brocade logo plate at
the top of the nonport side of the chassis.
Document feedback
Quality is our first concern at Brocade and we have made every effort to ensure the accuracy and
completeness of this document. However, if you find an error or an omission, or you think that a
topic needs further development, we want to hear from you. Forward your feedback to:
documentation@brocade.com
Provide the title and version number of the document and as much detail as possible about your
comment, including the topic heading and page number and your suggestions for improvement.
The Brocade FCoE hardware runs traditional Fabric OS software and can be managed using the
same tools traditionally used for SAN management. Using the Fabris OS command line interface
(CLI), administrators have access to all commands and utilities common to other Brocade switches.
In addition, Fabris OS software on the Brocade 8000 enables Brocade Web Tools to support the
following features for configuring and managing a Converged Ethernet Network:
• CEE interface display and configuration
• FCoE trunk display and configuration
• CEE configuration including link aggregation control protocol (LACP), Virtual LANs (VLANs),
Quality of Service (QoS), and Link Layer Discovery Protocol (LLDP)/Data Center Bridging
eXchange (DCBX) protocol
• FCoE login groups
1
CEE command line interface
The Brocade CEE CLI is designed to support the management of CEE and Layer 2 Ethernet
switching functionality. The CEE CLI uses an industry-standard hierarchical shell familiar to
Ethernet/IP networking administrators.
All conventional port-related Fabric OS CLI commands are only applicable to Fibre Channel. These
commands have no knowledge of the Ethernet ports. The CEE features and CEE ports can only be
configured through the CEE CLI interface, which is accessed by entering the cmsh command from
the Fabric OS shell.
The system starts up with the default Fabric OS configuration and the CEE startup configuration.
After logging in, you are in the Fabric OS shell. For information on accessing the CEE commands
from the Fabric OS shell, see “Accessing the CEE CLI from the Fabric OS shell” on page 3.
Some Fabric OS commands are available in the CEE shell. Enter the Fabris OS ? command at the
CEE CLI privileged EXEC mode command prompt to view the available Fabric OS commands. The
traditional Fabric OS command help found in the Fabric OS shell is not available through the CEE
shell.
The CEE configuration is not affected by the configUpload and configDownload commands entered
in the Fabric OS shell.
Saving your configuration changes
Any configuration changes made to the switch are written into the running-config file. This is a
dynamic file that is lost when the switch reboots. During the boot sequence, the switch resets all
configuration settings to the values in the startup-config file.
To make your changes permanent, you must use either the write memory command or the copy
command to commit the running-config file to the startup--config file.
Saving configuration changes with the copy command
Perform this task from privileged EXEC mode.
Enter the copy command to save the running-config file to the startup-config file.
switch#copy running-config startup-config
Saving configuration changes with the write memory command
Perform this task from privileged EXEC mode.
Enter the write memory command to save the running-config file to the startup-config file.
switch# write memory
Overwrite the startup config file (y/n): y
Building configuration...
CEE CLI RBAC permissions
Role-Based Action Control (RBAC) defines the capabilities that a user account has based on the
role the account has been assigned. Table 2 displays the permissions matrix for CEE. Permissions
are specifically defined as follows:
• OM—When you enter the cmsh command, you are put directly into privileged EXEC mode.
• O—When you enter the cmsh command, you are limited to EXEC mode.
O = observe, OM = observe and modify, N = access not allowed
Accessing the CEE CLI through the console or Telnet
The procedure to access the CEE CLI is the same through either the console interface or through a
Telnet session; both access methods bring you to the login prompt.
2Converged Enhanced Ethernet Command Reference
53-1002164-01
CEE command line interface
NOTE
NOTE
Protocol configurationInterface configuration
Port-channel
10-Gigabit Ethernet
VLAN
CEE CLI features
CEE map
ACLs
Console and VTY (line)
configuration
Console
Virtual terminal
Global configuration
EXEC
Privileged EXEC
LLDP
Spanning-tree
1
While this example uses the admin role to log in to the switch, any role listed in the “CEE CLI RBAC
From the global configuration mode,
specify a protocol by entering one of
the following commands:
• protocol lldp
• protocol spanning-tree mstp
• protocol spanning-tree rstp
• protocol spanning-tree stp
Display running system information
and set terminal line parameters.
Display and change system
parameters. Note that this is the
administrative mode and also
includes EXEC mode commands.
Configure features that affect the
entire switch.
Access and configure individual
interfaces.
Access and configure protocols.
4Converged Enhanced Ethernet Command Reference
53-1002164-01
NOTE
TABLE 3CEE CLI command modes (Continued)
CEE command line interface
1
Command
mode
Feature
configuration
Console and
VTY (line)
configuration
PromptHow to access the command modeDescription
CEE map:
switch(config-ceemap)#
Standard ACL:
switch(conf-macl-std)#
Extended ACL:
switch(conf-macl-ext)#
switch(config-line)#From the global configuration mode,
From the global configuration mode,
specify a CEE feature by entering
one of the following commands:
• cee-map
• mac access-list
configure a terminal connected
through the console port by entering
the line console command.
Configure a terminal connected
through a Telnet session by entering
the line vty command.
Access and configure CEE features.
Identify traffic based on the MAC
addresses, such as VLAN IDs and
different encapsulations.
Standard Access Control Lists filter
the traffic on a source address and
block traffic close to a destination.
Extended Access Control Lists block
traffic based on any given packet
attribute.
Configure a terminal connected
through the console port or a
terminal connected through a Telnet
session.
After you apply the access list to an
interface, a Virtual Teletype (VTY), or
through a command using the
access list keyword, it becomes
effective.
Pressing Ctrl+Z or entering the end command in any mode returns you to privileged EXEC mode.
Entering exit in any mode returns you to the previous mode.
CEE CLI keyboard shortcuts
Tab le 4 lists CEE CLI keyboard shortcuts.
TABLE 4CEE CLI keyboard shortcuts
KeystrokeDescription
Ctrl+B or the left arrow keyMoves the cursor back one character.
Ctrl+F or the right arrow keyMoves the cursor forward one character.
Ctrl+AMoves the cursor to the beginning of the command line.
Ctrl+EMoves the cursor to the end of the command line.
Esc BMoves the cursor back one word.
Esc FMoves the cursor forward one word.
Ctrl+ZReturns to privileged EXEC mode.
Ctrl+P or the up arrow keyDisplays commands in the history buffer with the most recent command
displayed first.
Ctrl+N or the down arrow keyDisplays commands in the history buffer with the most recent command
In EXEC and privileged EXEC modes, use the show history command to list the commands most recently entered. The switch retains the history of the last 1000 commands entered.
Using the do command as a shortcut
You can use the do command to save time when you are working in any configuration mode and
you want to run a command in EXEC or privileged EXEC mode.
For example, if you are configuring an LLDP and you want to execute a privileged EXEC mode
command, such as the dir command, you would first have to exit the LLDP configuration mode.
However, by using the do command with the dir command, you can ignore the need to change
configuration modes, as shown in the following example.
switch(conf-lldp)#do dir
Contents of flash://
-rw-r----- 1276 Wed Feb 4 07:08:49 2009 startup_rmon_config
-rw-r----- 1276 Wed Feb 4 07:10:30 2009 rmon_config
-rw-r----- 1276 Wed Feb 4 07:12:33 2009 rmon_configuration
-rw-r----- 1276 Wed Feb 4 10:48:59 2009 starup-config
Displaying CEE CLI commands and command syntax
Enter a question mark (?) in any command mode to display the list of commands available in that
mode.
switch>?
Exec commands:
enable Turn on privileged mode command
exit End current mode and down to previous mode
help Description of the interactive help system
logout Exit from the EXEC
quit Exit current mode and down to previous mode
show Show running system information
terminal Set terminal line parameters
To display a list of commands that start with the same characters, type the characters followed by
the question mark (?).
switch>e?
enable Turn on privileged mode command
exit End current mode and down to previous mode
To display the keywords and arguments associated with a command, enter the keyword followed by
the question mark (?).
switch#terminal ?
length Set number of lines on a screen
no Negate a command or set its defaults
If the question mark (?) is typed within an incomplete keyword, and the keyword is the only keyword
starting with those characters, the CLI displays help for that keyword only.
switch#show d?
dot1x IEEE 802.1X Port-Based Access Control
<cr>
6Converged Enhanced Ethernet Command Reference
53-1002164-01
CEE command line interface
1
If the question mark (?) is typed within an incomplete keyword but the keyword matches several
keywords, the CLI displays help for all the matching keywords.
switch#show i?
interface Interface status and configuration
ip Internet Protocol (IP)
The CEE CLI accepts abbreviations for commands. The following example is the abbreviation for the
show qos interface all command.
switch#sh q i a
If the switch does not recognize a command after Enter is pressed, an error message displays.
switch#hookup
^
% Invalid input detected at '^' marker.
If an incomplete command is entered, an error message displays.
switch#show
% Incomplete command.
CEE CLI command completion
To automatically complete the spelling of commands or keywords, begin typing the command or
keyword and then press Tab. For example, at the CLI command prompt, type te and press Tab:
switch#te
The CLI displays:
switch#terminal
If there is more than one command or keyword associated with the characters typed, the CEE CLI
displays all choices. For example, at the CLI command prompt, type show l and press Tab:
switch#show l
The CLI displays:
switch#show l
lacp line lldp
CEE CLI command output modifiers
You can filter the output of the CEE CLI show commands using the output modifiers described in
Tab le 5.
TABLE 5CEE CLI command output modifiers
Output modifierDescription
append Appends the output to a file.
redirectRedirects the command output to the specified file.
includeDisplays the command output that includes the specified expression.
excludeDisplays the command output that excludes the specified expression.
appendAppends the command output to the specified file.
beginDisplays the command output that begins with the specified expression.
lastDisplays only the last few lines of the command output.
teeRedirects the command output to the specified file. Note that this modifier also
displays the command output.
FLASHRedirects the output to flash memory.
8Converged Enhanced Ethernet Command Reference
53-1002164-01
Chapter
CEE Commands
advertise dcbx-fcoe-app-tlv
Advertises application Type, Length, Values (TLVs) to ensure interoperability of traffic over the Data
Center Bridging eXchange protocol (DCBX), which runs over LLDP to negotiate an FCoE application
TLV.
Synopsisadvertise dcbx-fcoe-app-tlv
no advertise dcbx-fcoe-app-tlv
OperandsNone
DefaultsAdvertise is enabled.
Command
Modes
DescriptionUse this command to advertise application TLVs to ensure interoperability of traffic over DCBX
Protocol LLDP configuration mode
packets. Converged Enhanced Ethernet (CEE) parameters related to FCoE must be negotiated
before FCoE traffic can begin on a CEE link. An FCoE application TLV is exchanged over LLDP, which
negotiates information such as FCoE priority, and Priority Flow Control (PFC) pause. Use the no
advertise dcbx-fcoe-app-tlv command to return to the default setting.
2
Usage
Guidelines
ExamplesNone
See Alsoadvertise dot1-tlv, advertise dot3-tlv, advertise optional-tlv
Advertises to any attached device the FCoE status of the logical link.
Synopsisadvertise dcbx-fcoe-logical-link-tlv
no advertise dcbx-fcoe-logical-link-tlv
OperandsNone
DefaultsAdvertise is enabled.
Command
Modes
DescriptionUse this command to advertise to any attached device the FCoE status of the logical link. Use the
Usage
Guidelines
ExamplesNone
See Alsoadvertise dcbx-fcoe-app-tlv, advertise dcbx-iscsi-app-tlv
Protocol LLDP configuration mode
no advertise dcbx-fcoe-logical-link-tlv command to return to the default setting.
There are no usage guidelines for this command.
10Converged Enhanced Ethernet Command Reference
53-1002164-01
advertise dcbx-iscsi-app-tlv
Advertises application Type, Length, Values (TLVs) to ensure interoperability of traffic over the Data
Center Bridging eXchange protocol (DCBX), which runs over LLDP to negotiate an iSCSI application
TLV.
Synopsisadvertise dcbx-iscsi-app-tlv
no advertise dcbx-iscsi-app-tlv
OperandsNone
DefaultsAdvertise is enabled.
advertise dcbx-iscsi-app-tlv
2
Command
Modes
DescriptionUse this command to advertise application TLVs to ensure interoperability of traffic over DCBX
Usage
Guidelines
ExamplesNone
See Alsoadvertise dcbx-fcoe-app-tlv
Protocol LLDP configuration mode
packets. Converged Enhanced Ethernet (CEE) parameters related to iSCSI must be negotiated
before iSCSI traffic can begin on a CEE link. An iSCSI application TLV is exchanged over LLDP, which
negotiates information such as iSCSI priority, and Priority Flow Control (PFC) pause. Use the no
advertise dcbx-iscsi-app-tlv command to return to the default setting.