McDATA OPENconnectors Command Line Interace User Manual

McDATA OPENconnectors

Command Line Interface

USER MANUAL

P/N 620-000134-500

REV B

McDATA Corporation

380 Interlocken Crescent Broomfield, CO 80021-3464

Corporate Headquarters: 800.545.5773

Web: www.mcdata.com

Sales E-mail: [e-mail]

Record of Revisions and Updates

Revision Date Description

620-000134-000 11/2001 Initial release of Manual

620-000134-100 05/2002 Updates for E/OS 2.0

620-000134-200 08/2002 Updates for E/OS 3.0

620-000134-300 09/2002 Updates for E/OS 4.0

620-000134-400 10/2002 Updates for E/OS 4.1

620-000134-500 10/2002 Updates for E/OS 4.1 CD-ROM final

Copyright © 2002 McDATA Corporation. All rights reserved.

Printed October 2002

Sixth Edition

No part of this publication may be reproduced or distributed in any form or
by any means, or stored in a database or retrieval system, without the prior
written consent of McDATA Corporation.

The information contained in this document is subject to change without
notice. McDATA Corporation assumes no responsibility for any errors that
may appear.

All computer software programs, including but not limited to microcode,
described in this document are furnished under a license, and may be used or
copied only in accordance with the terms of such license.
McDATA either owns or has the right to license the computer software
programs described in this document.
McDATA Corporation retains all rights, title and interest in the computer
software programs.

McDATA Corporation makes no warranties, expressed or implied, by
operation of law or otherwise, relating to this document, the products or the
computer software programs described herein. McDATA CORPORATION
DISCLAIMS ALL IMPLIED WARRANTIES OF MERCHANTIBILITY AND
FITNESS FOR A PARTICULAR PURPOSE. In no event shall McDATA
Corporation be liable for (a) incidental, indirect, special, or consequential
damages or (b) any damages whatsoever resulting from the loss of use, data
or profits, arising out of this document, even if advised of the possibility of
such damages.

ii

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

Contents

Preface ............................................................................................................................ix

Chapter 1 Introduction

Command Line Interface Overview...............................................1-2

Entering Command Line Interface Commands ...........................1-3

Documentation Conventions...................................................1-3

Navigation Conventions...........................................................1-3

Command Tree...........................................................................1-5

Navigation of the CLI Command Tree ...................................1-8

Parameters ................................................................................1-10

Output .......................................................................................1-10

Logging In and Logging Out ........................................................1-11

User Access Rights ..................................................................1-11

login ...........................................................................................1-11

logout.........................................................................................1-12

Using the commaDelim Command..............................................1-13

commaDelim ............................................................................1-13

Handling Command Line Interface Errors.................................1-14

Using the Command Line Interface Help ...................................1-15

Commenting Scripts.......................................................................1-16

ED-5000 Director.............................................................................1-17

Telnet Session...................................................................................1-18

Ethernet Connection Loss.......................................................1-18

P/N 620-000134-500 McDATA OPENconnectors Command Line Interface USER MANUAL

iii

Contents

Chapter 2 CLI Commands

Command Overview........................................................................2-2

config..................................................................................................2-2

config.features.enterpriseFabMode........................................2-3

config.features.ficonms.............................................................2-3

config.features.installKey.........................................................2-4

config.features.OpenSysMS.....................................................2-4

config.features.show .................................................................2-5

config.ip.ethernet.......................................................................2-6

config.ip.show............................................................................2-6

config.port.blocked ...................................................................2-7

config.port.extDist.....................................................................2-8

config.port.fan............................................................................2-9

config.port.name......................................................................2-10

config.port.speed.....................................................................2-11

config.port.type........................................................................2-12

config.port.show......................................................................2-13

config.security.fabricBinding.................................................2-14

config.security.portBinding ...................................................2-20

config.security.switchBinding ...............................................2-23

config.security.userRights......................................................2-26

config.snmp.addCommunity.................................................2-29

config.snmp.authTraps...........................................................2-30

config.snmp.deleteCommunity.............................................2-30

config.snmp.show ...................................................................2-31

config.switch ............................................................................2-32

config.switch.bbCredit............................................................2-32

config.switch.domainRSCN...................................................2-32

config.switch.insistDomainId................................................2-33

config.switch.edTOV ..............................................................2-33

config.switch.interopMode....................................................2-34

config.switch.prefDomainId..................................................2-34

config.switch.priority..............................................................2-35

config.switch.raTOV ...............................................................2-36

config.switch.rerouteDelay....................................................2-37

config.switch.speed.................................................................2-38

config.switch.show..................................................................2-39

config.system.contact..............................................................2-40

config.system.date...................................................................2-41

config.system.description.......................................................2-41

config.system.location ............................................................2-42

config.system.name.................................................................2-42

config.system.show.................................................................2-43

iv

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

Contents

config.zoning ........................................................................... 2-44

config.zoning.setDefZoneState ............................................. 2-44

config.zoning.activateZoneSet..............................................2-45

config.zoning.deactivateZoneSet.......................................... 2-45

config.zoning.replaceZoneSet...............................................2-46

config.zoning.clearZoneSet ................................................... 2-46

config.zoning.addZone ..........................................................2-47

config.zoning.deleteZone ...................................................... 2-47

config.zoning.renameZoneSet...............................................2-48

config.zoning.addWwnMem ................................................ 2-48

config.zoning.addPortMem................................................... 2-49

config.zoning.clearZone......................................................... 2-50

config.zoning.deleteWwnMem............................................. 2-50

config.zoning.deletePortMem............................................... 2-51

config.zoning.renameZone....................................................2-52

config.zoning.showPending.................................................. 2-53

config.zoning.showActive.....................................................2-54

maint ................................................................................................ 2-55

maint.port.beacon ...................................................................2-55

maint.port.reset .......................................................................2-56

maint.system.beacon ..............................................................2-56

maint.system.clearSysError................................................... 2-57

maint.system.ipl...................................................................... 2-57

maint.system.resetConfig ...................................................... 2-58

maint.system.setOnlineState................................................. 2-58

perf ................................................................................................... 2-59

perf.class2................................................................................. 2-59

perf.class3................................................................................. 2-60

perf.clearStats ..........................................................................2-62

perf.errors.................................................................................2-62

perf.link .................................................................................... 2-64

perf.traffic.................................................................................2-65

show.................................................................................................2-67

show.eventLog ........................................................................ 2-67

show.features........................................................................... 2-68

show.frus.................................................................................. 2-69

show.ip.ethernet ......................................................................2-70

show.loginServer .................................................................... 2-71

show.nameServer ....................................................................2-72

show.nameServerExt .............................................................. 2-73

show.port.config...................................................................... 2-75

show.port.info .........................................................................2-76

show.port.nodes...................................................................... 2-77

P/N 620-000134-500 McDATA OPENconnectors Command Line Interface USER MANUAL

v

Contents

show.port.status.......................................................................2-79

show.port.technology .............................................................2-82

show.security.fabricBinding..................................................2-83

show.security.portBinding.....................................................2-84

show.security.switchBinding.................................................2-85

show.switch ..............................................................................2-86

show.system .............................................................................2-88

show.zoning.............................................................................2-89

Appendix A Error Messages

Glossary

........................................................................................................................g-1

Index ...............................................................................................................................i-1

vi

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

Tables

1-1 CLI Command Tree Navigation Conventions .......................................... 1-3

1-2 CLI Command Tree ...................................................................................... 1-5

1-3 CLI Command Tree for the ED-5000 Director ........................................ 1-17

P/N 620-000134-500 McDATA OPENconnectors Command Line Interface USER MANUAL

vii

Tables

viii

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

3UHIDFH

This publication is part of the documentation suite that supports the
McDATA® Sphereon™ 3016 Fabric Switch, Sphereon 3032 Fabric
Switch, Sphereon 3216 Fabric Switch, Sphereon 3232 Fabric Switch,
Sphereon 4500 Fabric Switch, Intrepid™ 6064 Director, and Intrepid
6140 Director.

Who Should Use This

Manual

P/N 620-000134-500 McDATA OPENconnectors Command Line Interface USER MANUAL

This publication describes the commands that can be entered through
the Command Line Interface for the Intrepid 6064 Director, Intrepid
6140 Director, Sphereon 4500 Switch, Sphereon 3016 Switch,
Sphereon 3032 Switch, Sphereon 3216 Switch, and the Sphereon 3232
Switch. (A limited number of these commands are available on the
ED-5000 Director.) Access through a Telnet client is presumed.

This publication is intended for data center administrators and
customer support personnel, who can either enter the commands
manually or write a script containing them. However, the primary
purpose of the Command Line Interface is for scripts written by these
administrators and personnel for use in a host-based scripting
environment. Therefore, this publication presumes that the user is
familiar with:

• Establishing and using a Telnet session

• Using the command line of a terminal

• Writing scripts

• Networking, SAN, and zoning concepts

ix

Preface

• McDATA products in the user’s network
The publications listed in Related Publications provide considerable

information about both concepts and McDATA products.

Organization of This

Manual

This publication is organized as follows:

Chapter 1, Introduction, provides an introduction and overview of

the Command Line Interface.

Chapter 2, CLI Commands, describes the Command Line Interface

commands, including their syntax, purpose, and parameters, as
well as examples of their usage and any output that they
generate.

Appendix A, lists and explains error messages that may appear

while using the Command Line Interface.
The Glossary defines terms, abbreviations, and acronyms used in

this manual.
An Index is also provided.

Manual Updates Check the McDATA web site at www.mcdata.com for possible

updates or supplements to this manual.

Related Publications Other publications that provide additional information about the

products mentioned in this manual are:

• McDATA Enterprise Fabric Connectivity Manager User Manual
(620-005001)

• McDATA Products in a SAN Environment - Planning Manual
(620-000124)

• McDATA ED-5000 Enterprise Fibre Channel Director Installation
Manual (620-005003)

• McDATA ED-5000 Enterprise Fibre Channel Director Service Manual

(620-005004)

• McDATA ED-5000 Enterprise Fibre Channel Director User Manual

(620-005002)

• McDATA Intrepid 6064 Director Installation and Service Manual

(620-000108)

• McDATA Intrepid 6140 and 6064 Director Product Manager User
Manual (620-000153)

x

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

• McDATA Intrepid 6140 Director Installation and Service Manual
(620-000157)

• McDATA OPENconnectors SNMP Support Manual (620-000131)

• McDATA SANpilot User Manual (620-000160)

• McDATA Sphereon 3016 and 3216 Fabric Switch Product Manager

User Manual (620-000151)

• McDATA Sphereon 3016 Switch Installation and Service Manual

(620-000112)

• McDATA Sphereon 3016 Switch Product Manager User Manual

(620-000121)

• McDATA Sphereon 3032 and 3232 Fabric Switch Product Manager
User Manual (620-000152)

• McDATA Sphereon 3032 Switch Installation and Service Manual

(620-000116)

• McDATA Sphereon 3032 Switch Product Manager User Manual

(620-000122)

• McDATA Sphereon 3216 Switch Installation and Service Manual

(620-000139)

Preface

• McDATA Sphereon 3216 Switch Product Manager User Manual

(620-000136)

• McDATA Sphereon 3232 Switch Installation and Service Manual

(620-000142)

• McDATA Sphereon 3232 Switch Product Manager User Manual

(620-000137)

• McDATA Sphereon 4500 Switch Installation and Service Manual

(620-000159)

• McDATA Sphereon 4500 Switch Product Manager User Manual

(620-000158)

P/N 620-000134-500 McDATA OPENconnectors Command Line Interface USER MANUAL

xi

Preface

Manual Conventions The following notational conventions are used in this document:

Convention Meaning

Bold Keyboard keys, buttons and switches on hardware products,

Italic Outside book references, names of user interface windows,

Monospaced Command syntax, examples of commands, output.

A note presents important information that is not hazard-related.

and screen prompts for the Command Line Interface.

buttons, and dialog boxes.

Where to Get Help For technical support, McDATA end-user customers should call the

phone number located on the service label attached to the front or
rear of the hardware product.

McDATA’s “Best in Class” Solution Center provides a single point of
contact for customers seeking help. The Solution Center will research,
explore, and resolve inquires or service requests regarding McDATA
products and services. The Solution Center is staffed 24 hours a day,
7 days a week, including holidays.

To expedite warranty entitlement, please have your product serial number
available.

McDATA Corporation
380 Interlocken Crescent
Broomfield, CO 80021

Phone: [phone] or [phone]
Fax: [phone]
E-mail: [e-mail]

Customers who purchased the hardware product from a company other than
McDATA should contact that company’s service representative for technical
support.

xii

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

Preface

Forwarding
Publication

Comments

We sincerely appreciate any comments about this publication. Did
you find this manual easy or difficult to use? Did it lack necessary
information? Were there any errors? Could its organization be
improved?

Please send your comments via e-mail, our home page, or FAX.
Identify the manual, and provide page numbers and specific detail.
Thank you.

❏ E-mail: [e-mail]
❏ Home Page: http://www.mcdata.com
❏ Fax: Technical Communications Manager

[phone]

Ordering Publications To order a paper copy of this manual, contact your McDATA

representative, or use the contact information listed below.

Phone: [phone] and select the option for information on
McDATA’s complete family of enterprise-to-edge SAN solutions.

Fax: [phone]

Trademarks The following terms, indicated by a registered trademark symbol (®)

or trademark symbol (™) on first use in this publication, are
trademarks of McDATA Corporation in the United States, other
countries, or both:

Registered Trademarks
McDATA
Fabricenter

®

®

Tr ad em ar ks
ED-5000 Director™
OPENconnectors™
Fibre Channel Director™
Intrepid™
SANpilot™
SANtegrity™
Sphereon™

All other trademarked terms, indicated by a registered trademark
symbol (®) or trademark symbol (™) on first use in this publication,
are trademarks of their respective owners in the United States, other
countries, or both.

P/N 620-000134-500 McDATA OPENconnectors Command Line Interface USER MANUAL

xiii

Preface

xiv

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

,QWURGXFWLRQ

This chapter introduces the Command Line Interface (CLI) and
describes the essentials for using the CLI commands.

Section Page

Command Line Interface Overview 1-2

Entering Command Line Interface Commands 1-3



Logging In and Logging Out 1-11

Using the commaDelim Command 1-13

Handling Command Line Interface Errors 1-14

Using the Command Line Interface Help 1-15

ED-5000 Director 1-17

Telnet Session 1-18

Introduction

1-1

Introduction

1

&RPPDQG/LQH,QWHUIDFH2YHUYLHZ

The Command Line Interface (CLI) is a feature that provides an
alternative to McDATA’s Enterprise Fabric Connectivity Manager
(EFCM) and SANpilot interface products for director and switch
management capabilities.

The CLI can only be used through a Telnet client session in an
out-of-band management environment, using the Ethernet port in the
director or switch. Although the primary use of the CLI is in
host-based scripting environments, the CLI commands can also be
entered directly at a command line. Any hardware platform that
supports the Telnet client software can be used.

The primary purpose of the CLI is to automate management of a
large number of switches with the use of scripts.

Because the CLI is not an interactive interface, no prompts are
displayed to guide the user through a task. If an interactive interface
is needed, the EFCM or SANpilot interface should be used instead of
the CLI.

1-2

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

(QWHULQJ&RPPDQG/LQH,QWHUIDFH&RPPDQGV

The CLI commands can be entered directly at the command line of a
terminal or coded in a script.

Note that the CLI commands are not case sensitive.

Introduction

1

'RFXPHQWDWLRQ
&RQYHQWLRQV

1DYLJDWLRQ
&RQYHQWLRQV

Table 1-1 CLI Command Tree Navigation Conventions

Throughout this publication, periods are used to separate the
components of a command name. However, the periods cannot be
included when the command is actually entered at the terminal or
coded in a script. (How to enter the commands is explained in

Navigation of the CLI Command Tree on page 1-8.)

Even though the commands cannot be entered with the periods, the
command line prompts do include the periods.

Config.Port>

Basic command line navigation conventions are supported. The
following table includes the asynchronous commands that are
recognized by the CLI.

Character Sequence Common Name Action or Description

<CR> Carriage Return Pass a completed line to the

parser.

<DEL> Delete Backspace one character

and delete the character.

<NL> New Line Pass a completed line to the

parser.

<SP> Space Used to separate keywords.

# Pound Sign Used to designate

comments in a script.

? Question Mark Provide help information.

“ Quotation Mark Used to surround a single

token.

^A Control-A Position the cursor to the

start of the line.

Entering Command Line Interface Commands

1-3

Introduction

1

Table 1-1 CLI Command Tree Navigation Conventions (continued)

Character Sequence Common Name Action or Description

^B Control-B Position the cursor left one

character.

^D Control-D Delete the current character.

^E Control-E Position the cursor to the

end of the line.

^F Control-F Position the cursor right one

character.

^H Control-H Backspace one character

and delete the character.

^I Tab Complete the current

keyword.

^K Control-K Delete to the end of the line.

^L Control-L Redraw the line.

^N Control-N Move down one line in the

command history.

^P Control-P Move up one line in the

command history.

^R Control-R Redraw the line.

^U Control-U Clear the input and reset the

line buffer.

1-4

^X Control-X Clear the input and reset the

line buffer.

<ESC>[A Up Arrow Move up one line in the

command history.

<ESC>[B Down Arrow Move down one line in the

command history.

<ESC>[C Right Arrow Position the cursor right one

character.

<ESC>[D Left Arrow Position the cursor left one

character.

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

Introduction

1

&RPPDQG7UHH

Table 1-2 CLI Command Tree

The command tree of the CLI begins from the root. The commands in
the four extended branches (config, maint, perf, and show) are
described in Chapter 2, CLI Commands.

There are three additional commands (login, logout, and
commaDelim) that are globally available commands. These
commands are described in this chapter.

The hierarchy from the root, reading from left to right, is as follows.

config -------------------- features ----------------- installKey

enterpriseFabMode

ficonms

OpenSysMS

show

ip-------------------------- ethernet

show

port ----------------------- blocked

extDist

fan

name

speed

type

show

security ----------------- fabricBinding ----------- activatePending

addMember

clearMemList

deleteMember

replacePending

setFabBindState

showActive

showPending

portBinding ------------- bound

wwn

show

switchBinding ---------- addMember

deleteMember

setSwitchBindState

Entering Command Line Interface Commands

1-5

Introduction

1

Table 1-2 CLI Command Tree (continued)

show

userRights -------------- administrator

operator

show

snmp --------------------- addCommunity

authTraps

deleteCommunity

show

switch -------------------- bbCredit

domainRSCN

edTOV

insistDomainId

interopMode

prefDomainId

priority

raTOV

rerouteDelay

speed

show

system ------------------ contact

date

description

location

name

show

zoning ------------------- setDefZoneState

activateZoneSet

deactivateZoneSet

replaceZoneSet

clearZoneSet

addZone

deleteZone

renameZoneSet

addWwnMem

addPortMem

clearZone

1-6

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

Table 1-2 CLI Command Tree (continued)

maint --------------------- port ----------------------- beacon

system ------------------ beacon

perf ----------------------- class2

class3

clearStats

errors

link

traffic

show --------------------- eventLog

features

frus

ip -------------------------- ethernet

loginServer

nameServer

nameServerExt

port ----------------------- config

security ----------------- fabricBinding

switch

system

zoning

Introduction

1

deleteWwnMem

deletePortMem

renameZone

showPending

showActive

reset

clearSysError

ipl

resetConfig

setOnlineState

info

nodes

status

technology

portBinding

switchBinding

Entering Command Line Interface Commands

1-7

Introduction

1

Note that the commands are shown, with the exception of the zoning
commands, in alphabetical order to make them easier to locate.
Although the commands can be entered in any order, depending on
the results desired, the order shown in Tab le 1 -2 , CLI Command Tree,
on page 1-5 for the zoning commands is a typical order in which the
zoning commands are entered.

Note that the order in which commands are entered determines the
order in which the show commands display the values. Refer to

Chapter 2, CLI Commands for examples of show commands output.

1DYLJDWLRQRIWKH
&/,&RPPDQG7UHH

Once the administrator or operator logs in and receives the Root>
prompt, the CLI commands are accessed by navigating up and down
the CLI command tree.

To move from the root through the any of the four extended branches,
enter the name of the next branch as shown in Ta bl e 1 -2 , CLI

Command Tree, on page 1-5. For example, to use the config.port.name

command to configure the name for port 4 on the switch, this series of
commands is entered:

Root> config
Config> port
Config.Port> name 4 "Sam’s Tape Drive"

At this point, to enter the maint.port.beacon command to set the
beaconing state of port 4, the following series of commands is
entered:

Config.Port> ..
Config> ..
Root> maint
Maint> port
Maint.Port> beacon 4 true

Note that you must return all the way to the root of the tree to
transition to another extended branch. When traversing back to the
root, the name of each branch cannot be used. Instead use the
double-dot command (two periods) to move back towards the root.
Note that only one double-dot command may be entered at a time.

1-8

One approach to making the navigation more concise is to use the
root command to jump directly to the root of the CLI command tree.
The previous example, which shows stepping back to the root with
the double-dot command, is simplified as follows:

Config.Port> root
Root> maint

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

Introduction

Maint> port
Maint.Port> beacon 4 true

Another approach to making the navigation more concise is to use
the complete command syntax from the Root> prompt each time. For
example, to issue the config.port.name command and then the
maint.port.beacon command, the commands are entered as follows:

Root> config port name 4 "Sam’s Tape Drive"
Root> maint port beacon 4 true

As shown in this example, use of the complete command syntax
avoids navigating up and down the branches of the CLI command
tree, and the prompt stays at the root. The use of complete command
syntax is particularly useful when writing scripts.

When coding a script, remember to code the appropriate character
sequences, which are described in Navigation Conventions on page 1-3.

Root> config port name 4 "Sam’s Tape Drive"<CR>
Root> maint port beacon 4 true<CR>

1

/LPLWDWLRQRQ

0RYHPHQWV

As the commands are entered, they are recorded in a history log.
Note these limitations on movement that result from use of the
history log:

• If a command has more than 60 characters, the command runs,
but the command is not recorded in the history log, and the
position in the tree does not change, as shown in the following
example. Because the command is not recorded in the history, a
subsequent asynchronous command (navigation command)
cannot depend on it.

Root> config zoning addWwnMem TheUltimateZone 10:00:00:00
:C9:22:9B:64
Root>

• Whenever the position in the CLI command tree moves to a new
branch (for example, config to maint, config to config.port, or
config.port to config), the history log is cleared. In this case, any
asynchronous commands (for example, the up-arrow command
<ESC>[A or the up-arrow keyboard symbol) cannot move the
position back towards the root, as shown in this example:

Root> config
Root.Config> port
Root.Config.Port> <ESC>[A
Root.Config.Port>

Entering Command Line Interface Commands

1-9

Introduction

1

3DUDPHWHUV

2XWSXW

Some command parameters accept character strings that include
spaces. Quotation marks are required when a string includes spaces.

Config.System> location Building_24_Room_16

Config.System> location "Building 24 Room 16"

If spaces are not included in a parameter that accepts a string, the
quotation marks are not required around that string.

To include quotation marks in a string, use the escape character (\)
before the quotation marks.

Config.System> location "Building 24 \"Joe’s PlayLab\""

A null string can be created by using the quotation marks without
any space between them.

Config.System> location ""

All output from the CLI commands is limited to the standard 80
columns supported by most Telnet interfaces. The output is
left-justified.

1-10

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

/RJJLQJ,QDQG/RJJLQJ2XW

The CLI allows a single Telnet client to be connected to the switch. If a
Telnet client logs out, or if after 15 minutes of inactivity the client’s
access times out, another Telnet client may log in. Also note that the
Telnet client (user) must log in any time the director or switch is
restarted because the current user’s access is lost. Examples of a
restart include an IPL and any power-off situation.

Introduction

1

8VHU$FFHVV5LJKWV

ORJLQ

6\QWD[ login

3XUSRVH This command allows a Telnet client to connect to the switch.

'HVFULSWLRQ This command allows the user to log in with either administrator or

The CLI supports two user access rights: administrator and operator.
A user who logs in with administrator access rights can use all of the
commands described in this publication. However, operator access
rights grant permission to use only the perf and show branches of the
CLI command tree (for example, the perf.traffic and show.system
commands), as well as the globally available commands (login,
logout, and commaDelim).

operator access rights. The default passwords are password.
The login command is called automatically by the CLI each time a

new Telnet session is activated, as well as each time new
administrator access rights are configured.

After the login command is issued, the Username: prompt
automatically displays. After a valid user name is entered, the
Password: prompt automatically displays. After the corresponding
valid password is entered, the Root> prompt displays. At this
prompt the user may enter any of the commands included in

Ta bl e 1 -2 , CLI Command Tree, on page 1-5.

A user name and password can be set by the administrator through
the config.security.userRights.administrator command or through the
config.security.userRights.operator command.

Logging In and Logging Out

1-11

Introduction

1

The access rights chosen for the CLI are completely independent of
the other product interfaces, for example, SNMP or McDATA product
interfaces.

3DUDPHWHUV This command has no parameters.

&RPPDQG([DPSOHV login

Username: Administrator
Password: password

login

Username: Operator
Password: password

ORJRXW

6\QWD[ logout

3XUSRVH This command allows a Telnet client to disconnect from the switch.

'HVFULSWLRQ This command logs out the single Telnet client connected to the

switch. This command can be entered at any point in the command
tree.

1-12

3DUDPHWHUV This command has no parameters.

&RPPDQG([DPSOHV Root> logout

Config> logout

Config.Port> logout

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

8VLQJWKHFRPPD'HOLP&RPPDQG

Note that the output examples shown in the other sections of this
publication presume that commaDelim is off.

FRPPD'HOLP

6\QWD[ commaDelim enable

3XUSRVH This command enables the user to obtain displayed information in

comma-delimited, rather than tabular, format. Tabular format is the
default.

'HVFULSWLRQ This command can be entered at any point in the command tree.

3DU DPHWHU This command has one parameter

enable Specifies the comma-delineated state for

Introduction

1

output. Valid values are true and false. Boolean 1
and 0 may be substituted as values.

&RPPDQG([DPSOHV Root> commaDelim true

Config> commaDelim 1

Config.Port> commaDelim false

2XWSXW([DPSOH Output displayed in commaDelim mode is as follows:

Root> show eventLog
Date/Time,Code,Severity,FRU,Event Data,
04/12/01 10:58A,375,Major,CTP-0,00010203 04050607 08090A0B 0C0D0E0F,
04/12/01 10:58A,375,Major,CTP-0,00010203 04050607 08090A0B 0C0D0E0F,
04/12/01 9:58A,385,Severe,CTP-0,00010203 04050607 08090A0B 0C0D0E0F,
04/11/01 7:18P,395,Severe,CTP-0,00010203 04050607 08090A0B 0C0D0E0F,

Using the commaDelim Command

1-13

Introduction

1

+DQGOLQJ&RPPDQG/LQH,QWHUIDFH(UURUV

Two types of errors detected by the CLI are:

• An error associated with the interface. For example, a keyword is
misspelled or does not exist.

Root> confg
Error 234: Invalid Command

• An error associated with fabric or switch issues. For example, a
parameter error is detected by the switch, where port 24 is
entered for a switch that supports only 16 ports.

Root> config port name 24 "Port 24"
Error 248: Invalid Port Number

In either case, the command is ignored. The CLI remains at the point
it was before the command was entered.

The error messages, including error number and error, are listed in

Appendix A, Error Messages.

1-14

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500

8VLQJWKH&RPPDQG/LQH,QWHUIDFH+HOS

The question mark (?) can be used within a command to obtain
certain information:

• If the question mark is used in place of a command keyword, all
the keywords at that level of the CLI command tree display.

Root> config system ?
Command identified
contact - Set the system contact attribute
date - Set the system date and time
description - Set the system description attribute
location - Set the system location attribute
name - Set the system name attribute
show - Display the system configuration

• If the question mark is used at the end of a recognized command,
any parameters for that command display.

Root> config port name ?

- name <portNumber> <portName>

• If the question mark is used after one or more characters of a
keyword, any keywords at that level of the CLI command tree
display.

Introduction

1

Root> config s?
security snmp switch system

Using the Command Line Interface Help

1-15

Introduction

1

&RPPHQWLQJ6FULSWV

The pound sign (#) can be used to add comments in a script file. The
pound sign must be the first character in the line; the CLI ignores
everything after the pound sign in that line. The following lines are
valid:

Root> #Change port 3 to an E_Port<CR>
Root> config port<CR>
config.port> ##################<CR>
config.port> ## Begin Script ##<CR>
config.port> ##################<CR>

The pound sign cannot be used after any other characters (a
command, for example) to start a comment. The following is an
invalid script line:

Root> maint system beacon true # Turn on beaconing<CR>

To correct the previous script line, move the comment either before or
after the line with the command. For example, the following
examples are both valid:

Root> # Turn on beaconing<CR>
Root> maint system beacon true<CR>

1-16

Root> maint system beacon true<CR>
Root> # Turn on beaconing<CR>

Comments of over 200 characters in length may cause unpredictable system
behavior. Limit comments to 200 characters per line.

McDATA OPENconnectors Command Line Interface USER MANUAL P/N 620-000134-500