Cisco MDS 9000 Family Command Reference

Cisco MDS 9000 Series NX-OS Command
Reference Guide
Cisco NX-OS Release 6.2(13)
August, 2015
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Text Part Number: OL-29295-04
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL
STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
CCDE, CCENT, CCSI, Cisco Eos, Cisco Explorer, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase,
Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco TrustSec, Cisco Unified Computing System, Cisco WebEx, DCE, Flip Channels, Flip for Good, Flip
Mino, Flipshare (Design), Flip Ultra, Flip Video, Flip Video (Design), Instant Broadband, and Welcome to the Human Network are trademarks; Changing the Way We Work,
Live, Play, and Learn, Cisco Capital, Cisco Capital (Design), Cisco:Financed (Stylized), Cisco Store, Flip Gift Card, and One Million Acts of Green are service marks; and
Access Registrar, Aironet, AllTouch, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the
Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Lumin, Cisco Nexus, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity,
Collaboration Without Limitation, Continuum, EtherFast, EtherSwitch, Event Center, Explorer, Follow Me Browsing, GainMaker, iLYNX, IOS, iPhone, IronPort, the
IronPort logo, Laser Link, LightStream, Linksys, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, PCNow, PIX, PowerKEY,
PowerPanels, PowerTV, PowerTV (Design), PowerVu, Prisma, ProConnect, ROSA, SenderBase, SMARTnet, Spectrum Expert, StackWise, WebEx, and the WebEx logo are
registered trademarks of Cisco and/or its affiliates in the United States and certain other countries.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this
URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)
Cisco MDS 9000 Series NX-OS Command Reference Guide
© 2013-2014 Cisco Systems, Inc. All rights reserved.
New and Changed Information
Table 1 summarizes the new and changed commands for Cisco MDS NX-OS Release 6.2(1) and tells
you where they are documented in the Cisco MDS 9000 Family Command Reference .
The Cisco MDS 9000 Family Command Reference applies to Cisco NX-OS Release 6.2(1), but describes
all features in Cisco SAN-OS releases. If you are running Cisco SAN-OS 3.x or lower software on an
MDS switch, refer to the Cisco MDS 9000 Family CLI Command Reference for the release train that
applies to the release on your switch.
Note
Table 1
As of NX-OS Release 4.1(1b), SAN-OS has been changed to NX-OS. References to SAN-OS releases
before 4.1(1b) still apply.
New and Changed Commands in the Cisco MDS 9000 Family Command Reference
Feature
Description
Where Documented
New and Changed Commands for Cisco NX-OS Release 6.2(11)
event zone
This command was introduced.
E Commands
event fcns
This command was introduced.
E Commands
event flogi
This command was introduced.
E Commands
New and Changed Commands for Cisco NX-OS Release 6.2(9)
show fc-management
This command was introduced.
Show Commands
device-alias confirm-commit
enable
This command was introduced.
D Commands
zone confirm-commit enable
vsan
This command was introduced.
Z Commands
show zone status
Added the combined zone database size for the
command output.
Show Commands
priority-flow-control
Added the long-distance keyword to the syntax P Commands
description.
show fabric switch
information vsan
Added a note.
Show Commands
show topology
Added a note.
Show Commands
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
1
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
show tech-support
fc-management
This command was introduced.
Show Commands
show process creditmon
slowport-monitor-events
This command was introduced.
Show Commands
system timeout
no-credit-drop
This command was introduced.
S Commands
system timeout
slowport-monitor
This command was introduced.
S Commands
pwwn (fc-management
database configuration sub
mode)
This command was introduced.
P Commands
fc-management database
This command was introduced.
F Commands
fc-management enable
This command was introduced.
F Commands
fcdomain
Added the optimize all and scale-restart
F Commands
keywords to the syntax description.
fcroute
This command was deprecated.
F Commands
New and Changed Commands for Cisco NX-OS Release 6.2(7)
fcns bulk-notify
This command was introduced.
F Commands
rscn coalesce swrscn vsan
This command was introduced.
R Commands
switchport
S Commands
Added the keywords max-npiv-limit and
trunk-max-npiv-limit to the syntax description.
Added the keyword fec and speed to the syntax
description.
system port pacer mode F
interface-login-threshold
This command was introduced.
S Commands
show interface
Added the fec related command output.
Show Commands
zone convert smart-zoning
Changed the command output.
Z Commands
show fabric switch
information vsan
This command was introduced.
Show Commands
New and Changed Commands for Cisco NX-OS Release 6.2(5)
destination interface
SPAN is supported and RSPAN is not supported D commands
in Cisco MDS 9250i Multiservice Fabric Switch.
show fc-tunnel
This command was deprecated.
Show Commands
Cisco MDS 9000 Family Command Reference
2
OL-29295-04, Cisco MDS NX-OS Release 6.x
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
fc-tunnel
All the fc-tunnel commands are not supported in F Commands
Cisco MDS 9250i Multiservice Fabric Switch.
ioa-ping
This command was introduced.
I Commands
Pathtrace
This command was introduced.
P Commands
show fcip
Added the command output for FCIP Profiles for Show Commands
Cisco MDS 9250i Multiservice Fabric Switch.
show interface capabilities
Added the Cisco MDS 9250i Multiservice
Fabric Switch output to the “show interface
capabilities”command.
show interface
Added the command output for detailed FCIP
Interface Standard Counter Information, FCIP
Interface Summary of Counters for a Specified
Interface, brief FCIP Interface Counter
Information for Cisco MDS 9250i Multiservice
Fabric Switch.
show interface ioa
Added the show interface ioa 1/1 counters
brief command to show the average for
5minutes, 12 hours and 24 hours respectively.
New and Changed Commands for Cisco NX-OS Release 6.2(3)
fcdomain
show fcdomain vsan command
Show Commands
(Changed the command output)
counters
Deprecated the show interface counters
performance command
New and Changed Commands for Cisco NX-OS Release 6.2(1)
Online diagnostics (GOLD)
Added the diagnostic bootup level command
D Commands
Added the diagnostic monitor interval module
command
Added the diagnostic monitor module
command
Added the diagnostic ondemand iteraction
command
Added the diagnostic ondemand
action-on-failure command
Added the diagnostic start module command
Added the diagnostic stop module command
Added the show diagnostic bootup level
command
Show Commands
Added the show diagnostic content module
command
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
3
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
Added the show diagnostic description module
command
Added the show diagnostic events command
Added the show diagnostic ondemand setting
command
Added the show diagnostic result module
command
Added the show diagnostic simulation module
command
Added the show diagnostic status module
command
Added the show hardware capacity command
Added the show module command
Deprecated secure erase
commands
secure-erase abort job
S Commands
secure-erase create algorithm
secure-erase create job
secure-erase create-vi vsan
secure-erase destroy algorithm
secure-erase destroy job
secure-erase destroy-vi vsan
secure-erase start job
secure-erase stop job
secure-erase validate job
security-mode
add-session vsan
A Commands
add-step dynamic
add-step static
add-tgt vsan
add-vi vsan
show secure-erase vsan
Show Commands
show secure-erase algorithm
show secure-erase job
show secure-erase job detail
show secure-erase vsan
FCSP
Added the snmp-server aaa
exclusive-behavior enable command
S Commands
Cisco MDS 9000 Family Command Reference
4
OL-29295-04, Cisco MDS NX-OS Release 6.x
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
clear snmp counters
Added the snmp option to the syntax
description.
C Commands
Performance statistics
show interface
Show Commands
Added the performance, module and interval
keywords to the syntax description.
Display ISL related
information
Added show topology isl command.
Show Commands
Luke CLI changes
Added the monitor session command
M Commands
Added the output for remote span configuration F Commands
on local and remote switch for fc-tunnel
command
S Commands
source command
Added the keywords ethernet,
ethernet-port-channel, sup-eth, vlan to the
syntax description.
Added the show monitor session command
Show Commands
Depercated span session, span session source
interface, suspend, span max-queued-packets
commands
New and Changed Commands for Cisco NX-OS Release 5.2(8)
RSCN
Added the rscn permit type nport event
switch-config command
R Commands
New and Changed Commands for Cisco NX-OS Release 5.2(6)
Slow drain
Added the system default interface congestion S Commands
timeout command
Added the system default interface congestion
mode command
Added the system default interface pause
timeout command
Added the system default interface pause
mode command
Smart Zoning
Added the show zone smart-zoning auto-conv Show Commands
command
Added the zone smart-zoning enable command Z Commands
Added the clear zone smart-zoning command
C Commands
Added the zone convert smart-zoning
command
Z Commands
member (zone configuration and zoneset-zone M Commands
configuration submode) Added the keywords
both, initiator, target to the sysntax description
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
Added the system default zone smart-zone
enable command
S Commands
Added the show zone policy command
Show Commands
Added the show zone internal vsan command
Show Commands
Added the show zone internal global-info
command
Show Commands
New and Changed Commands for Cisco NX-OS Release 5.2(2a)
Port Monitor
counter (port-group-monitor configuration
mode) command
C Commands
(Added 3 new counters to the syntax
description)
New and Changed Commands for Cisco NX-OS Release 5.2(1)
CallHome
transport http proxy enable command
transport http proxy server command
T Commands
show callhome transport command
Show Commands
show logging command (Added a new
comment)
out-of-service command (This command was
deprecated)
O Commands
out-of-service module command (Applicable for
supervisor module only)
out-of-service xbar command (This command
was deprecated)
New and Changed Commands for Cisco NX-OS Release 5.0(1a)
AAA enhancements
radius-server test command
R Commands
tacacs-server test command
T Commands
aaa authentication login chap enable
command
A Commands
aaa authentication login command
(Added fallback, error, and local keywords to
the syntax description)
AAM
show aaa authentication login chap enable
command
Show commands
ivr aam register command
I Commands
ivr aam pre-deregister-check command
fc-redirect version2 enable command
F Commands
fc-redirect ivr-support enable command
show ivr aam command
Show Commands
Cisco MDS 9000 Family Command Reference
6
OL-29295-04, Cisco MDS NX-OS Release 6.x
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
Enhancements for Call Home
transport email mail-server command
T Commands
show callhome transport command
Show Commands
enable command
E Commands
Per-command authorization
with TACACS with roles
support
enable user-server-group command
F Commands
feature command
(Added privilege keyword to the syntax
description)
SSH enhancements
username command
U Commands
(Added the keypair and Priv-lvl keyword to the
syntax description)
show username command
Show Commands
FICON
ficon-tape-read-accelerator command
F Commands
ISAPI enhancements
ssm enable feature command
(Added a node keyword to the syntax
description)
Cert PKI
show crypto ca remote-certstore command
Show Commands
show crypto certificatemap command
show crypto ssh-auth-map command
crypto certificatemap mapname command
C Commands
crypto cert ssh-authorize command
crypto ca lookup command
crypto ca remote ldap command
LDAP
filter command
F Commands
ldap-server deadtime command
L Commands
ldap-server port command
ldap-server timeout command
ldap-server host command
ldap-search-map command
aaa group server command
A Commands
server command
S Commands
show ldap-server command
Show Commands
show ldap-server groups command
show ldap-search-map command
aaa authorization ssh-certificate command
A Commands
aaa authorization ssh-publickey command
authentication command
auth-mechanism plain command
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
7
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
debug ldap command
D Commands
enable cert-DN-match command
E Commands
enable user-server-group command
deadtime (server group configuration mode)
command
D Commands
CRLLookup command
C Commands
trustedcert command
T Commands
user-certdn-match command
U Commands
user-pubkey-match command
user-switch-bind command
userprofile command
Deprecated Command
fcc enable command
F Commands
New and Changed Commands for Cisco NX-OS Release 4.2(1)
Call Home
destination-profile command
D Commands
(Deleted Avanti keyword from the syntax
description. Added the Usage guideline)
EEM
action event-default command
A Commands
(Added a note)
terminal event-manager bypass command
T Commands
(Added a note)
event command
E Commands
(Added a note)
Port Guard
errdisable detect cause bit-errors command
E Commands
errdisable detect cause credit-loss command
errdisable detect cause link-reset command
errdisable detect cause signal-loss command
errdisable detect cause sync-loss command
errdisable detect cause trustsec-violation
command
feature command
F Commands
(Added ioa keyword to the syntax description)
AAA Enhancements
show aaa authentication login chap enable
command
Show Commands
show aaa authorization all command
Cisco MDS 9000 Family Command Reference
8
OL-29295-04, Cisco MDS NX-OS Release 6.x
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
clear tacacs-server statistics command
C Commands
clear radius-server statistics command
aaa authentication login mschapv2 enable
command
A Commands
aaa authorization command
test aaa authorization command
T Commands
terminal verify-user command
FC-redirect with IVR
show ivr aam command
FC-ID Visibility
show fcns database command
Show Commands
(Changed the command output)
IOA
ioa site-local command
I commands
ioa cluster command
interface ioa command
load-balancing (Cisco IOA cluster
Configuration submode) command
L Commands
nport command
N Commands
node (Cisco IOA cluster node configuration
submode) command
flowgroup command
host command
H Commands
trustedcert command
show ioa internal interface ioa command
Show Commands
show ioa cluster summary command
show interface ioa command
show ioa cluster command
Port Group Monitoring
show port-group-monitor active command
Show Commands
show port-group-monitor command
show port-group-monitor status command
port-group-monitor activate command
P Commands
port-group-monitor name command
port-group-monitor enable command
port-group-monitor counter command
Trustsec
monitor counter command
M Commands
show running-config callhome command
Show Commands
show fcsp interface command
fcsp esp sa command
F Commands
fcsp command
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
9
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
ingress-sa command
I Commands
interface fc command
egress-sa command
E Commands
mode command
M Commands
key (sa configuration submode) command
K Commands
salt (sa configuration submode) command
S Commands
New and Changed Commands for Cisco NX-OS Release 4.1(3a)
AAA enhancements
aaa authentication login ascii-authentication
command
A Commands
(enable the password aging command has been
changed from aaa authentication login
password-aging enable to aaa authentication
login ascii-authentication)
show aaa authentication login
ascii-authentication command
Show Commands
(enable the password aging command has been
changed from show aaa authentication login
password-aging enable to show aaa
authentication login ascii-authentication)
New and Changed Commands for Cisco NX-OS Release 4.1(3)
Call Home
destination-profile command
D Commands
(Added the HTTPs URL and transport method to
the syntax description)
Port Guard
errdisable detect cause link-down command
E Commands
Port Owner
switchport owner command
S Commands
F port Trunking
command
F Commands
(Added Keywords hhtp-server,
fport-channel-trunk, npiv and npv to the
syntax description)
switchport command
S Commands
(Added the F and NP port mode)
show flogi database interface command
Show Commands
Cisco MDS 9000 Family Command Reference
10
OL-29295-04, Cisco MDS NX-OS Release 6.x
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
F port Channeling
show port-channel compatibility-parameters Show Commands
command
show port-channel consistency command
show port-channel database command
show port-channel internal command
show port-channel summary command
show port-channel usage command
C Commands
channel-group command
(Deleted auto keyword from the syntax
description)
port-channel persistent command
P Commands
(Added usage guideline)
clear asic-cnt command
C Commands
show fcns database command
Show Commands
(Changed the command output for show fcns
database detail)
Hardware
show system command
Show Commands
(Changed the show system uptime output)
Radius Configuration
radius-server host command
R Commands
(Changed the command output)
show running radius command
Show Commands
(Changed the command output)
EEM
event manager applet command
E Commands
errdisable detect cause bit-errors command
event manager policy command
event manager environment command
description command
D Commands
show event manager policy command
Show Commands
show event manager environment command
action cli command
A Commands
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
11
New and Changed Information
Table 1
Feature
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Description
Where Documented
action counter command
action event-default command
action exception log command
action forceshut command
action overbudgetshut command
action policy-default command
action reload command
action snmp-trap commnd
action syslog command
Added SME Commands
SME
scaling batch enable command
S Commands
Cisco MDS 9000 Family Command Reference
12
OL-29295-04, Cisco MDS NX-OS Release 6.x
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
New and Changed Commands for Cisco NX-OS Release 4.1(1b)
Call Home
switch-priority command
S Commands
(Added usage guidelines)
system delayed-traps timer command
system delayed-traps enable mode command
system health
system health clear-errors command
S Commands
Port-monitor
show port-monitor status command
Show Commands
show port-monitor active command
SNMP
show system internal snmp lc command
SSM
ssm upgrade delay command
S Commands
SANTap
show isapi tech-support santap file command
Show Commands
(Added usage guidelines)
show santap module dvt command
show santap module dvtlun command
show santap vttbl dvt command
show santap vttbl dvt host command
SDV
show sdv command
Show Commands
(Changed the command output)
attribute failover auto command
A Commands
General Configuration
feature command
F Commands
DPVM
clear dpvm merge statistics command
C Commands
show dpvm merge statistics command
Show Commands
show dpvm merge status command
Generation 3 Modules
dpvm overwrite-duplicate-pwwn command
D Commands
do command
D Commands
(Added the command output for extended
receive bbcredit interface)
(Added a Note)
show interface command
Show Commands
(Added the command output for bbcredit
information for a switch port)
(Added the command output for interface
capabilities on a 48 port line card)
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
13
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
show module command
Show Commands
(Added the command output for a module
resource on a 24 port line card with all ports in
shared mode)
(Added the command output for a module
resource on a 24 port line card with few ports in
shared mode and few port in dedicated mode)
(Added the command output for a module
resource on a 12 port line card with all ports in
dedicated mode)
(Added the command output for a module
resource on a 12 port line card with all ports in
dedicated mode and extended feature enabled)
Hardware
show hardware fabric-mode command
Show Commands
show username command
(Changed the command output from SAN-OS to
NX-OS)
show hardware command
(Changed the command output from SAN-OS to
NX-OS)
show copyright command
(Changed the command output from SAN-OS to
NX-OS)
Deprecated Commands
(see the feature command for replacement commands)
crypto ike enable command
C Commands
dpvm enable command
D Commands
fabric-binding enable command
F Commands
fcip enable command
fcsp enable command
ficon enable command
ivr enable command
I Commands
port-security enable command
P Commands
sdv enable command
S Commands
tacacs+ enable command
T Commands
Added DMM Commands
Cisco MDS 9000 Family Command Reference
14
OL-29295-04, Cisco MDS NX-OS Release 6.x
New and Changed Information
Table 1
New and Changed Commands in the Cisco MDS 9000 Family Command Reference (continued)
Feature
Description
Where Documented
DMM
dmm module job command
D Commands
(Added the set-vi and modify rate keywords)
show dmm module command
Show Commands
(Added the syntax description and the command
output)
Added SME Commands
SME
cluster command
C Commands
(Cluster command is replaced by the feature
command)
show tech-support sme command
Show Commands
(Added the command output)
show role command
(Added the command output)
show sme cluster
(Added the syntax description)
show sme transport command
(Added the syntax description)
show debug command
(Added the syntax description)
delete command
D Commands
(Added the syntax description)
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
15
New and Changed Information
Cisco MDS 9000 Family Command Reference
16
OL-29295-04, Cisco MDS NX-OS Release 6.x
Preface
This preface describes the audience, organization, and conventions of the Cisco MDS 9000 Family
Command Reference. It also provides information on how to obtain related documentation.
Audience
This guide is for experienced network operators and administrators who are responsible for configuring
and maintaining the Cisco MDS 9000 family of multilayer directors and fabric switches.
Document Conventions
Command descriptions use these conventions:
Convention
Indication
boldface font
Commands and keywords are in boldface.
italic font
Arguments for which you supply values are in italics.
[ ]
Elements in square brackets are optional.
{x | y | z }
Required alternative keywords are grouped in braces and separated by vertical
bars.
[x|y|z]
Optional alternative keywords are grouped in brackets and separated by vertical
bars.
string
A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.
Screen examples use these conventions:
Convention
screen
Indication
font
Terminal sessions and information the switch displays are in screen font.
boldface screen
Information you must enter is in boldface screen font.
font
italic screen
< >
font
Arguments for which you supply values are in italic screen font.
Nonprinting characters, such as passwords are in angle brackets.
Cisco MDS 9000 Family Command Reference
OL-29295-04
v
[ ]
Default responses to system prompts are in square brackets.
!, #
An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.
This document uses the following conventions:
Note
Caution
Means reader take note. Notes contain helpful suggestions or references to material not covered in the
manual.
Means reader be careful. In this situation, you might do something that could result in equipment
damage or loss of data.
Related Documentation
The documentation set for the Cisco MDS 9000 Family includes the following documents. To find a
document online, use the Cisco MDS NX-OS Documentation Locator at:
http://www.cisco.com/en/US/docs/storage/san_switches/mds9000/roadmaps/doclocater.htm
Release Notes
•
Cisco MDS 9000 Family Release Notes for Cisco MDS NX-OS Releases
•
Cisco MDS 9000 Family Release Notes for MDS SAN-OS Releases
•
Cisco MDS 9000 Family Release Notes for Cisco MDS 9000 EPLD Images
•
Cisco DCNM Release Notes
Regulatory Compliance and Safety Information
•
Regulatory Compliance and Safety Information for the Cisco MDS 9000 Family
Compatibility Information
•
Cisco Data Center Interoperability Support Matrix
•
Cisco MDS 9000 NX-OS Hardware and Software Compatibility Information and Feature Lists
•
Cisco MDS 9000 Family Switch-to-Switch Interoperability Configuration Guide
Hardware Installation
•
Cisco MDS 9500 Series Hardware Installation Guide
•
Cisco MDS 9200 Series Hardware Installation Guide
Cisco MDS 9000 Family Command Reference
vi
OL-29295-04
•
Cisco MDS 9100 Series Hardware Installation Guide
•
Cisco MDS 9124 and Cisco MDS 9134 Multilayer Fabric Switch Quick Start Guide
Software Installation and Upgrade
•
Cisco MDS 9000 NX-OS Software Upgrade and Downgrade Guide
•
Cisco MDS 9000 Family NX-OS Licensing Guide
•
Cisco MDS 9000 Family NX-OS Fundamentals Configuration Guide
•
Cisco MDS 9000 Family NX-OS Interfaces Configuration Guide
•
Cisco MDS 9000 Family NX-OS Fabric Configuration Guide
•
Cisco MDS 9000 Family NX-OS Quality of Service Configuration Guide
•
Cisco MDS 9000 Family NX-OS Security Configuration Guide
•
Cisco MDS 9000 Family NX-OS IP Services Configuration Guide
•
Cisco MDS 9000 Family NX-OS Intelligent Storage Services Configuration Guide
•
Cisco MDS 9000 Family NX-OS High Availability and Redundancy Configuration Guide
•
Cisco MDS 9000 Family NX-OS Inter-VSAN Routing Configuration Guide
•
Cisco MDS 9000 Family Cookbook for Cisco MDS SAN-OS
Cisco NX-OS
Cisco DCNM-SAN
•
Cisco DCNM Fundamentals Guide, Release 6.x
•
System Management Configuration Guide, Cisco DCNM for SAN, Release 6.x
•
Interfaces Configuration Guide, Cisco DCNM for SAN, Release 6.x
•
Fabric Configuration Guide, Cisco DCNM for SAN, Release 6.x
•
Quality of Service Configuration Guide, Cisco DCNM for SAN, Release 6.x
•
Security Configuration Guide, Cisco DCNM for SAN, Release 6.x
•
IP Services Configuration Guide, Cisco DCNM for SAN, Release 6.x
•
Intelligent Storage Services Configuration Guide, Cisco DCNM for SAN, Release 6.x
•
High Availability and Redundancy Configuration Guide, Cisco DCNM for SAN, Release 6.x
•
Inter-VSAN Routing Configuration Guide, Cisco DCNM for SAN, Release 6.x
•
SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 6.x
•
Cisco DCNM Fundamentals Guide, Release 6.x
•
Cisco DCNM Installation and Licensing Guide, Release 6.x
Cisco DCNM
Cisco MDS 9000 Family Command Reference
OL-29295-04
vii
Command-Line Interface
•
Cisco MDS 9000 Family Command Reference
Intelligent Storage Networking Services Configuration Guides
•
Cisco MDS 9000 Family I/O Acceleration Configuration Guide
•
Cisco MDS 9000 Family SANTap Deployment Guide
•
Cisco MDS 9000 Family Data Mobility Manager Configuration Guide
•
Cisco MDS 9000 Family Storage Media Encryption Configuration Guide
Troubleshooting and Reference
•
Cisco MDS 9000 Family and Nexus 7000 Series System Messages Reference
•
Cisco MDS 9000 Family SAN-OS Troubleshooting Guide
•
Cisco MDS 9000 Family NX-OS MIB Quick Reference
•
Cisco DCNM for SAN Database Schema Reference
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional
information, see the monthly What’s New in Cisco Product Documentation, which also lists all new and
revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
•
Subscribe to the What’s New in Cisco Product Documentation as a Really Simple Syndication (RSS)
feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds
are a free service and Cisco currently supports RSS version 2.0.
Cisco MDS 9000 Family Command Reference
viii
OL-29295-04
CH A P T E R
2
A Commands
The commands in this chapter apply to the Cisco MDS 9000 Family of multilayer directors and fabric
switches. All commands are shown here in alphabetical order regardless of command mode. See “About
the CLI Command Modes” section on page 1-3 to determine the appropriate mode for each command.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-1
Chapter 2
A Commands
10G-speed-mode
10G-speed-mode
To enable 10 gig speed mode, use the 10G-speed-mode command. To disable this feature, use the no
form of the command.
10G-speed-mode
no 10G-speed-mode
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Interface Configuration mode.
Command History
Release
Modification
5.x
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable the 10 Gig speed mode:
switch# config terminal
switch(config-if)# 10G-speed-mode
switch(config-if)#
Related Commands
Command
Description
show interface fc x/y
brief
Displays the interface brief information.
show running-config
interface fc x/y
Displays the running configuration of the interface.
Cisco MDS 9000 Family Command Reference
2-2
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
16G-speed-mode
16G-speed-mode
To enable 2, 4, 8 and 16G speed mode, use the 16G-speed-mode command. To disable this feature, use
the no form of the command.
16G-speed-mode
no 16G-speed-mode
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled.
Command Modes
Interface Configuration mode.
Command History
Release
Modification
6.x
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable the 16 Gig speed mode:
switch# config terminal
switch(config-if)# 16G-speed-mode
switch(config-if)#
Related Commands
Command
Description
show interface fc x/y
brief
Displays the interface brief information.
show running-config
interface fc x/y
Displays the running configuration of the interface.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-3
Chapter 2
A Commands
aaa accounting default
aaa accounting default
To configure the default accounting method, use the aaa accounting default command. To revert to the
default local accounting, use the no form of the command.
aaa accounting default {group group-name [none] | none} | local [none] | none}
no aaa accounting default {group group-name [none] | none} | local [none] | none}
Syntax Description
group group-name
Specifies the group authentication method. The group name is a maximum
of 127 characters.
none
(Optional) No authentication, everyone permitted.
local
Specifies the local authentication method.
Defaults
Local accounting.
Command Modes
Configuration mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
Specify the currently configured command preceded by a no in order to revert to the factory default.
Examples
The following example enables accounting to be performed using remote TACACS+ servers which are
members of the group called TacServer, followed by the local accounting method:
switch# config t
switch(config)# aaa accounting default group TacServer
The following example turns off accounting:
switch(config)# aaa accounting default none
The following example reverts to the local accounting (default):
switch(config)# no aaa accounting default group TacServer
Related Commands
Command
Description
show aaa accounting
Displays the configured accounting methods.
Cisco MDS 9000 Family Command Reference
2-4
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa accounting logsize
aaa accounting logsize
To set the size of the local accounting log file, use the aaa accounting logsize command to set the size
of the local accounting log file. To revert to the default log file size of 250000 bytes, use the no form of
the command.
aaa accounting logsize integer
no aaa accounting logsize
Syntax Description
logsize
Configures local accounting log file size (in bytes).
integer
The size limit of the local accounting log file in bytes from 0 to 250000.
Defaults
25,0000.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
2.0
This command was deprecated.
Usage Guidelines
None.
Examples
The following example shows the log file size configured at 29000 bytes:
switch# config terminal
switch(config)# aaa accounting logsize 29000
Related Commands
Command
Description
show accounting logsize
Displays the configured log size.
show accounting log
Displays the entire log file.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-5
Chapter 2
A Commands
aaa authentication dhchap default
aaa authentication dhchap default
To configure DHCHAP authentication method, use the aaa authentication dhchap default command
in configuration mode. To revert to defaults, use the no form of the command.
aaa authentication dhchap default {group group-name [none] | none} | local [none] | none}}
no aaa authentication dhchap default {group group-name [none] | none} | local [none] | none}
Syntax Description
group group-name
Specifies the group name authentication method. The group name is a
maximum of 127 characters.
none
(Optional) Specifies no authentication.
local
Specifies local user name authentication (default).
Defaults
Local user name authentication.
Command Modes
Configuration mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
By default, DHCHAP authentication is tried against the on-switch (local) database.
The option local is implied after a group. To override this behavior, specify the none option after the
server group.
Authentication is tried against the list of databases in the order specified in the command. An
authentication response stops the search. No response from any server in a server group is not a response,
so searching continues through the list.
Examples
The following example enables all DHCHAP authentication to be performed using remote TACACS+
servers which are members of the group called TacServers, followed by the local authentication:
switch# config terminal
switch(config)# aaa authentication dhchap default group TacServer
The following example reverts to the local authentication method (default):
switch(config)# no aaa authentication dhcahp default group TacServer
Related Commands
Command
Description
show aaa authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
2-6
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa authentication iscsi default
aaa authentication iscsi default
To configure the iSCSI authentication method, use the aaa authentication iscsi default command in
configuration mode. To negate the command or revert to factory defaults, use the no form of this
command.
aaa authentication iscsi default {group group-name [none] | none} | local [none] | none}}
no aaa authentication iscsi default {group group-name [none] | none} | local [none] | none}}
Syntax Description
group group-name
Specifies the group name. The group name is a maximum of 127 characters.
none
(Optional) Specifies no authentication.
local
Specifies local user name authentication (default).
Defaults
Local user name authentication.
Command Modes
Configuration mode.
Command History
Usage Guidelines
Release
Modification
1.3(1)
This command was introduced.
By default, iSCSI authentication is tried against the on-switch (local) database.
The option local is implied after a group. To override this behavior, specify the none option after the
server group.
Authentication is tried against the list of databases in the order specified in the command. An
authentication response stops the search. No response from any server in a server group is not a response,
so searching continues through the list.
Examples
The following example enables all iSCSI authentication to be performed using remote TACACS+ servers
which are members of the group called TacServers, followed by the local authentication:
switch# config terminal
switch(config)# aaa authentication iscsi default group TacServer
The following example reverts to the local authentication method (default):
switch(config)# no aaa authentication iscsi default group TacServer
Related Commands
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-7
Chapter 2
A Commands
aaa authentication iscsi default
Command
Description
show aaa authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
2-8
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa authentication login ascii-authentication
aaa authentication login ascii-authentication
To enable ASCII authentication, use the aaa authentication login ascii-authentication command. To
disable this feature, use the no form of the command.
aaa authentication login ascii-authentication
no aaa authentication login ascii-authentication
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.1(3a)
aaa authentication login password-aging enable command changed to aaa
authentication login ascii-authentication.
Usage Guidelines
Note
Note
Examples
Password aging notification is initiated when the user authenticates to a Cisco MDS 9000 switch with a
TACACS+ account. The user is notified when a password is about to expire or has expired. If the
password has expired, the user is prompted to change the password.
As of Cisco MDS SAN-OS Release 3.2(1), only TACACS+ supports password aging notification. If you
try to use RADIUS servers by enabling this feature, RADIUSs will generate a SYSLOG message and
authentication will fall back to the local database. Cisco ACS TACACS+ server must have chpass enabled
as well.
•
Password change—You can change your password by entering a blank password.
•
Password aging notification—Notifies password aging. Notification happens only if the AAA server
is configured and MSCHAP and MSCHAPv2 is disabled.
•
Password change after expiration—Initiates password change after the old password expires.
Initiation happens from the AAA server.
Password aging notification fails if you do not disable MSCHAP and MSCHAPv2 authentication.
The following example shows how to enable ASCII authentication:
switch(config)# aaa authentication login ascii-authentication
switch#(config)#
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-9
Chapter 2
A Commands
aaa authentication login ascii-authentication
Related Commands
Command
Description
show aaa
authentication login
ascii-authentication
Displays the configured ASCII authentication method.
Cisco MDS 9000 Family Command Reference
2-10
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa authentication login chap enable
aaa authentication login chap enable
To enable CHAP authentication for login, use the aaa authentication login chap enable command. To
disable CHAP authentication, use the no form of the command.
aaa authentication login chap enable
no aaa authentication login chap enable
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable CHAP authentication for login:
switch(config)# aaa authentication login chap enable
switch(config)#
Related Commands
Command
Description
show aaa
authentication login
chap
Displays CHAP authentication for login.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-11
Chapter 2
A Commands
aaa authentication login console fallback error local
aaa authentication login console fallback error local
To configure the console login methods, use the aaa authentication login console command. To disable
the console login methods, use the no form of the command.
aaa authentication login console fallback error local
no aaa authentication login console fallback error local
Syntax Description
fallback
Specifies the fallback mechanism configuration error.
error
Specifies the authentication error.
local
Specifies the fallback to local authentication.
Defaults
None
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
Use this command to control authentication search after all authentication groups fail to respond. This
could occur if network connectivity were interrupted.
Examples
The following example shows how to configure the console methods:
switch(config)# aaa authentication login console fallback error local
switch(config)#
Related Commands
Command
Description
show aaa
authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
2-12
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa authentication login console group
aaa authentication login console group
To configure the console login methods, use the aaa authentication login console command. To disable
the console login methods, use the no form of the command.
aaa authentication login console group group-name0 [group-name1 [none] [group-name2
[none][group-name3 [none] [group-name4 [none] [group-name5 [none] [group-name6 [none]
[group-name7 [none]]]]]]]
no aaa authentication login console group group-name0 [group-name1 [none] [group-name2
[none][group-name3 [none] [group-name4 [none] [group-name5 [none] [group-name6 [none]
[group-name7 [none]]]]]]]
Syntax Description
group group-name
Specifies the group name. The group name is a maximum of 127 characters.
none
(Optional) Disable authentication checking. All registered users are
permitted but passwords are not checked.
Defaults
None
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
Authentication is tried against the list of authentication groups in the order specified in the command. A
response from an authentication server stops the search. No response from any server in a server group
is not a response so searching continues through the list.
Examples
The following example shows how to configure the console methods:
switch(config)# aaa authentication login console group TacServer
switch(config)#
Related Commands
Command
Description
show aaa
authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-13
Chapter 2
A Commands
aaa authentication login console local
aaa authentication login console local
To configure the console login methods, use the aaa authentication login console command. To disable
the console login methods, use the no form of the command.
aaa authentication login console local
no aaa authentication login console local
Syntax Description
local
Specifies to use the local user database for authentication.
Defaults
None
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure the console methods:
switch(config)# aaa authentication login console local
switch(config)#
Related Commands
Command
Description
show aaa
authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
2-14
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa authentication login console none
aaa authentication login console none
To configure the console login methods, use the aaa authentication login console command. To disable
the console login methods, use the no form of the command.
aaa authentication login console none
no aaa authentication login console none
Syntax Description
none
Disable authentication checking. All registered users are permitted but
passwords are not checked.
Defaults
None
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
User names are validated but the supplied password is not.
Examples
The following example shows how to configure the console methods:
switch(config)# aaa authentication login console none
switch(config)#
Related Commands
Command
Description
show aaa
authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-15
Chapter 2
A Commands
aaa authentication login default fallback error local
aaa authentication login default fallback error local
To configure default login methods, use the aaa authentication login default command. To disable
default login methods, use the no form of the command.
aaa authentication login default fallback error local
no aaa authentication login default fallback error local
Syntax Description
.
fallback
Specifies the fallback mechanism configuration error.
error
Specifies the authentication error.
local
Specifies the fallback to local authentication.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
Use this command to control authentication search after all authentication groups fail to respond. This
could occur if network connectivity were interrupted.
Examples
The following example shows how to configure default methods:
switch(config)# aaa authentication login default fallback error local
Related Commands
Command
Description
show aaa
authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
2-16
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa authentication login default group
aaa authentication login default group
To configure default login methods, use the aaa authentication login default command. To disable
default login methods, use the no form of the command.
aaa authentication login default group group-name0 [group-name1 [none] [group-name2
[none][group-name3 [none] [group-name4 [none] [group-name5 [none] [group-name6 [none]
[group-name7 [none]]]]]]]
no aaa authentication login default group group-name0 [group-name1 [none] [group-name2
[none][group-name3 [none] [group-name4 [none] [group-name5 [none] [group-name6 [none]
[group-name7 [none]]]]]]]
Syntax Description
.
group group-name
Specifies the group name. The group name is a maximum of 127 characters.
Note that the next group is only used if the previous group is unreachable.
none
(Optional) Disable authentication checking. All registered users are
permitted but passwords are not checked.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
Authentication is tried against the list of authentication groups in the order specified in the command. A
response from an authentication server stops the search. No response from any server in a server group
is not a response so searching continues through the list.
Examples
The following example shows how to configure default methods:
switch(config)# aaa authentication login default group TacServer
switch(config)#
Related Commands
Command
Description
show aaa
authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-17
Chapter 2
A Commands
aaa authentication login default local
aaa authentication login default local
To configure default login methods, use the aaa authentication login default command. To disable
default login methods, use the no form of the command.
aaa authentication login default local
no aaa authentication login default local
Syntax Description
.
local
Specifies to use the local user database for authentication.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure default methods:
switch(config)# aaa authentication login default local
switch(config)#
Related Commands
Command
Description
show aaa
authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
2-18
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa authentication login default none
aaa authentication login default none
To configure default login methods, use the aaa authentication login default command. To disable
default login methods, use the no form of the command.
aaa authentication login default none
no aaa authentication login default none
Syntax Description
.
none
Disable authentication checking. All registered users are permitted but
passwords are not checked.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
User names are validated but the supplied password is not.
Examples
The following example shows how to configure default methods:
switch(config)# aaa authentication login default none
Related Commands
Command
Description
show aaa
authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-19
Chapter 2
A Commands
aaa authentication login error-enable
aaa authentication login error-enable
To enable the display of error message on login failures, use the aaa authentication login error-enable
command. To disable the display of error message, use the no form of the command.
aaa authentication login error-enable
no aaa authentication login error-enable
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable to display the error message on login failures:
switch(config)# aaa authentication login error-enable
switch(config)#
Related Commands
Command
Description
show aaa
authentication login
error-enable
Displays the status of error message.
Cisco MDS 9000 Family Command Reference
2-20
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa authentication login invalid-username-log
aaa authentication login invalid-username-log
To enable invalid username login, use the aaa authentication login invalid-username-log command.
To disable invalid username login, use the no form of the command.
aaa authentication login invalid-username-log
no aaa authentication login invalid-username-log
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable invalid username login:
switch(config)# aaa authentication login invalid-username-log
switch(config)#
Related Commands
Command
Description
show aaa
authentication login
invalid-username-log
Displays the status of invalid username login.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-21
Chapter 2
A Commands
aaa authentication login mschap
aaa authentication login mschap
To enable MS-CHAP authentication between the switch and authentication servers, use the aaa
authentication login mschap command. To disable MS-CHAP authentication between the switch and
authentication servers, use the no form of the command.
aaa authentication login mschap enable
no aaa authentication login mschap enable
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable MSCHAP authentication for login:
switch(config)# aaa authentication login mschap enable
switch(config)#
Related Commands
Command
Description
show aaa
authentication login
mschap
Display the status of MS-CHAP authentication for login.
Cisco MDS 9000 Family Command Reference
2-22
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa authentication login mschapv2 enable
aaa authentication login mschapv2 enable
To enable MS-CHAPv2 authentication between the switch and authentication servers, use the aaa
authentication login mschapv2 enable command. To disable MS-CHAPv2 authentication between the
switch and authentication servers, use the no form of the command.
aaa authentication login mschapv2 enable
no aaa authentication login mschapv2 enable
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
MS-CHAPv2 cannot be configured when MS-CHAP or ASCII authentication is configured and also
when a TACACS group is configured for authentication.
Examples
The following example shows how to enable MS-CHAPv2 authentication for login:
switch(config)# aaa authentication login mschapv2 enable
switch(config)#
Related Commands
Command
Description
show aaa
authentication login
mschapv2
Displays MS-CHAPv2 authentication for login.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-23
Chapter 2
A Commands
aaa authorization
aaa authorization
To configure authorization for a function, use the aaa authorization command. To disable authorization
for a function, use the no form of the command.
aaa authorization {commands | config-commands}{default} {{[group group-name] | [local]}
|{[group group-name] | [none]}}
no aaa authorization {commands | config-commands}{default}{{[group group-name] | [local]}
|{[group group-name] | [none]}}
Syntax Description
commands
Specifies authorization for all exec-mode commands.
config-commands
Specifies authorization for all commands under config mode L2 and L3.
default
Specifies the default methods.
group group-name
(Optional) Specifies the server group and group name..
local
(Optional) Specifies the local username authentication.
none
(Optional) Specifies no authorization.
Defaults
Authorization is disabled for all actions (equivalent to the method keyword none). If the aaa authorization
command for a particular authorization type is entered without a specifies named method list. The default
method list is automatically applied to all interfaces or lines (where this authorization type applies for except
those that have a named method list explicitly defined. A defined method list overrides the default method list
if no default method list is defined, then no authorization takes place.
Command Modes
Configuration mode
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to configure authorization for a configuration command function:
switch(config)# aaa authorization config-commands default group tac1 local
switch(config)#
The following example shows how to configure authorization for a command function:
switch(config)# aaa authorization commands default group tac1 local none
switch(config)#
Cisco MDS 9000 Family Command Reference
2-24
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa authorization
Related Commands
Command
Description
show aaa
authorization all
Displays all authorization information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-25
Chapter 2
A Commands
aaa authorization ssh-certificate
aaa authorization ssh-certificate
To configure SSH certificate authorization, use the aaa authorization ssh-certificate command. To
disable this feature, use the no form of the command.
aaa authorization ssh-certificate default [group | local]
Syntax Description
default
Specifies default SSH methods.
group
Specifies server groups.
local
Specifies local user name authentication.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
NX-OS 5.0(1)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to use local user name authentication:
switch(config)# aaa authorization ssh-certificate default local
switch(config)#
The following example shows how to specify server groups:
switch(config)# aaa authorization ssh-certificate default group ldap1
switch#
Related Commands
Command
Description
show aaa
authorization all
Displays all authorization information.
Cisco MDS 9000 Family Command Reference
2-26
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa authorization ssh-publickey
aaa authorization ssh-publickey
To configure SSH public key authorization, use the aaa authorization ssh-publickey command. To
disable this feature, use the no form of the command.
aaa authorization ssh-publickey default [group | local]
no aaa authorization ssh-publickey default [group | local]
Syntax Description
default
Specifies default SSH methods.
group
(Optional) Specifies server groups.
local
(Optional) Specifies local user name authentication.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
NX-OS 5.0(1)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to use local user name authentication:
switch(config)# aaa authorization ssh-publickey default local
switch(config)#
The following example shows how to specify server groups:
switch(config)# aaa authorization ssh-publickey default group ldap1
switch#
Command
Description
show aaa
authorization all
Displays all authorization information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-27
Chapter 2
A Commands
aaa group server
aaa group server
To configure one or more independent server groups, use the aaa group server command in
configuration mode. To remove the server group, use the no form of this command to remove the server
group.
aaa group server {radius | tacacs+ | ldap} group-name server server-name no server server-name
no aaa group server {radius | tacacs+ | ldap} group-name server server-name
Syntax Description
radius
Specifies the RADIUS server group.
tacacs+
Specifies the TACACS+ server group.
ldap
Specifies LDAP server group name.
group-name
Identifies the specified group of servers with a user-defined name. The name
is limited to 64 alphanumeric characters.
no server server-name
Specifies the server name to add or remove from the server group.
Defaults
None
Command Modes
Sub configuration mode
Command History
Release
Modification
NX-OS 5.0(1)
Added ldap keyword to the syntax description.
1.3(1)
This command was introduced.
Usage Guidelines
You can configure these server groups at any time but they only take effect when you apply them to a
AAA service using the aaa authentication login or the aaa accounting commands.
LDAP groups cannot be used for AAA accounting commands.
Examples
The following example shows how to configure LDAP server group name:
switch(config)# aaa group server ldap a
switch(config-ldap)#
switch# config terminal
switch(config)# aaa group server tacacs+ TacacsServer1
switch(config-tacacs+)# server ServerA
switch(config-tacacs+)# exit
switch(config)# aaa group server radius RadiusServer19
switch(config-radius)# server ServerB
switch(config-radius)# no server ServerZ
Cisco MDS 9000 Family Command Reference
2-28
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
aaa group server
Related
Commands
Command
Description
show aaa groups
Displays all configured server groups.
show radius-server groups
Displays configured RADIUS server groups.
show tacacs-server groups
Displays configured TACACS server groups.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-29
Chapter 2
A Commands
abort
abort
To discard a Call Home configuration session in progress, use the abort command in Call Home
configuration submode.
abort
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
Call Home configuration submode
Command History
Release
Modification
2.0(1b)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to discard a Call Home configuration session in progress:
switch# config terminal
Enter configuration commands, one per line.
switch(config)# callhome
switch(config-callhome)# abort
Related Commands
End with CNTL/Z.
Command
Description
callhome
Configures the Call Home function.
callhome test
Sends a dummy test message to the configured destination.
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
2-30
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
action cli
action cli
To configure a VSH command string to be executed when an Embedded Event Manager (EEM) applet is
triggered, use the action cli command. To disable the VSH command string, use the no form of the
command.
action number [.number2] cli command1 [command2...] [local]
no action number [.number2] cli command1 [command2...] [local]
Syntax Description
number
Number can be any number up to 16 digits. The range for number2 is from
0 to 9.
local
(Optional) Specifies the action that is to be executed in the same module on
which the event occurs.
Defaults
None.
Command Modes
Embedded Event Manager mode
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to configure a CLI command:
switch# configure terminal
switch(config)# event manager applet cli-applet
switch(config-applet)# action 1.0 cli “show interface e 3/1“
switch(config-applet)#
Related Commands
Command
Description
event manager applet
Displays an applet with the Embedded Event Manager.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-31
Chapter 2
A Commands
action counter
action counter
To specify a setting or modify a named counter when an Embedded Event Manager (EEM) applet is triggered,
use the action counter command. To restore the default value to the counter, use the no form of the
command.
action number [.number2] counter name counter value val op {dec | inc | nop | set}
no action number [.number2] counter name counter value val op {dec | inc | nop | set}
Syntax Description
number .number2
Number can be any number up to 16 digits. The range for number2 is from
0 to 9.
name name
The counter name can be any case-sensitive, alphanumeric string up to 32
characters.
value val
Specifies the value of the counter. The value can be an integer from 0 to
2147483647 or a substituted parameter.
op {dec | inc | nop | set} The following operations can be performed:
• dec—Decrement the counter by the specified value.
• inc—Increment the counter by the specified value.
• nop—Only print the specified value.
• set—Set the counter to the specified value.
Defaults
None
Command Modes
Embedded Event Manager mode
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to set or modify the counter when the EEM counter applet is
triggered:
switch# configure terminal
switch(config)# event manager applet counter-applet
switch(config-applet)# action 2.0 counter name mycounter value 20 op
switch(config-applet)#
Cisco MDS 9000 Family Command Reference
2-32
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
action counter
Related Commands
Command
Description
event manager applet
Displays an applet with the Embedded Event Manager.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-33
Chapter 2
A Commands
action event-default
action event-default
To execute the default action for the associated event, use the action event-default command. To disable
the default action, use the no form of the command.
action number [.number2] event-default
no action number [.number2] event-default
Syntax Description
number . number2
Defaults
None
Command Modes
Embedded Event Manager mode
Command History
Release
Modification
NX-OS 4.2(1)
Added a note.
NX-OS 4.1(3)
This command was introduced.
Number can be any number up to 16 digits. The range for number2 is from
0 to 9.
Usage Guidelines
If you want to allow the triggered event to process any default actions, you must configure the EEM
policy to allow the event default action statement. For example, if you match a CLI command in a match
statement, you must add the event-default action statement to the EEM policy or EEM will not allow the
CLI command to execute.
Examples
The following example shows how to specify that the default action of the event be performed when an
EEM applet is triggered:
switch# configure terminal
switch(config)# event manager applet default-applet
switch(config-applet)# action 1.0 event-default
switch(config-applet)#
Related Commands
Command
Description
event manager applet
Displays an applet with the Embedded Event Manager.
Cisco MDS 9000 Family Command Reference
2-34
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
action exception log
action exception log
To log an exception if the specific conditions are encountered when an Embedded Event Manager (EEM)
applet is triggered, use the action exception log command.
action number [.number2] exception log module module syserr error devid id errtype type
errcode code phylayer layer ports list harderror error [desc string]
Syntax Description
number .number2
Number can be any number up to 16 digits. The range for number2 is from
0 to 9.
module module
Records an exception for the specified module. Enter a module word.
syserr error
Records an exception for the specified system error. Enter an error word.
devid id
Records an exception for the specified device ID. Enter an ID word.
errtype type
Records an exception for the specified error type. Enter a type word.
errcode code
Records an exception for the specified error code. Enter a code word.
phylayer layer
Records an exception for the specified physical layer. Enter a layer word.
ports list
Records an exception for the specified ports. Enter a list word.
harderror error
The reset reason is a quoted alphanumeric string up to 80 characters.
desc string
(Optional) Describes the exception logging condition.
Defaults
None
Command Modes
Embedded Event Manager mode
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to log an EEM applet exception:
switch# configure terminal
switch(config)# event manager applet exception-applet
switch(config-applet)# action 1.42 exceptionlog module 1 syserr 13 devid 1 errtype fatal
errcode 13 phylayer 2 ports 1-42 harderror 13 desc “fatal exception logging”
switch(config-applet)#
Related Commands
Command
Description
event manager applet
Displays an applet with the Embedded Event Manager.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-35
Chapter 2
A Commands
action forceshut
action forceshut
To configure a forced shutdown of a module, a crossbar, ASCII, or the entire switch when an Embedded
Event Manager (EEM) applet is triggered, use the action forceshut command.
action number [.number2] forceshut [module slot | xbar xbar-number] reset-reason string
Syntax Description
number .number2
Number can be any number up to 16 digits. The range for number2 is from
0 to 9.
module slot
(Optional) Specifies slot range. The range is from 1 to 10, or a substituted
parameter.
xbar xbar-number
(Optional) Specifies an xbar number. The range is from 1 to 4 or a
substituted parameter.
reset-reason string
Specifies reset reason. The reason is an alphanumeric string up to 80
characters.
Defaults
None
Command Modes
Embedded Event Manager mode
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to log an EEM applet exception:
switch# configure terminal
switch(config)# event manager applet exception-applet
switch(config-applet)# action 1.0 forceshut module 2 reset-reason “flapping links”
switch(config-applet)#
Related Commands
Command
Description
event manager applet
Displays an applet with the Embedded Event Manager.
Cisco MDS 9000 Family Command Reference
2-36
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
action overbudgetshut
action overbudgetshut
To configure the shutdown of a module or the entire switch due to an overbudget power condition when
an Embedded Event Manager (EEM) applet is triggered, use the action overbudgetshut command.
action number [.number2] overbudgetshut [module slot [- slot]]
Syntax Description
number .number2
Number can be any number up to 16 digits. The range for number2 is from
0 to 9.
module slot -slot
(Optional) Specifies the slot range:
•
For 6slot the range is from 1 to 6.
•
For 9slot the range is from 1 to 9.
•
For 13slot the range is from 1 to 13.
Defaults
None
Command Modes
Embedded Event Manager
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to configure a power overbudget shutdown of module 3-5 when an
EEM applet is triggered:
switch# configure terminal
switch(config)# event manager applet overbudget-applet
switch(config-applet)# action 1.0 overbudgetshut module 3-5
switch(config-applet)#
Related Commands
Command
Description
event manager applet
Displays an applet with the Embedded Event Manager.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-37
Chapter 2
A Commands
action policy-default
action policy-default
To enable the default actions of the policy being overridden, use the action policy-default command.
action number [.number2] policy-default
Syntax Description
number .number2
Defaults
None
Command Modes
Embedded Event Manager mode
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Number can be any number up to 16 digits. The range for number2 is from
0 to 9.
Usage Guidelines
None
Examples
The following example shows how to enable the default action of a policy being overridden when an
EEM applet is triggered:
switch# configure terminal
switch(config)# event manager applet default-applet
switch(config-applet)# action 1.0 policy-default
switch(config-applet)#
Related Commands
Command
Description
event manager applet
Displays an applet with the Embedded Event Manager.
Cisco MDS 9000 Family Command Reference
2-38
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
action reload
action reload
To configure the reloading or to reload the switch software when an Embedded Event Manager (EEM)
applet is triggered, use the action reload command. To remove the software reload configuration, use
the no form of this command.
action number [.number2] reload [module slot [- slot]]
Syntax Description
number .number2
Number can be any number up to 16 digits. The range for number2 is from
0 to 9.
module slot -slot
(Optional) Specifies the slot range. The range is from 1 to 10, or a
substituted parameter.
Defaults
None
Command Modes
Embedded Event Manager mode
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to enable the default action of a policy being overridden when an
EEM applet is triggered:
switch# configure terminal
switch(config)# event manager applet default-applet
switch(config-applet)# action 1.0 policy-default
switch(config-applet)#
Related Commands
Command
Description
event manager applet
Displays an applet with the Embedded Event Manager.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-39
Chapter 2
A Commands
add-session vsan
add-session vsan
To add sessions to a job, use the add-session vsan command in configuration mode.
add-session vsan vsan-id pwwn tgt-pwwn all-luns | lun lun-id algorithm name/id
Syntax Description
vsan-id
Specifies the VSAN ID of the target.
pwwn tgt-pwwn
Specifies the pWWN of the target.
all-luns
Specifies all of the LUNs in the Secure Erase session.
lun lun-id
Specifies the LUN ID of the Secure Erase session.
algorithm name/id
Specifies the algorithm that should be used for the session.
Defaults
None
Command Modes
Configuration Secure Erase job submode
Command History
Release
Modification
6.2(1)
This command was deprecated.
3.3(1a)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to add a VI to a specific Secure Erase job:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# secure-erase module 2 job 1
switch(config-se-job)# add-session vsan 1 pwwn 20:04:00:a0:b8:16:92:18 all-luns algorithm
RCMP
Related Commands
Command
Description
add-session job
Adds sessions to the job.
Cisco MDS 9000 Family Command Reference
2-40
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
add-step dynamic
add-step dynamic
To add a dynamic pattern step to a specific algorithm, use the add-step dynamic command in
configuration mode.
add-step dynamic [0 | 1]
Syntax Description
0
(Optional) Specifies that the pattern is generated using a random number
generator.
1
(Optional) Specifies that the pattern is complimentary to the previous
pattern.
Defaults
None
Command Modes
Configuration Secure Erase algorithm submode
Command History
Release
Modification
6.2(1)
This command was deprecated.
3.3(1a)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to add a dynamic pattern step to a specific algorithm:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# secure-erase module 2 algorithm 0
switch(config-se-algo)#
switch(config-se-algo)# add-step dynamic 0
Related Commands
Command
Description
add-step static
Adds static pattern step to a specific algorithm.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-41
Chapter 2
A Commands
add-step static
add-step static
To add a static pattern step to a specific algorithm, use the add-step static command in configuration
mode.
add-step static pattern
Syntax Description
pattern
Defaults
None
Command Modes
Configuration Secure Erase algorithm submode
Command History
Release
Modification
6.2(1)
This command was deprecated.
3.3(1a)
This command was introduced.
Specifies the static pattern step. The pattern is to write ranges from 1 to 512
bytes and can consist of only characters 0 to 9 and A to F.
Usage Guidelines
None
Examples
The following example shows how to add a static step to a specific algorithm:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# secure-erase module 2 algorithm 0
switch(config-se-algo)#
switch(config-se-algo)# add-step static 1
Related Commands
Command
Description
add-step dynamic
Adds a dynamic pattern step to a specific algorithm.
Cisco MDS 9000 Family Command Reference
2-42
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
add-tgt vsan
add-tgt vsan
To define target enclosure and add multiple target ports for a specific Secure Erase job, use the add-tgt
vsan command in configuration mode.
add-tgt vsan vsan-id pwwn target port pwwn
Syntax Description
vsan-id
Specifies the VSAN ID of the target port added to a Secure Erase job.
pwwn target port pwwn Specifies the port world-wide name (pWWN) of the target port.
Defaults
None
Command Modes
Configuration Secure Erase job submode
Command History
Release
Modification
6.2(1)
This command was deprecated.
3.3(1a)
This command was introduced.
Usage Guidelines
Note
Examples
The target ports added to a specific job can be part of a different VSAN. The Secure Erase application
creates VIs in a specific VSAN.
VIs and targets from different VSANs can be added to a job. A storage array may have multiple storage
ports belonging to a different VSAN. You can create one job for one storage array.
The following example shows how to define a target enclosure and add multiple target ports for a specific
Secure Erase job:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# secure-erase module 2 job 1
switch(config-se-job)# add-tgt vsan 1 pwwn 20:04:00:a0:b8:16:92:18
Related Commands
Command
Description
add-session vsans
Adds sessions to a job.
add-VI job
Adds a VI to a specific Secure Erase job.
secure-erase create job Creates a Secure Erase job.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-43
Chapter 2
A Commands
add-vi vsan
add-vi vsan
To add a VI to a specific Secure Erase job, use the add-vi vsan command in configuration mode.
add-vi vsan vsan-id all | pwwn VI pwwn
Syntax Description
vsan-id
Specifies the VSAN ID of the target where a VI exists.
all
Adds all the VSAN IDs of the target.
pwwn VI pwwn
Adds a specific VI in a given VSAN to the job.
Defaults
None
Command Modes
Configuration Secure Erase job submode
Command History
Release
Modification
6.2(1)
This command was deprecated.
3.3(1a)
This command was introduced.
Usage Guidelines
You must add at least one VI in each VSAN where a Secure Erase target is present.
All VIs that are part of the same job and the VSAN must have same target view. The same set of targets
and LUNs must be exposed for all VIs in the same VSAN.
Note
Examples
VI-CPP can not be added to a job. To know the WWN of the VI-CPP, please run the show isapi
virtual-nport database command on SSM module.
The following example shows how to add all VIs to a given Secure Erase job:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# secure-erase module 2 job 1
switch(config-se-job)# add-vi vsan 1 all
The following example shows how to add a VI to a given Secure Erase job:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# secure-erase module 2 job 1
switch(config-se-job)# add-vi vsan 1 pwwn 2c:0d:00:05:30:00:43:64
Cisco MDS 9000 Family Command Reference
2-44
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
add-vi vsan
Related Commands
Command
Description
add-session job
Adds sessions to the job.
add-VI job
Adds a VI to a specific Secure Erase job.
secure-erase create job Creates a Secure Erase job.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-45
Chapter 2
A Commands
action snmp-trap
action snmp-trap
To specify the generation of a Simple Network Management Protocol (SNMP) trap when an Embedded
Event Manager (EEM) applet is triggered, use the action snmp-trap command. To disable the SNMP
trap, use the no form of this command.
action number[.number2] snmp-trap {[intdata1 integer [intdata2 integer] [strdata string]]}
no action number[.number2] snmp-trap {[intdata1 integer [intdata2 integer] [strdata string]]}
Syntax Description
number .number2
Number can be any number up to 16 digits. The range for number2 is from
0 to 9.
intdata1 integer
(Optional) Specifies an integer to be sent in the SNMP trap message to the
SNMP agent.
intdata2 integer
(Optional) Specifies a second integer to be sent in the SNMP trap message
to the SNMP agent.
strdata string
(Optional) Specifies a string to be sent in the SNMP trap message to the
SNMP agent. If the string contains embedded blanks, enclose it in double
quotation marks.
Defaults
None
Command Modes
Embedded Event Manager mode.
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to specify an SNMP trap to generate when an EEM applet is
triggered:
switch# configure terminal
switch(config)# event manager applet snmp-applet
switch(config-applet)# action 1.0 snmp-trap strdata “temperature problem”
switch(config-applet)#
Related Commands
Command
Description
event manager applet
Displays an applet with the Embedded Event Manager.
Cisco MDS 9000 Family Command Reference
2-46
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
action syslog
action syslog
To configure a syslog message to generate when an Embedded Event Manager (EEM) applet is triggered,
use the action syslog command. To disable the syslog message, use the no form of this command.
action number[.number2] syslog [priority prio-val] msg error-message
no action number[.number2] syslog [priority prio-val] msg error-message
Syntax Description
number
Number can be any number up to 16 digits. The range for number2 is from
0 to 9.
priority prio-val
(Optional) Specifies the priority level of the syslog messages. If this
keyword is not selected, all syslog messages are set at the informational
priority level. If this keyword is selected, the priority level argument must
be defined. There are three ways of defining the priority level:
•
Define the priority level using one of these methods:
– 0—System is unusable.
– 1—Immediate action is needed.
– 2—Critical conditions.
– 3—Error conditions.
– 4—Warning conditions.
– 5—Normal but significant conditions.
– 6—Informational messages. This is the default.
– 7—Debugging messages.
•
Enter the priority by selecting one of the priority keywords:
–emergencies—System is unusable.
– alerts—Immediate action is needed.
– critical—Critical conditions.
– errors—Error conditions.
– warnings—Warning conditions.
– notifications—Normal but significant conditions.
– informational—Informational messages. This is the default.
– debugging—Debugging messages.
msg error message
Specifies the error message. The message can be any quoted alphanumeric
string up to 80 characters.
Defaults
None
Command Modes
Embedded Event Manager mode
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-47
Chapter 2
A Commands
action syslog
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to configure a syslog message to save when an EEM applet is
triggered:
switch# configure terminal
switch(config)# event manager applet syslog-applet
switch(config-applet)# action 1.0 syslog priority notifications msg “cpu high”
switch(config-applet)#
Related Commands
Command
Description
event manager applet
Displays an applet with the Embedded Event Manager.
Cisco MDS 9000 Family Command Reference
2-48
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
active equals saved
active equals saved
To automatically write any changes to the block, prohibit or port an address name to the IPL file, use the
active equals saved command. To disable the configuration or to revert to factory defaults, use the no
form of the command.
active equals saved
no active equals saved
Syntax Description
This command has no other arguments or keywords.
Defaults
Disabled.
Enabled (when a FICON VSAN is configured).
Command Modes
FICON configuration submode
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
Enabling active equals saved ensures that you do not have to perform the copy running-config
startup-config command to save the FICON configuration as well as the running configuration. If your
switch or fabric consists of multiple FICON-enabled VSANs, and one of these VSANs has active equals
saved enabled, changes made to the non-FICON configuration causes all FICON-enabled configurations
to be saved to the IPL file.
The following example enables the automatic save feature for a VSAN:
switch(config)# ficon vsan 2
switch(config-ficon)# active equals saved
The following example disables the automatic save feature for this VSAN:
switch(config-ficon)# no active equals saved
Related Commands
Command
Description
copy running-config startup-config Saves the running configuration to the startup configuration.
ficon vsan
Enables FICON on the specified VSAN.
show ficon
Displays configured FICON details.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-49
Chapter 2
A Commands
alert-group
alert-group
To customize a Call Home alert group with user-defined show commands, use the alert-group command
in Call Home configuration submode. To remove the customization, user the no form of the command.
alert-group event-type user-def-cmd command
no alert-group event-type user-def-cmd command
Syntax DescriptionT
event-type
Specifies event types by the following alert groups.
Avanti
Displays Avanti events.
Environmental
Displays power, fan, and temperature related events.
Inventory
Displays inventory status events.
License
Displays events related to licensing.
RMON
Displays events related to Remote Monitoring (RMON).
Supervisor-Hardware
Displays supervisor related events.
Syslog-group-port
Displays events relate to syslog messages filed by the the port manager.
System
Displays software related events.
test
Displays user-generated test events.
user-def-cmd command Configures a CLI command for an alert-group. The maximum size is 512.
Defaults
None
Command Modes
Call Home configuration submode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Note
Examples
The user-def-cmd argument allows you to define a command whose outputs should be attached to the
Call Home message being sent. Only show commands can be specified and they must be associated with
an alert group. Five commands can be specified per alert group. Invalid commands are rejected.
Make sure the destination profiles for the non-Cisco-TAC alert group, with a predefined show command,
and the Cisco-TAC alert group are not the same.
The following example configures a user-defined command, called show license usage, for an alert
group license:
switch(config-callhome)# alert-group license user-def-cmd "show license usage"
Cisco MDS 9000 Family Command Reference
2-50
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
alert-group
The following example removes a user-defined command, called show license usage, for an alert group
license:
switch(config-callhome)# no alert-group license user-def-cmd "show license usage"
Related Commands
Command
Description
callhome
Configures the Call Home function.
callhome test
Sends a dummy test message to the configured destination(s).
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-51
Chapter 2
A Commands
arp
arp
To enable the Address Resolution Protocol (ARP) for the switch, use the arp command.To disable ARP
for the switch, use the no form of the command.
arp hostname
no arp hostname
Syntax Description
hostname
Defaults
Enabled
Command Modes
Configuration mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Specifies the name of the host. Maximum length is 20 characters.
Usage Guidelines
None.
Examples
The following example disables the Address Resolution Protocol configured for the host with the IP
address 10.1.1.1:
switch(config)# no arp 10.1.1.1
switch(config)#
Related Commands
Command
Description
clear arp
Deletes a specific entry or all entries from the ARP table.
show arp
Displays the ARP table.
Cisco MDS 9000 Family Command Reference
2-52
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
attach
attach
To connect to a specific module, use the attach command in EXEC mode.
attach module slot-number
Syntax Description
module slot-number
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Specifies the slot number of the module.
You can use the attach module command to view the standby supervisor module information, but you
cannot configure the standby supervisor module using this command.
You can also use the attach module command on the switching module portion of the Cisco MDS 9216
supervisor module, which resides in slot 1 of this two-slot switch.
To disconnect, use the exit command at the module-number# prompt, or type $. to forcibly abort the attach
session.
Examples
The following example connects to the module in slot 2. Note that after you connect to the image on the
module using the attach module command, the prompt changes to module-number#:
switch# attach module 1
Attaching to module 1 ...
To exit type 'exit', to abort type '$.'
module-1# exit
switch#
Related Commands
Command
Description
exit
Disconnects from the module.
show module
Displays the status of a module.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-53
Chapter 2
A Commands
attachpriv
attachpriv
To connect to a specific ILC line card as a privilege, use the attachpriv command in EXEC mode.
attachpriv module slot-number
Syntax Description
module slot-number
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.1(3)
This command was introduced.
Specifies the slot number of the module.
Usage Guidelines
None
Examples
The following example shows how to connect to a specific ILC line card as a privilege:
switch# attachpriv module 1
Attaching to module 1 ...
To exit type 'exit', to abort type '$.'
module-1# exit
Related Commands
Command
Description
exit
Disconnects from the module.
show module
Displays the status of a module.
Cisco MDS 9000 Family Command Reference
2-54
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
attributes (DMM job configuration submode)
attributes (DMM job configuration submode)
To set the attributes of a data migration job, use the attributes command in DMM job configuration
submode. To remove the attributes of a data migration job, use the no form of the command.
attributes job_type {1 | 2} job_mode {1 | 2} job_rate {1 | 2 | 3 | 4} job_method {1|2}
no attributes job_type {1 | 2} job_mode {1 | 2} job_rate {1 | 2 | 3 | 4} job_method {1|2}
Syntax Description
job_type 1 | 2
Specifies the job type. Specify 1 for a server type job and 2 for a storage type
job.
job_mode 1 | 2
Specifies the job mode. Specify 1 for an online job and 2 for an offline job.
job_rate 1 | 2 | 3 | 4
Specifies the job rate. Specify 1 for the default rate, 2 for a slow rate, 3 for a
medium rate, and 4 for a fast rate.
job_method 1|2
Specifies the job method. Specify 1 for Method 1 and 2 for Method 2.
Defaults
None
Command Modes
DMM job configuration submode
Command History
Release
Modification
3.3(1a)
This command was introduced.
Usage Guidelines
Examples
None
The following example sets the job type to storage, the job mode to online, and the job rate to fast:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# dmm module 3 job 1 create
Started New DMM Job Configuration.
Do not exit sub-mode until configuration is complete and committed
switch(config-dmm-job)# attributes job_type 2 job_mode 1 job_rate 4 job_method 1
switch(config-dmm-job)#
Related Commands
Command
Description
show dmm job
Displays job information.
show dmm srvr-vt-login
Displays server VT login information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-55
Chapter 2
A Commands
attribute failover auto
attribute failover auto
To configure an automatic fallback failover for a virtual device, use the attribute failover auto
command. To revert to the default, use the no form of the command.
attribute failover auto [fallback]
no attribute failover auto [fallback]
Syntax Description
fallback
Defaults
Disabled
Command Modes
Virtual device submode
Command History
Release
Modification
NX-OS 4.1(1b)
This command was introduced.
(Optional) Enables a switchback with an automatic failover.
Usage Guidelines
None
Examples
The following example shows how to configure an automatic failover for a specific virtual device:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# sdv virtual-device name vdev1 vsan 1
switch#(config-sdv-virt-dev)# attribute failover auto
switch#(config-sdv-virt-dev)#
The following example shows how to configure an attribute of a virtual device:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# sdv virtual-device name vdev1 vsan 1
switch#(config-sdv-virt-dev)# attribute failover auto fallback
switch(config-sdv-virt-dev)#
Cisco MDS 9000 Family Command Reference
2-56
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
attribute qos
attribute qos
To configure a QoS attribute, use the attribute qos command in Inter-VSAN Routing (IVR) zone
configuration submode. To disable this feature, use the no form of this command.
attribute qos {high | low | medium}
no attribute qos {high | low | medium}
Syntax Description
high
Configures frames matching zone to get high priority.
low
Configures frames matching zone to get low priority (default).
medium
Configures frames matching zone to get medium priority.
Defaults
Disabled
Command Modes
IVR zone configuration submode
Command History
Release
Modification
2.1(1a)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to configure an IVR zone QoS attribute to low priority:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# ivr zone name IvrZone
switch(config-ivr-zone)# attribute qos priority low
Related Commands
Command
Description
show ivr zone
Displays IVR zone configuration.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-57
Chapter 2
A Commands
authentication
authentication
To change the authentication behavior, use the authentication command. To disable this feature, use the
no form of the command.
authentication {compare [password-attribute password-attribute] | bind-first
[append-with-baseDN string]}
no authentication {compare [password-attribute password-attribute] | bind-first
[append-with-baseDN string]}
Syntax Description
Defaults
compare
Specifies the compare option to be used for authentication.
password-attribute
password-attribute
(Optional) Overides the default password attribute.The maximum length is
128 characters.
bind-first
Specifies that the client use bind and search instead of search and bind.
append-with-baseDN
string
(Optional) Overrides the default string appended with baseDN.
userPassword.
append-with-baseDN default value is (cn=$userid).
Command Modes
Configuration submode
Command History
Release
Modification
NX-OS 5.0(1)
This command was introduced.
Usage Guidelines
The password-attribute keyword provdes a method for chaning the attribute type of password.
Examples
The following example shows how to change the default attribute:
switch(config-ldap)# authentication compare password-attribute 1
switch(config-ldap)#
Related Commandss
Command
Description
show aaa
authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
2-58
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
authentication (IKE policy configuration submode)
authentication (IKE policy configuration submode)
To configure the authentication method for an IKE protocol policy, use the authentication command in
IKE policy configuration submode. To revert to the default authentication method, use the no form of
the command.
authentication {pre-share | rsa-sig}
no authentication {pre-share | rsa-sig}
Syntax Description
pre-share
Configures the preshared key as the authentication method.
rsa-sig
Configures RSA signatures as the authentication method.
Defaults
Preshared key.
Command Modes
IKE policy configuration submode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
To use this command, enable the IKE protocol using the crypto ike enable command. In addition, you
must configure the identity authentication mode using the fully qualified domain name (FQDN) before
you can use RSA signatures for authentication. Use the identity hostname command for this purpose.
Examples
The following example shows how to configure the authentication method using the preshared key:
switch# config terminal
switch(config)# crypto ike domain ipsec
switch(config-ike-ipsec)# policy 1
switch(config-ike-ipsec-policy)# authentication pre-share
The following example shows how to configure the authentication method using the RSA signatures:
switch(config-ike-ipsec-policy)# authentication rsa-sig
The following example shows how to revert to the default authentication method (preshared key):
switch(config-ike-ipsec-policy)# no authentication rsa-sig
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-59
Chapter 2
A Commands
authentication (IKE policy configuration submode)
Related Commands
Command
Description
crypto ike domain ipsec
Enters IKE configuration mode.
crypto ike enable
Enables the IKE protocol.
identity hostname
Configures the identity for the IKE protocol.
show crypto ike domain ipsec
Displays IKE information for the IPsec domain.
Cisco MDS 9000 Family Command Reference
2-60
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
auth-mechanism plain
auth-mechanism plain
To set the authentication mechanism as plain, use the auth-mechanism plain command in configuration
mode. To disable this feature, use the no form of the command.
auth-mechanism plain
no auth-mechanism plain
Syntax Description
This command has no arguments or keywords.
Defaults
Plain.
Command Modes
Configuration mode
Command History
Release
Modification
NX-OS 5.0(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to set the authentication mechanism as plain:
switch(config-ldap)# auth-mechanism plain
switch(config-ldap)#
Related Commandss
Command
Description
show ldap-server
groups
Displays the configured LDAP server groups.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-61
Chapter 2
A Commands
autonomous-fabric-id (IVR topology database configuration)
autonomous-fabric-id (IVR topology database configuration)
To configure an autonomous fabric ID (AFID) into the Inter-VSAN Routing (IVR) topology database,
use the autonomous-fabric-id command. To remove the fabric ID, use the no form of the command.
autonomous-fabric-id fabric-id switch-wwn swwn vsan-ranges vsan-id
no autonomous-fabric-id fabric-id switch-wwn swwn vsan-ranges vsan-id
Syntax Description
fabric-id
Specifies the fabric ID for the IVR topology.
Note
For Cisco MDS SAN-OS images prior to Release 2.1(1a), the
fabric-id value is limited to 1. For Releases 2.1(1a) and later
images, the fabric-id range is 1 to 64.
switch-wwn swwn
Configures the switch WWN in dotted hex format.
vsan-ranges vsan-id
Configures up to five ranges of VSANs to be added to the database.
The range is 1 to 4093.
Defaults
None
Command Modes
IVR topology database configuration submode
Command History
Release
Modification
1.3(1)
This command was introduced.
2.1(1a)
Modified range for fabric-id.
Usage Guidelines
The following rules apply to configuring AFIDs to VSANs:
•
The default AFID of a VSAN is 1.
•
Each VSAN belongs to one and only one AFID.
•
A switch can be a member of multiple AFIDs.
•
AFIDs at a switch must not share any VSAN identifier (for example, a VSAN at a switch can belong
to only one AFID).
•
A VSAN identifier can be reused in different AFIDs, without merging the VSANs, as long as those
AFIDs do not share a switch.
You can have up to 64 VSANs (or 128 VSANs for Cisco MDS SAN-OS Release 2.1(1a) or later) in an
IVR topology. Specify the IVR topology using the following information:
•
The switch WWNs of the IVR-enabled switches.
•
A minimum of two VSANs to which the IVR-enabled switch belongs.
Cisco MDS 9000 Family Command Reference
2-62
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
autonomous-fabric-id (IVR topology database configuration)
•
Note
Examples
The autonomous fabric ID (AFID), which distinguishes two VSANs that are logically and physically
separate, but have the same VSAN number. Cisco MDS SAN-OS Release 1.3(1) and NX-OS
Release 4.1(1b) supports only one default AFID (AFID 1) and does not support non-unique VSAN
IDs in the network. As of Cisco MDS SAN-OS Release 2.1(1a), you can specify up to 64 AFIDs.
Two VSANs with the same VSAN number but different fabric IDs are counted as two VSANs out of the
128 total VSANs allowed in the fabric.
The following command enters the configuration mode, enables the IVR feature, enters the VSAN
topology database, and configures the pWWN-VSAN association for VSANs 2 and 2000:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# ivr enable
switch(config)# ivr vsan-topology database
switch(config-ivr-topology-db)# autonomous-fabric-id 1 switch 20:00:00:00:30:00:3c:5e
vsan-ranges 2,2000
Related Commands
Command
Description
ivr enable
Enables the Inter-VSAN Routing (IVR) feature.
ivr vsan-topology database
Configures a VSAN topology database.
show autonomous-fabric-id database
Displays the contents of the AFID database.
show ivr
Displays IVR feature information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-63
Chapter 2
A Commands
autonomous-fabric-id (IVR service group configuration)
autonomous-fabric-id (IVR service group configuration)
To configure an autonomous fabric ID (AFID) into an IVR service group, use the autonomous-fabric-id
command in IVR service group configuration submode. To remove the autonomous fabric ID, use the no
form of the command.
autonomous-fabric-id afid vsan-ranges vsan-id
no autonomous-fabric-id afid vsan-ranges vsan-id
Syntax Description
afid
Specifies the AFID to the local VSAN.
vsan-ranges vsan-id
Configures up to five ranges of VSANs to be added to the service
group. The range is 1 to 4093.
Defaults
None
Command Modes
IVR service group configuration submode
Command History
Release
Modification
2.1
This command was introduced.
Usage Guidelines
Before configuring an IVR service group, you must enable the following:
•
IVR using the ivr enable command
•
IVR distribution using the ivr distribute command
•
Automatic IVR topology discovery using the ivr vsan-topology auto command
To change to IVR service group configuration submode, use the ivr service-group activate command.
Examples
The following command enters the IVR service group configuration submode and configures AFID 10
to be in IVR service group serviceGroup1:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# ivr enable
switch(config)# ivr distribute
switch(config)# ivr vsan-topology auto
switch(config)# ivr service-group name serviceGroup1
switch(config-ivr-sg)# autonomous-fabric-id 10 vsan 1-4
Cisco MDS 9000 Family Command Reference
2-64
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
autonomous-fabric-id (IVR service group configuration)
Related Commands
Command
Description
ivr enable
Enables the Inter-VSAN Routing (IVR) feature.
ivr service-group name
Configures an IVR service group and changes to IVR
service group configuration submode.
show autonomous-fabric-id database
Displays the contents of the AFID database.
show ivr
Displays IVR feature information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-65
Chapter 2
A Commands
autonomous-fabric-id database
autonomous-fabric-id database
To configure an autonomous fabric ID (AFID) database, use the autonomous-fabric-id database
command. To remove the fabric AFID database, use the no form of the command.
autonomous-fabric-id database
no autonomous-fabric-id database
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
2.1(1a)
This command was introduced.
Usage Guidelines
Note
Examples
You must configure the IVR VSAN topology to auto mode, using the ivr vsan-topology auto command,
before you can use the autonomous-fabric-id database command to modify the database. The
autonomous-fabric-id database command also enters AFID database configuration submode.
In user-configured VSAN topology mode, the AFIDs are specified in the IVR VSAN topology
configuration itself and a separate AFID configuration is not needed.
The following example shows how to create an AFID database and enters AFID database configuration
submode:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# autonomous-fabric-id database
switch(config-afid-db)#
Related Commands
Command
Description
ivr vsan-topology auto
Configures a VSAN topology for Inter-VSAN Routing
(IVR) to auto configuration mode.
switch-wwn
Configures a switch WWN in the autonomous fabric ID
(AFID) database
show autonomous-fabric-id database
Displays the contents of the AFID database.
show ivr
Displays IVR feature information.
Cisco MDS 9000 Family Command Reference
2-66
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
A Commands
auto-volgrp
auto-volgrp
To configure the automatic volume grouping, use the auto-volgrp command. To disable this feature, use
the no form of the command.
auto-volgrp
no auto-volgrp
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Cisco SME cluster configuration submode
Command History
Release
Modification
3.2(2)
This command was introduced.
Usage Guidelines
If Cisco SME recognizes that the tape’s barcode does not belong to an existing volume group, then a new
volume group is created when automatic volume grouping is enabled.
Examples
The following example enables automatic volume grouping:
switch# config t
switch(config)# sme cluster c1
switch(config-sme-cl)# auto-volgrp
switch(config-sme-cl)#
The following example disables automatic volume grouping:
switch# config t
switch(config)# sme cluster c1
switch(config-sme-cl)# auto-volgrp
switch(config-sme-cl)#
Related Commands
Command
Description
show sme cluster
Displays Cisco SME cluster information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-67
Chapter 2
A Commands
auto-volgrp
Cisco MDS 9000 Family Command Reference
2-68
OL-29295-04, Cisco MDS NX-OS Release 6.x
CH A P T E R
2
Advanced Services Module Commands
The commands in this chapter are specific to the Advanced Services Module (ASM) used in the Cisco
MDS 9216 Switch and the Cisco MDS 9500 Series. All commands are shown here in alphabetical order
regardless of command mode.
See the “About the CLI Command Modes” section on page 1-3 to determine the appropriate mode for
each command. For more information on virtualization using the ASM, see the “Related
Documentation” section on page vi.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-1
Chapter 2
Advanced Services Module Commands
attach module—show fcdd
attach module—show fcdd
To display the Fibre Channel Device Discovery (FCDD) information, use the show fcdd command.
To connect to a ASM, use the attach module command in EXEC mode. To disconnect, use the exit
command at the module-number# prompt.
attach module slot-number
show fcdd option
Syntax Description
attach module slot-number
Attaches to the ASM module.
show fcdd
Displays FCDD information.
option
eventlog—Displays information of various state machines
history—Displays FCDD history buffer
nvp—Displays FCDD for the virtual Nx port (NVP)
pid—Displays Path Ids
rescan—Displays FCDD disk rescan information
target—Displays Disk/VM VSAN FC targets
Command Modes
EXEC (attach module mode).
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
Access the ASM using the attach module command to obtain VEC-specific configuration information
You cannot configure the ASM using this command. After you connect to the image on the module using
the attach module command, the prompt changes to module-number#.
Examples
The following example attaches to the ASM in slot 2 and exits from the ASM debug mode.
switch# attach module 2
Attaching to module 1 ...
To exit type 'exit', to abort type '$.'
module-2#
The following example displays target FCDD information for the ASM in slot 2.
module-2# show fcdd history
1) Event:E_DEBUG, length:67, at 617784 usecs after Thu Sep 18 17:55:04 2003
[103] fcdd_demux(*event=0x7ffffb90,**ret_fsm_event_list=0x7ffff920)
2) Event:E_DEBUG, length:48, at 617759 usecs after Thu Sep 18 17:55:04 2003
[103] fcdd_mts_dequeue_event(*ret_ev=0x7ffffb90)
3) Event:E_DEBUG, length:71, at 617751 usecs after Thu Sep 18 17:55:04 2003
[103] fcdd_get_data_from_queue(*q_entry=0x2d8ea000, *ret_ev=0x7ffffb90)
4) Event:E_DEBUG, length:52, at 617739 usecs after Thu Sep 18 17:55:04 2003
[103] fcdd_dequeue_event: Data Rcvd, Total ticks - 0
5) Event:E_DEBUG, length:20, at 511016 usecs after Thu Sep 18 17:54:57 2003
[103]
...
Cisco MDS 9000 Family Command Reference
2-2
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
attach module—show fcdd
module-2# show fcdd nvp vsan 3
FCDD NVP INFO:
VSAN
pWWN
FCID
LPI DPP SI
IF_INDEX
NUM_ZONE
-------------------------------------------------------------------------------3
24:0a:00:05:30:00:94:a00x650009
1
1
0x0031 0x01091000 0
ZONE_CNT
ZONE_NAME
----------------------module-2# show fcdd pid
CNT PID
MINOR VSAN TGT_WWN
LUN_ID
STATE
------------------------------------------------------------------------------0
0x0011 272
3
21:00:00:20:37:46:78:97 00:00:00:00:00:00:00:00 INV_PD
1
0x0012 288
3
21:00:00:20:37:5b:cf:b9 00:00:00:00:00:00:00:00 INV_PD
2
0x0013 304
3
21:00:00:20:37:18:6f:90 00:00:00:00:00:00:00:00 INV_PD
3
0x0014 320
3
21:00:00:20:37:36:0b:4d 00:00:00:00:00:00:00:00 INV_PD
4
0x0015 336
3
21:00:00:20:37:39:90:6a 00:00:00:00:00:00:00:00 INV_PD
5
0x0016 352
3
21:00:00:20:37:18:d2:45 00:00:00:00:00:00:00:00 INV_PD
6
0x0017 368
3
21:00:00:20:37:38:a7:c1 00:00:00:00:00:00:00:00 INV_PD
7
0x0018 384
3
21:00:00:20:37:18:17:d2 00:00:00:00:00:00:00:00 INV_PD
8
0x0019 400
4
22:00:00:20:37:46:78:97 00:00:00:00:00:00:00:00 ACTIV
9
0x001a 416
4
22:00:00:20:37:5b:cf:b9 00:00:00:00:00:00:00:00 ACTIV
10
0x001b 432
4
22:00:00:20:37:18:6f:90 00:00:00:00:00:00:00:00 ACTIV
module-2# show fcdd target vsan 3
=======================================
All existing disks in VSAN
3:
=======================================
TGT_CNT pWWN
FCID
SCSI_ID NUM_ZONE REDISC_TMR PERIOD(S) LAST_ACCESS
==========================================================================================
0
21:00:00:20:37:18:17:d2 0x7200c9 7
0
YES 600
Thu Sep 18
18:00:32 2003
LUN_NUM LUN_ID
MINOR PID
TGT_WWN
STATE
PERIOD(S)
TIMER_STARTED
-----------------------------------------------------------------------------------------0
00:00:00:00:00:00:00:00 384
0x0018 21:00:00:20:37:18:17:d2 ACTIVE
0
TGT_CNT pWWN
FCID
SCSI_ID NUM_ZONE REDISC_TMR PERIOD(S) LAST_ACCESS
==========================================================================================
1
21:00:00:20:37:18:d2:45 0x7200c5 5
0
YES 600
Thu Sep 18
18:00:32 2003
LUN_NUM LUN_ID
MINOR PID
TGT_WWN
STATE
PERIOD(S)
TIMER_STARTED
-----------------------------------------------------------------------------------------0
00:00:00:00:00:00:00:00 352
0x0016 21:00:00:20:37:18:d2:45 ACTIVE
0
TGT_CNT pWWN
FCID
SCSI_ID NUM_ZONE REDISC_TMR PERIOD(S) LAST_ACCESS
==========================================================================================
2
21:00:00:20:37:5b:cf:b9 0x7200b6 1
0
YES 600
Thu Sep 18
18:00:32 2003
...
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-3
Chapter 2
Advanced Services Module Commands
attach module—show npc
attach module—show npc
To display the virtual N port creator (NPC) information, use the show npc command.
To connect to a ASM, use the attach module command in EXEC mode. To disconnect, use the exit
command at the module-number# prompt.
attach module slot-number
show npc option
Syntax Description
attach module slot-number
Attaches to the ASM module.
show npc
Displays NPC information.
option
history — Displays NPC history buffer
nvp — Displays NPC information for the virtual N port
Command Modes
EXEC (attach module mode).
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
Access the ASM using the attach module command to obtain VEC-specific configuration information
You cannot configure the ASM using this command. After you connect to the image on the module using
the attach module command, the prompt changes to module-number#.
Examples
The following example attaches to the ASM in slot 2 and exits from the ASM debug mode.
switch# attach module 2
Attaching to module 1 ...
To exit type 'exit', to abort type '$.'
module-2#
The following example displays target FCDD information for the ASM in slot 2.
module-2# show npc history
module-2# show npc history
1) Event:E_DEBUG, length:66, at 123862 usecs after Thu Sep 18 18:24:50 2003
[103] npc_demux(*event=0x7ffffb60,**ret_fsm_event_list=0x7ffff8f0)
2) Event:E_DEBUG, length:71, at 123849 usecs after Thu Sep 18 18:24:50 2003
[105] 0x000000D0: 00 00 00 00 ...
3) Event:E_DEBUG, length:82, at 123818 usecs after Thu Sep 18 18:24:50 2003
[105] 0x000000C0: 00 00 00 0C 00 00 00 00 00 00 00 00 00 00 00 00 ...
4) Event:E_DEBUG, length:82, at 123766 usecs after Thu Sep 18 18:24:50 2003
[105] 0x000000B0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ...
5) Event:E_DEBUG, length:82, at 123714 usecs after Thu Sep 18 18:24:50 2003
[105] 0x000000A0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ...
module-2# show npc nvp
COUNT VSAN pWWN
FCID
LPI DPP SI
IF_INDEX
TCAM_TYPE
STATE
U_CNT USERS
-------------------------------------------------------------------------------
Cisco MDS 9000 Family Command Reference
2-4
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
attach module—show npc
----------------------0
2 10:00:00:00:5e:00:01:01
ESTABLISHED
1
[ 31 ]
1
2 10:00:00:05:30:00:59:20
ESTABLISHED
1
[ 31 ]
2
2 23:00:00:05:30:00:59:20
ESTABLISHED
1
[ 918 ]
3
2 23:02:00:05:30:00:59:20
ESTABLISHED
1
[ 918 ]
4
2 23:03:00:05:30:00:59:20
ESTABLISHED
1
[ 918 ]
5
2 23:04:00:05:30:00:59:20
ESTABLISHED
1
[ 918 ]
6
2 23:05:00:05:30:00:59:20
ESTABLISHED
1
[ 918 ]
7
2 23:06:00:05:30:00:59:20
ESTABLISHED
1
[ 918 ]
8
2 23:07:00:05:30:00:59:20
ESTABLISHED
1
[ 918 ]
...
0x6f0000
17
1 0x0030 0x01090000 0x0205
0x6f0002
17
1 0x0030 0x01090000 0x0205
0x6f000b
19
1 0x0032 0x01092000 0x0206
0x6f0003
18
1 0x0031 0x01091000 0x0206
0x6f0004
1
2 0x0020 0x01080000 0x0206
0x6f0005
5
3 0x0024 0x01084000 0x0206
0x6f0006
21
4 0x0034 0x01094000 0x0206
0x6f0007
25
5 0x0038 0x01098000 0x0206
0x6f0008
9
6 0x0028 0x01088000 0x0206
module-2# show npc nvp fsm 23:08:00:05:30:00:59:20 vsan 2
>>>>FSM: <NVP_23:08:00:05:30:00:59:20> has 7 logged transitions<<<<<
1) FSM:<NVP_23:08:00:05:30:00:59:20> Transition at 839998 usecs after Thu Sep 18
17:57:23 2003
Previous state: [NPC_NVP_NULL]
Triggered event: [NPC_NVP_EV_NP_CREATION_REQ]
Next state: [NPC_NVP_GET_IFINDEX]
2) FSM:<NVP_23:08:00:05:30:00:59:20> Transition at 840179 usecs after Thu Sep 18
17:57:23 2003
Previous state: [NPC_NVP_GET_IFINDEX]
Triggered event: [NPC_NVP_EV_IF_INDEX_OK]
Next state: [NPC_NVP_FVLOGI_SENT]
...
module-2# show npc nvp vsan 2
COUNT VSAN pWWN
FCID
LPI DPP SI
IF_INDEX
TCAM_TYPE
STATE
U_CNT USERS
-----------------------------------------------------------------------------------------------------0
2 10:00:00:00:5e:00:01:01 0x6f0000 17
1 0x0030 0x01090000 0x0205
ESTABLISHED
1
[ 31 ]
1
2 10:00:00:05:30:00:59:20 0x6f0002 17
1 0x0030 0x01090000 0x0205
ESTABLISHED
1
[ 31 ]
2
2 23:00:00:05:30:00:59:20 0x6f000b 19
1 0x0032 0x01092000 0x0206
ESTABLISHED
1
[ 918 ]
3
2 23:02:00:05:30:00:59:20 0x6f0003 18
1 0x0031 0x01091000 0x0206
ESTABLISHED
1
[ 918 ]
4
2 23:03:00:05:30:00:59:20 0x6f0004
1
2 0x0020 0x01080000 0x0206
ESTABLISHED
1
[ 918 ]
...
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-5
Chapter 2
Advanced Services Module Commands
attach module—show vec
attach module—show vec
To display Virtual Enclosure Client (VEC) information, use the show vec command.
To connect to a ASM, use the attach module command in EXEC mode. To disconnect, use the exit
command at the module-number# prompt.
attach module slot-number
show vec option
Syntax Description
attach module
slot-number
Attaches to the ASM module.
show vec
Displays configured VEC information.
option
asm — Displays VEC-related ASM information
dip — Displays Distributed Instantiation Protocol (DIP) information
dpp — Displays Data Path Processors (DPPs) State
dpp-hostmap — Displays DPP host maps
dpp-lunmap — Displays DPP LUN maps
error-statistics — Displays VEC error statistics
fp-port — Displays Front panel ports in the ASM
history — Displays VEC internal history buffer
host — Displays Logged in hosts
initiator-nports — Displays Disk/VM VSAN initiator N ports
login — Displays Disk/VM VSAN process logins
pid — Displays Path Ids
scsi-init — Displays SCSI initiator information
scsi-tgt — Displays SCSI target information
target — Displays Disk/VM VSAN FC targets
tp — Displays Trap Port (TP)
vep — Displays Virtual Enclosure Port (VEP)
ves — Displays Virtual Enclosure Server(s) (VES) connected to the VEC
vlun — Displays VLUNs
vlun-statistic — Displays Vlun error statistics
vmvsan-login — Displays DIOP logins
volume-owners — Displays Volume Owners
vsans — Displays VSANs seen by the VEC
xp-login — Displays logins (PLOGI/PRLI) to VEPs/TPs (xPs)
Command Modes
EXEC (attach module mode).
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
Access the ASM using the attach module command to obtain VEC-specific configuration information
You cannot configure the ASM using this command. After you connect to the image on the module using
the attach module command, the prompt changes to module-number#.
Cisco MDS 9000 Family Command Reference
2-6
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
attach module—show vec
Examples
The following example attaches to the ASM in slot 2 and exits from the ASM debug mode.
switch# attach module 2
Attaching to module 1 ...
To exit type 'exit', to abort type '$.'
module-2#
The following example displays target VEC information for the ASM in slot 2.
module-2# show vec target
vsan I dpp
here there pwwn
3 A
0 72000a 720101 21:00:00:20:37:65:1c:cb
3 A
0 72000a 7201e8 21:00:00:20:37:65:1c:e3
4 A
0 6b0009 7800ba 22:00:00:20:37:18:6f:90
3 A
0 72000a 7202ba 21:00:00:20:37:18:6f:90
4 A
0 6b0009 7800c9 22:00:00:20:37:18:17:d2
3 A
0 72000a 7202c9 21:00:00:20:37:18:17:d2
2 A
2 6f0005 6f0005 23:04:00:05:30:00:59:20
2 A
5 6f0008 6f0005 23:04:00:05:30:00:59:20
3 A
0 72000a 7201ef 21:00:00:20:37:89:ac:7f
4 A
0 6b0009 780100 50:06:04:82:bf:d0:cf:4b
4 A
0 6b0009 7800bc 22:00:00:20:37:36:0b:4d
...
target state
83995a8 PRLI_COMPLETE
839a188 PRLI_COMPLETE
83a7ce8 PRLI_COMPLETE
83a5540 PRLI_COMPLETE
83aebd0 PRLI_COMPLETE
83ad410 PRLI_COMPLETE
837de70 PRLI_COMPLETE
83866f8 PRLI_COMPLETE
839ad68 PRLI_COMPLETE
839c998 PRLI_COMPLETE
83a94a8 PRLI_COMPLETE
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-7
Chapter 2
Advanced Services Module Commands
attach module—show ves
attach module—show ves
To display Virtual Enclosure Server (VES) information, use the show ves command.
To connect to a ASM, use the attach module command in EXEC mode. To disconnect, use the exit
command at the module-number# prompt, or type $. to forcibly abort the attached session.
attach module slot-number
show ves option
Syntax Description
attach module slot-number Attaches to the ASM module.
show ves
Displays configured VES information for the ASM.
option
dg — Displays VES-related Disk Group information
diop—Displays Data-path Input Output Protocol (DIOP) information
dip — Displays Distributed Instantiation Protocol (DIP)
history — Displays VES internal history buffer
lunmap — Displays VES lunmap information
pid — Displays Path Id (PID) information
pid-evlog — Displays PID event log information
pid_vlun_sg — Displays PID/VLUN SG Table Information
scsi-tgt — Displays SCSI Target Module
sg — Displays Service Group
ve — Displays Virtual Enclosure (VE)
vec — Displays Virtual Enclosure Clients (VECs) connected to the VES
vep — Displays Virtual Enclosure Port (VEP)
vlun — Displays VLUN Table Information
vlun-counters — Displays VLUN counters
vlun-evlog — Displays VLUN event log
vsans — Displays VSANs seen by the VES
Command Modes
EXEC (attach module mode).
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
Access the ASM using the attach module command to obtain VEC -specific configuration information
You cannot configure the ASM using this command. After you connect to the image on the module using
the attach module command, the prompt changes to module-number#.
Examples
The following example attaches to the ASM in slot 2 and exits from the ASM debug mode.
switch# attach module 2
Attaching to module 1 ...
To exit type 'exit', to abort type '$.'
module-2#
Cisco MDS 9000 Family Command Reference
2-8
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
attach module—show ves
The following example displays the virtual enclosure server’s service group information for the ASM in
slot 2.
module-2# show ves sg
Virtual Enclosure Server Service Group Info
---------------------------------------------------------------------No
VR-ID
IP Address
---------------------------------------------------------------------0
0
15.0.112.2
1
1
15.0.0.10
2
2
15.0.0.11
Number of Service Groups : 3...
The following examples display DIOP information for the ASM in slot 2.
module-2# show ves diop guid
VLUN-ID
GUID
0000000000000001
c3ef7ce8-1dd1-11b2-a8de-75d21f738aa7
module-2# show ves diop stats
DIOP COUNTER
: Success
Failed
VLUN STRATEGY
: 0x00000000
0x00000000
VLUN DONE
: 0x00000000
0x00000000
DISK REMOTE STRATEGY : 0x00000000
0x00000000
DISK REMOTE DONE
: 0x00000000
0x00000000
DISK LOCAL STRATEGY : 0x00000000
0x00000000
DISK LOCAL DONE
: 0x00000000
0x00000000
module-2# show ves diop vsvo
vsan
: 2
fcid
: 0x6F000B
dpp
: 0
module-2# show ves diop xp
Hash
VSAN
FCID
pWWN
RefCnt
2
2
6F000B 2300000530005920
1
3
2
6F0007 2306000530005920
1
7
2
6F0008 2307000530005920
1
10
2
6F0003 2302000530005920
1
11
2
6F0009 2308000530005920
1
14
2
6F0004 2303000530005920
1
15
2
6F000A 2309000530005920
1
18
2
6F0005 2304000530005920
1
22
2
6F0006 2305000530005920
1
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-9
Chapter 2
Advanced Services Module Commands
attach module—show version
attach module—show version
To display version information for the ASM module, use the show version command.
To connect to a ASM, use the attach module command in EXEC mode. To disconnect, use the exit
command at the module-number# prompt, or type $. to forcibly abort the attached session.
attach module slot-number
show version
Syntax Description
This command does not have any options.
Command Modes
EXEC (attach module mode).
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
Access the ASM using the attach module command to obtain VSHA-specific configuration information
You cannot configure the ASM using this command. After you connect to the image on the module using
the attach module command, the prompt changes to module-number#.
Use the show version command to verify the integrity of the image before loading the images. This
command can be used for ASM images.
Examples
The following example attaches to the ASM in slot 2 and exits from the ASM debug mode.
switch# attach module 2
Attaching to module 1 ...
To exit type 'exit', to abort type '$.'
module-2#
The following example displays the ASM version in slot 2.
module-2# show version
Software
BIOS:
system:
version 1.0.7
version 1.2(2)
BIOS compile time:
system compile Time:
03/20/03
7/11/2003 14:00:00
Hardware
RAM 963380 kB
bootflash: 500736 blocks (block size 512b)
00:05:30:00:AC:AA uptime is 0 days 21 hours 2 minute(s) 32 second(s)
Cisco MDS 9000 Family Command Reference
2-10
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
attach module—show virt-lookup
attach module—show virt-lookup
To display virtualization lookup tables, use the show virt-lookup command.
To connect to a ASM, use the attach module command in EXEC mode. To disconnect, use the exit
command at the module-number# prompt, or type $. to forcibly abort the attached session.
attach module slot-number
show virt-lookup number [d_id | vol-cfg] [entries | masks | keys | stats]
Syntax Description
attach module slot-number Attaches to the ASM module.
show virt-lookup
Displays virtualization lookup tables.
number
Specifies one of four table instances of the virtualization engine (ranges
from 1 to 4).
d_id
Displays DID lookup information.
vol-cfg
Displays volume lookup information.
entries
Displays lookup entries.
keys
Displays lookup keys.
masks
Displays lookup masks.
stats
Displays lookup statistics.
Command Modes
EXEC (attach module mode).
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
Access the ASM using the attach module command to obtain VSHA-specific configuration information
You cannot configure the ASM using this command. After you connect to the image on the module using
the attach module command, the prompt changes to module-number#.
Examples
The following example attaches to the ASM in slot 2 and exits from the ASM debug mode.
switch# attach module 2
Attaching to module 1 ...
To exit type 'exit', to abort type '$.'
module-2#
The following example displays virtual engine 1 details for DID entries.
module-2#
INDEX
00000000
00000001
00000400
00000401
00000402
show virt-lookup 1 d-id entries
V CL EG_IDX RSVD SW_INDEX MASK
1
2
0
000 00000000 0204
1
2
1
000 00000000 0204
1
2
0
000 FFFFFFFF 0205
1
2
0
000 FFFFFFFF 0207
1
2
0
000 FFFFFFFF 0206
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-11
Chapter 2
Advanced Services Module Commands
attach module—show virt-lookup
00000403
00000404
00000405
00000406
00000407
00000408
00000409
0000040A
1
1
1
1
1
1
1
1
2
2
2
2
2
2
2
2
1
0
0
1
0
0
1
0
000
000
000
000
000
000
000
000
FFFFFFFF
FFFFFFFF
FFFFFFFF
FFFFFFFF
FFFFFFFF
FFFFFFFF
FFFFFFFF
FFFFFFFF
0206
0206
0206
0206
0206
0206
0206
0206
The following example displays volume lookup mask entries for virtualization engine 2.
module-2# show virt-lookup 2 vol-cfg masks
BLKINDEX FL V CL RESERVED RESERVED
D_ID
1
3 00000000 00000000 FFFFFF
00001C00 3F
S_ID
000000
B1
00
B0
00
IN
1
PI
3
VSAN
FFF
The following example displays statistics for volume lookup tables.
module-2# show virt-lookup 3 vol-cfg stats
TOTAL
USED USED-DPP0 USED-DPP1
8192
6
3
3
Cisco MDS 9000 Family Command Reference
2-12
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
attach module—show vsha
attach module—show vsha
To display volume server high availability (VSHA) information, use the show vsha command.
To connect to a ASM, use the attach module command in EXEC mode. To disconnect, use the exit
command at the module-number# prompt, or type $. to forcibly abort the attached session.
attach module slot-number
show vsha option
Syntax Description
attach module slot-number Attaches to the ASM module.
show vsha
Displays configured VSHA information.
option
dg-info — Displays VSHA SG-Disk_group information
sg-info — Displays VSHA SG Information
sg-log — Displays VSHA SG Event Log
Command Modes
EXEC (attach module mode).
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
Access the ASM using the attach module command to obtain VSHA-specific configuration information
You cannot configure the ASM using this command. After you connect to the image on the module using
the attach module command, the prompt changes to module-number#.
Examples
The following example attaches to the ASM in slot 2 and exits from the ASM debug mode.
switch# attach module 2
Attaching to module 1 ...
To exit type 'exit', to abort type '$.'
module-2#
The following example displays VSHA service group information for the ASM in slot 2.
module-2# show vsha sg-info
---------------------------------------------------------------------VSHA SG Table
---------------------------------------------------------------------System Variables: VmVsan=2, Real_IP=15.0.112.2
, interface_index=0x8080002
---------------------------------------------------------------------Record:0
VR_ID:1
SG_Name:sg-1
VR_IP:15.0.0.10
Node_ID:1
Record:1
VR_ID:2
SG_Name:sg-2
VR_IP:15.0.0.11
Node_ID:2
---------------------------------------------------------------------module-4# show vsha sg-info vr_id 1
---------------------------------------------------------------------VSHA SG Table
---------------------------------------------------------------------System Variables: VmVsan=2, Real_IP=18.0.0.4
, interface_index=0x8180002
Record: 0
VR_ID: 1
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-13
Chapter 2
Advanced Services Module Commands
attach module—show vsha
SG_Name: sg1
VR_IP: 18.0.0.24
Node_ID:1
State: VSHA_STANDALONE_MASTER
Arbitration_disk: 22000020374BB5990003.0000
Peer_IP: INVALID
Flags:0x0
---------------------------------------------------------------------module-4# show vsha dg-info vr_id 1
---------------------------------------------------------------------VSHA-DG info for vr_id 1
---------------------------------------------------------------------Record:0
DG_Name:rahul_dg1
DG_state:DISK_GROUP_O
NLINE
---------------------------------------------------------------------module-4# show vsha sg-log vr_id 1
>>>>FSM: <VSHA_SG_1> has 35 logged transitions<<<<<
1) FSM:<VSHA_SG_1> Transition at 596109 usecs after Mon Apr
Previous state: [VSHA_NULL]
Triggered event: [VSHA_EV_ARBITRATION_DISK_CHG]
Next state: [VSHA_NULL]
7 22:50:47 1980
2) FSM:<VSHA_SG_1> Transition at 163199 usecs after Mon Apr
Previous state: [VSHA_NULL]
Triggered event: [VSHA_EV_ONLINE_SERVICE_GRP_AS_MASTER]
Next state: [VSHA_STANDALONE_MASTER]
7 22:51:13 1980
3) FSM:<VSHA_SG_1> Transition at 198675 usecs after Mon Apr
Previous state: [VSHA_STANDALONE_MASTER]
Triggered event: [VSHA_EV_VX_DG_IMPORT_RESP]
Next state: [VSHA_STANDALONE_MASTER]
7 22:51:13 1980
4) FSM:<VSHA_SG_1> Transition at 201051 usecs after Mon Apr
Previous state: [VSHA_STANDALONE_MASTER]
Triggered event: [VSHA_EV_RESOURCE_MONITOR]
Next state: [VSHA_STANDALONE_MASTER]
7 22:51:23 1980
Cisco MDS 9000 Family Command Reference
2-14
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
attach module—terminal
attach module—terminal
To configure the terminal for the ASM, use the terminal command in attach module mode. Use the no
form of the command to negate a previously-issued command or revert to factory defaults.
To connect to a ASM, use the attach module command in EXEC mode. To disconnect, use the exit
command at the module-number# prompt, or type $. to forcibly abort the attach session.
attach module slot-number
terminal length number-of-lines | session-timeout | terminal type | width integer]
Syntax Description
length
(Optional) Sets the number of lines on the screen.
number-of-lines
(Optional) Specifies the number of lines on the screen from 0 to 512. Enter
0 to scroll continuously.
session-timeout
(Optional) Specifies the session time out.
terminal-type
(Optional) Sets the terminal type.
width
(Optional) Sets the width of the display terminal, from 0 to 80.
integer
Sets the width of the display terminal, from 0 to 80.
Defaults
The default number of lines for the length is 24. The default width is 80 lines.
Command Modes
EXEC
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
Remember that all terminal parameter-setting commands are set locally and do not remain in effect after
a session is ended. You must perform this task at the EXEC prompt at each session to see the debugging
messages.
If the length is not 24 and the width is not 80, then you need to set a length and width.
Examples
The following example attaches to the ASM in slot 2 and exits from the ASM debug mode.
switch# attach module 2
Attaching to module 1 ...
To exit type 'exit', to abort type '$.'
module-2#
The following example enables the session timeout to 0 (will not time out) for the ASM in slot 2.
module-2# terminal session-timeout 0
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-15
Chapter 2
Advanced Services Module Commands
attachpriv module
attachpriv module
To connect to a ASM’s Linux prompt, use the attachpriv module command in EXEC mode. To
disconnect, use the exit command at the module-number# prompt, or type $. to forcibly abort the attach
session.
attachpriv module slot-number
Syntax Description
attachpriv
Attaches to the Linux prompt.
module slot-number
Specifies the slot number for the ASM
Command Modes
EXEC
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
You cannot configure the ASM using this command. After you connect to the image on the module using
the attachpriv module command, the prompt changes to vmroot@00:05:30:00:AC:AA:/root#.
You can only issue Linux-specific commands at this prompt.
This command only works with the ASM, not with any other type of module.
You must log into the supervisor module with admin privileges in order to run this command.
Caution
Examples
The attachpriv module command is for troubleshooting, and should only be used by Cisco or Veritas
support personnel. Do not attempt to configure the ASM at the Linux prompt.
The following example attaches to the ASM in slot 2 and connects to the Linux mode.
switch# attachpriv module 2
Attaching to asm 127.1.2.2
To exit type 'exit', to abort type '$.
vmroot@00:05:30:00:AC:AA:/root#
Cisco MDS 9000 Family Command Reference
2-16
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
asm mgmt-vsan
asm mgmt-vsan
To assign the management VSAN for the Advanced Services Module (ASM), use the asm mgmt-vsan
command. To revert to factory defaults or to negate a previously issued command, use the no form of the
command.
asm mgmt-vsan vsan-id module slot-number
no asm mgmt-vsan vsan-id module slot-number
Syntax Description
asm
Configures the Advanced Services Module (ASM).
mgmt-vsan
Configures the management VSAN.
vsan-id
Specifies the ID of the management VSAN from 1 to 4093.
module slot-number
Specifies the slot number of the ASM.
Defaults
None.
Command Modes
Configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
When you specify a management VSAN for the ASM, nine (9) fabric virtual (FV) interfaces are created
If you have configured trunking on both switches, you will see 18 FV interfaces instead of 9 FV
interfaces.
After you configure the interface for a host port, you may set any other port-specific parameters, such as
port type or mode.
Examples
The following example configures management VSAN 2 for the ASM in slot 2.
switch# config terminal
switch(config)# asm mgmt-vsan 2 module 2
Related Commands
Command
Description
show vsan
Displays all VSAN configurations.
show asm mgmt-vsan
Displays the configured management VSAN.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-17
Chapter 2
Advanced Services Module Commands
interface cpp
interface cpp
To configure a Control Plane Process (CPP) interface on the Cisco MDS 9000 Family of switches, use
the interface cpp command. To disable a Fibre Channel interface, use the no form of the command.
interface cpp slot_number/processor-number/vsan-id
Syntax Description
interface
Configures a new interface.
cpp
Specifies the new interface to be a virtualization IPFC interface.
slot-number
Specifies a slot number of the ASM.
processor-number
Specifies the processor number for the IPFC interface. The current processor
number is always 1.
vsan-id
Specifies the ID of the management VSAN from 1 to 4093.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
You can specify a range of interfaces by issuing a command with the following example format:
interface space fc1/1space-space5space,spacefc2/5space-space7
Examples
The following example configures an IPFC interface for the ASM in slot 2 with a processor ID 1 in
management VSAN 2.
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# interface cpp 2/1/2
switch(config-if)#
Related Commands
Command
Description
show interface
Displays an interface configuration for a specified interface.
Cisco MDS 9000 Family Command Reference
2-18
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
show asm
show asm
To displays configured information for the ASM, use the show asm command. To revert to factory
defaults or to negate a previously issued command, use the no form of the command.
show asm disk-group | mgmt-vsan
Syntax Description
asm
Configures the Advanced Services Module (ASM).
mgmt-vsan
Configures the management VSAN.
vsan-id
Specifies the ID of the management VSAN from 1 to 4093.
module slot-number
Specifies the slot number of the ASM.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
None.
Examples
The following example displays the disk groups for the ASM in slot 2. Node refers to the ASM in slot 2
and SII refers to the SCSI index instance. When a disk group is created using the VERITAS Storage
Foundation (TM) for Networks application, they are stored in the ASM.
switch# show asm disk-group
SII Node
Disk Group Name
=== ====== ==========================
3
2
dg1-114
4
2
dg2-114
5
2
dg1-112
6
2
dg2-112
=== ====== ==========================
switch# show asm mgmt-vsan
Module-Id Management VSAN
========= ==================
2
2
========= ==================
Related Commands
Command
Description
asm mgmt-vsan
Configures the management VSAN.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-19
Chapter 2
Advanced Services Module Commands
show flogi database
show flogi database
To list all the FLOGI sessions through all interfaces across all VSANs, use the show flogi database
command.
show flogi database [fcid fcid-id | interface interface | vsan vsan-id]
Syntax Description
fcid fcid-id
Displays FLOGI database entries based on the FCID allocated.
interface interface
Displays FLOGI database entries based on the logged in interface.
vsan vsan-id
Displays FLOGI database entries based on the VSAN ID. The range is
1 to 4093.
Defaults
Displays the entire FLOGI database.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
FV interfaces are automatically created when the ASM boots up.
You can issue this command for a specific VSAN (management VSAN or discovery VSAN, or host
VSAN using the VSAN ID, or you can use the FCID to view a specific interface’s port name and node
name. The symbolic port names and node names can only be displayed for a local device.
Examples
The following example displays the virtualization related FV interface information in the FLOGI
database.
switch# show flogi database vsan 2
--------------------------------------------------------------------------INTERFACE VSAN
FCID
PORT NAME
NODE NAME
--------------------------------------------------------------------------sup-fc0
2
0x6f0001 10:00:00:05:30:00:59:1f 20:00:00:05:30:00:59:1e
fv2/1/1
2
0x6f0002 10:00:00:05:30:00:59:20 20:00:00:05:30:00:59:1e
fv2/1/2
2
0x6f0003 23:02:00:05:30:00:59:20 22:14:00:05:30:00:59:20
fv2/1/3
2
0x6f000b 23:00:00:05:30:00:59:20 22:14:00:05:30:00:59:20
fv2/1/8
2
0x6f0000 10:00:00:00:5e:00:01:02 20:00:00:05:30:00:59:1e
fv2/1/9
2
0x6f000c 10:00:00:00:5e:00:01:01 20:00:00:05:30:00:59:1e
fv2/2/1
2
0x6f0004 23:03:00:05:30:00:59:20 22:14:00:05:30:00:59:20
fv2/3/1
2
0x6f0005 23:04:00:05:30:00:59:20 22:14:00:05:30:00:59:20
fv2/4/1
2
0x6f0006 23:05:00:05:30:00:59:20 22:14:00:05:30:00:59:20
fv2/5/1
2
0x6f0007 23:06:00:05:30:00:59:20 22:14:00:05:30:00:59:20
fv2/6/1
2
0x6f0008 23:07:00:05:30:00:59:20 22:14:00:05:30:00:59:20
fv2/7/1
2
0x6f0009 23:08:00:05:30:00:59:20 22:14:00:05:30:00:59:20
fv2/8/1
2
0x6f000a 23:09:00:05:30:00:59:20 22:14:00:05:30:00:59:20
Cisco MDS 9000 Family Command Reference
2-20
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
show interface
show interface
You can check the status of an interface at any time by using the show interface command.
show interface
[interface range]
[brief | counters | description]
[cpp slot/process-number/vsan-id] | [fv slot/dpp-number/fv-port]
[fc slot/port] | [fc-tunnel tunnel-id] |
[fcip interface-number | gigabitethernet | iscsi] |
mgmt | port-channel portchannel-number. subinterface-number | sup-fc | transceiver | trunk
vsan [vsan-id] | vsan vsan-id
Syntax Description
interface range
Displays the interfaces in the specified range.
brief
Displays brief info of interface.
counters
Displays the interface counter information.
description
Displays a description of interface.
cpp slot/process-number/
vsan-id
Displays the virtualization IPFC interface in the specified slot along
with the processor number and the VSAN ID.
fv slot/dpp-number/fv-port
Displays the virtual F port (FV port) interface in the specified slot along
with the data path processor (DPP) number and the FV port number.
fc slot/port
Displays the Fibre Channel interface in the specified slot/port.
fc-tunnel tunnel-id
Displays description of the specified FC tunnel from 1 to 4095.
fcip interface-number
Displays the description of the specified FCIP interface from 1 to 255.
gigabitethernet slot/port
Displays the description of the Gigabit Ethernet interface in the
specified slot/port.
iscsi slot/port
Displays the description of the iSCSI interface in the specified slot/ port.
mgmt
Displays the description of the management interface.
port-channel
portchannel-number.
subinterface-number
Displays the PortChannel interface specified by the PortChannel
number followed by a dot (.) indicator and the subinterface number.
sup-fc
Displays the inband interface details.
transceiver
Displays the transceiver information for interface.
trunk vsan
Displays the trunking status of all VSANs.
vsan-id
Displays the trunking status of the specified VSANs.
vsan vsan-id
Displays the VSAN interface (brief, counters, or description for a
specified interface or a range of interfaces)
Defaults
None
Command Modes
EXEC
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-21
Chapter 2
Advanced Services Module Commands
show interface
Command History
This command was modified in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
The interface range must be in ascending order and nonoverlapping. You can specify a range using a
hyphen and several interfaces using commas:
•
The interface range format for a FC interface range is
fcslot/port - port , fcslot/port , fcslot/port
(For example, show int fc1/1 - 3 , fc1/5 , fc2/5)
•
The interface range format for a FV interface range is
fvslot/dpp/fvport - fvport , fvslot/dpp/port , fvslot/dpp/port
(For example, show int fv2/1/1 - 3 , fv2/1/5 , fv2/2/5)
•
The interface range format for a CPP interface range is
cppslot/process/vsan-id - vsan-id , cppslot/process/vsan-id , cppslot/process/vsan-id
(For example, show int cpp2/1/2 - 3 , cpp2/1/5 , cpp2/1/7)
•
The format for a PortChannel is
port-channel portchannel-number.subinterface-number
(For example, show int port-channel 5.1)
The CPP interface is configured when the IPFC interface is set up.
Examples
The following example displays the various interface commands.
switch# show interface fc1/11
fc1/11 is up
Hardware is Fibre Channel
Port WWN is 20:0b:00:05:30:00:59:de
Admin port mode is ST
Port mode is ST
Port vsan is 1
Speed is 1 Gbps
Rspan tunnel is fc-tunnel 100
Beacon is turned off
5 minutes input rate 248 bits/sec, 31 bytes/sec, 0 frames/sec
5 minutes output rate 176 bits/sec, 22 bytes/sec, 0 frames/sec
6862 frames input, 444232 bytes
0 discards, 0 errors
0 CRC, 0 unknown class
0 too long, 0 too short
6862 frames output, 307072 bytes
0 discards, 0 errors
0 input OLS, 0 LRR, 0 NOS, 0 loop inits
0 output OLS, 0 LRR, 0 NOS, 0 loop inits
switch# show interface fc1/1 - 3 , fc1/5 , fc2/5 brief
------------------------------------------------------------------------------Interface Vsan
Admin Admin
Status
FCOT
Oper Oper
Port
Mode
Trunk
Mode Speed Channel
Mode
(Gbps)
------------------------------------------------------------------------------fc1/1
3
auto
on
up
swl
FL
1
-fc1/2
1
auto
on
fcotAbsent
---fc1/3
1
auto
on
fcotAbsent
---fc1/5
3
auto
on
notConnected
swl
--fc2/5
5
FX
-up
swl
F
2
--
Cisco MDS 9000 Family Command Reference
2-22
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
show interface
switch# show interface sup-fc0
sup-fc0 is up
Hardware is FastEthernet, address is 0000.0000.0000
MTU 2596 bytes, BW 1000000 Kbit
66 packets input, 7316 bytes
Received 0 multicast frames, 0 compressed
0 input errors, 0 frame, 0 overrun 0 fifo
64 packets output, 28068 bytes, 0 underruns
0 output errors, 0 collisions, 0 fifo
0 carrier errors
switch# show interface vsan 2
vsan2 is up, line protocol is up
WWPN is 10:00:00:05:30:00:59:1f, FCID is 0xb90100
Internet address is 10.1.1.1/24
MTU 1500 bytes, BW 1000000 Kbit
0 packets input, 0 bytes, 0 errors, 0 multicast
0 packets output, 0 bytes, 0 errors, 0 dropped
switch# show interface description
fc1/1
no description
fc1/2
no description
fc1/15
fcAnl
sup-fc0 is up
mgmt0 is up
vsan1 - IPFC interface
port-channel 15
no description
port-channel 98
no description
switch# show interface fc2/1 - 5 brief
------------------------------------------------------------------------------Interface Vsan
Admin Admin
Status
Oper Oper
Port-channel
Mode
Trunk
Mode Speed
Mode
(Gbps)
------------------------------------------------------------------------------fc1/1
3
auto
on
up
FL
1
-fc1/2
1
auto
on
fcotAbsent
--fc1/3
1
auto
on
fcotAbsent
--fc1/4
3
auto
on
up
FL
1
-fc1/5
3
auto
on
up
F
2
-fc1/6
1
auto
on
fcotAbsent
--fc1/7
1
auto
on
fcotAbsent
--fc1/8
3
auto
on
fcotAbsent
--fc1/9
1
auto
on
fcotAbsent
--fc1/10
1
auto
on
fcotAbsent
--fc1/11
1
auto
on
fcotAbsent
--fc1/12
1
auto
on
fcotAbsent
--fc1/13
1
auto
on
fcotAbsent
--fc1/14
1
auto
on
fcotAbsent
--fc1/15
1
auto
on
fcotAbsent
--fc1/16
1
auto
on
trunking
TE
2
-fc2/1
1
FX
-fcotAbsent
--fc2/2
1
FX
-fcotAbsent
--fc2/3
1
FX
-fcotAbsent
---
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-23
Chapter 2
Advanced Services Module Commands
show interface
fc2/4
1
FX
-fcotAbsent
--fc2/5
5
FX
-up
F
2
-...
------------------------------------------------------------------------------Interface
Status
Speed
(Gbps)
------------------------------------------------------------------------------sup-fc0
up
1
------------------------------------------------------------------------------Interface
Status
IP Address
Speed
MTU
------------------------------------------------------------------------------mgmt0
up
172.22.36.112/23 100 Mbps
1500
------------------------------------------------------------------------------Interface
Status
IP Address
Speed
MTU
------------------------------------------------------------------------------vsan2
up
15.0.112.0/16
1 Gbps
1500
------------------------------------------------------------------------------Interface
Status
IP Address
Speed
MTU
------------------------------------------------------------------------------cpp2/1/2
up
15.0.112.2/16
1 Gbps
1500
------------------------------------------------------------------------------Interface
VSAN
Status
Oper
Speed
Port-channel
Mode
------------------------------------------------------------------------------fv2/1/1
2
up
F
auto
-fv2/1/2
2
up
F
auto
-fv2/1/3
2
up
F
auto
-fv2/1/4
3
up
F
auto
-fv2/1/5
3
up
F
auto
-fv2/1/6
4
up
F
auto
-...
switch# show interface fcip 3 counters
fcip3
TCP Connection Information
2 Active TCP connections
Control connection: Local 43.1.1.2:3225, Remote 43.1.1.1:65532
Data connection: Local 43.1.1.2:3225, Remote 43.1.1.1:65534
30 Attempts for active connections, 0 close of connections
TCP Parameters
Path MTU 1500 bytes
Current retransmission timeout is 300 ms
Round trip time: Smoothed 10 ms, Variance: 5
Advertised window: Current: 122 KB, Maximum: 122 KB, Scale: 1
Peer receive window: Current: 114 KB, Maximum: 114 KB, Scale: 1
Congestion window: Current: 2 KB, Slow start threshold: 1048560 KB
5 minutes input rate 64 bits/sec, 8 bytes/sec, 0 frames/sec
5 minutes output rate 64 bits/sec, 8 bytes/sec, 0 frames/sec
910 frames input, 84652 bytes
910 Class F frames input, 84652 bytes
0 Class 2/3 frames input, 0 bytes
0 Error frames timestamp error 0
908 frames output, 84096 bytes
908 Class F frames output, 84096 bytes
0 Class 2/3 frames output, 0 bytes
0 Error frames 0 reass frames
switch# show interface counters brief
------------------------------------------------------------------------------Interface
Input (rate is 5 min avg)
Output (rate is 5 min avg)
Cisco MDS 9000 Family Command Reference
2-24
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
show interface
----------------------------- ----------------------------Rate
Total
Rate
Total
MB/s
Frames
MB/s
Frames
------------------------------------------------------------------------------fc9/1
0
0
0
0
fc9/2
0
0
0
0
fc9/3
0
0
0
0
fc9/4
0
0
0
0
...
------------------------------------------------------------------------------Interface
Input (rate is 5 min avg)
Output (rate is 5 min avg)
----------------------------- ----------------------------Rate
Total
Rate
Total
MB/s
Frames
MB/s
Frames
------------------------------------------------------------------------------iscsi4/1
0
0
0
0
iscsi4/2
0
0
0
0
iscsi4/3
0
0
0
0
iscsi4/4
0
0
0
0
...
vsan10 is up, line protocol is up
WWPN is 10:00:00:05:30:00:07:23, FCID is 0xee0001
Internet address is 10.1.1.5/24
MTU 1500 bytes, BW 1000000 Kbit
0 packets input, 0 bytes, 0 errors, 0 multicast
0 packets output, 0 bytes, 0 errors, 0 dropped
------------------------------------------------------------------------------Interface
Input (rate is 5 min avg)
Output (rate is 5 min avg)
----------------------------- ----------------------------Rate
Total
Rate
Total
MB/s
Frames
MB/s
Frames
------------------------------------------------------------------------------port-channel 100
0
0
0
0
------------------------------------------------------------------------------Interface
Input (rate is 5 min avg)
Output (rate is 5 min avg)
----------------------------- ----------------------------Rate
Total
Rate
Total
Mbits/s Frames
Mbits/s Frames
------------------------------------------------------------------------------fcip2
fcip3
0
9
0
0
0
9
0
0
fcip6
fcip7
8
8
0
0
8
8
0
0
switch# show interface fcip 3
fcip3 is trunking
Hardware is GigabitEthernet
Port WWN is 20:ca:00:05:30:00:07:1e
Peer port WWN is 20:ca:00:00:53:00:18:1e
Admin port mode is auto, trunk mode is on
Port mode is TE
vsan is 1
Trunk vsans (allowed active) (1,10)
Trunk vsans (operational)
(1)
Trunk vsans (up)
(1)
Trunk vsans (isolated)
(10)
Trunk vsans (initializing)
()
Using Profile id 3 (interface GigabitEthernet4/3)
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-25
Chapter 2
Advanced Services Module Commands
show interface
Peer Information
Peer Internet address is 43.1.1.1 and port is 3225
Special Frame is disabled
Maximum number of TCP connections is 2
Time Stamp is disabled
B-port mode disabled
TCP Connection Information
2 Active TCP connections
Control connection: Local 43.1.1.2:3225, Remote 43.1.1.1:65532
Data connection: Local 43.1.1.2:3225, Remote 43.1.1.1:65534
30 Attempts for active connections, 0 close of connections
TCP Parameters
Path MTU 1500 bytes
Current retransmission timeout is 300 ms
Round trip time: Smoothed 10 ms, Variance: 5
Advertized window: Current: 122 KB, Maximum: 122 KB, Scale: 1
Peer receive window: Current: 114 KB, Maximum: 114 KB, Scale: 1
Congestion window: Current: 2 KB, Slow start threshold: 1048560 KB
5 minutes input rate 64 bits/sec, 8 bytes/sec, 0 frames/sec
5 minutes output rate 64 bits/sec, 8 bytes/sec, 0 frames/sec
866 frames input, 80604 bytes
866 Class F frames input, 80604 bytes
0 Class 2/3 frames input, 0 bytes
0 Error frames timestamp error 0
864 frames output, 80048 bytes
864 Class F frames output, 80048 bytes
0 Class 2/3 frames output, 0 bytes
0 Error frames 0 reass frames
switch# show interface gigabitethernet 4/1
GigabitEthernet4/1 is up
Hardware is GigabitEthernet, address is 0005.3000.2e12
Internet address is 100.1.1.2/24
MTU 1500 bytes, BW 1000000 Kbit
Port mode is IPS
Speed is 1 Gbps
Beacon is turned off
5 minutes input rate 32 bits/sec, 4 bytes/sec, 0 frames/sec
5 minutes output rate 88 bits/sec, 11 bytes/sec, 0 frames/sec
637 packets input, 49950 bytes
0 multicast frames, 0 compressed
0 input errors, 0 frame, 0 overrun 0 fifo
659 packets output, 101474 bytes, 0 underruns
0 output errors, 0 collisions, 0 fifo
0 carrier errors
switch# show interface iscsi 2/1
iscsi2/1 is up
Hardware is GigabitEthernet
Port WWN is 20:41:00:05:30:00:50:de
Admin port mode is ISCSI
Port mode is ISCSI
Speed is 1 Gbps
iSCSI initiator is identified by name
Number of iSCSI session: 7, Number of TCP connection: 7
Configured TCP parameters
Local Port is 3260
PMTU discover is disabled
Keepalive-timeout is 1 sec
Minimum-retransmit-time is 300 ms
Max-retransmissions 8
Sack is disabled
Minimum available bandwidth is 0 kbps
Estimated round trip time is 0 usec
Cisco MDS 9000 Family Command Reference
2-26
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
show interface
5 minutes input rate 265184 bits/sec, 33148 bytes/sec, 690 frames/sec
5 minutes output rate 375002168 bits/sec, 46875271 bytes/sec, 33833 frames/sec
iSCSI statistics
6202235 packets input, 299732864 bytes
Command 6189718 pdus, Data-out 1937 pdus, 1983488 bytes, 0 fragments
146738794 packets output, 196613551108 bytes
Response 6184282 pdus (with sense 4), R2T 547 pdus
Data-in 140543388 pdus, 189570075420 bytes
switch# show interface cpp 2/1/2
cpp2/1/2 is up, line protocol is up
WWPN is 10:00:00:05:30:00:94:a0, FCID is 0x6d0002
Internet address is 15.0.114.2/16
MTU 1500 bytes, BW 1000000 Kbit
4679361 packets input, 568734976 bytes, 0 errors, 1202625 multicast
5000574 packets output, 584517419 bytes, 1 errors, 10 dropped
switch# show interface transceiver
fc1/1 fcot is present but not supported
name is IBM
part number is IBM42P21SNY
revision is AA20
serial number is 53P148700109D
vendor specific data (bytes 96-127)
0x49 0x42 0x4D 0x20 0x53 0x46 0x50
0x20 0x41 0x52 0x45 0x20 0x43 0x4C
0x53 0x53 0x20 0x31 0x20 0x4C 0x41
0x45 0x52 0x20 0x53 0x41 0x46 0x45
fc1/2 fcot not present
fc1/3 fcot is present but not supported
name is IBM
part number is IBM42P21SNY
revision is AA20
serial number is 53P1487000ZXR
vendor specific data (bytes 96-127)
0x49 0x42 0x4D 0x20 0x53 0x46 0x50
0x20 0x41 0x52 0x45 0x20 0x43 0x4C
0x53 0x53 0x20 0x31 0x20 0x4C 0x41
0x45 0x52 0x20 0x53 0x41 0x46 0x45
0x53
0x41
0x53
0x20
0x53
0x41
0x53
0x20
switch# show interface fc-tunnel 200
fc-tunnel 200 is up
Dest
IP Addr: 200.200.200.7
Tunnel ID: 200
Source IP Addr: 200.200.200.4
LSP ID: 1
Explicit Path Name: Path1
virt-112# show interface fv 2/2/3
fv2/2/3 is up
Hardware is Fibre Channel, WWN is 22:13:00:05:30:00:59:20
Port mode is F
Speed is auto
vsan is 4
Beacon is turned off
0 packets input, 0 bytes, 0 discards
0 input errors, 0 CRC, 0 invalid transmission words
0 address id, 0 delimiter
Received 0 runts, 0 jabber, 0 too long, 0 too short
0 EOF abort, 0 fragmented, 0 unknown class
0 OLS, 0 LRR, 0 NOS, 0 loop inits
0 packets output, 0 bytes
Transmitted 0 OLS, 0 LRR, 0 NOS, 0 loop inits
switch# show int fv2/1/2
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-27
Chapter 2
Advanced Services Module Commands
show interface
fv2/1/2 is up
Hardware is Fibre Channel, WWN is 22:0b:00:05:30:00:59:20
Port mode is F
Speed is auto
vsan is 2
Beacon is turned off
0 packets input, 0 bytes, 0 discards
0 input errors, 0 CRC, 0 invalid transmission words
0 address id, 0 delimiter
Received 0 runts, 0 jabber, 0 too long, 0 too short
0 EOF abort, 0 fragmented, 0 unknown class
0 OLS, 0 LRR, 0 NOS, 0 loop inits
0 packets output, 0 bytes
Transmitted 0 OLS, 0 LRR, 0 NOS, 0 loop inits
Cisco MDS 9000 Family Command Reference
2-28
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 2
Advanced Services Module Commands
show fvport
show fvport
You can check the status of a virtual F port (FV port) interface at any time by using the show fvport
command.
show fvport [interface fv slot/dpp-number/fv-port | interface range]
Syntax Description
fvport
Displays all FV ports in the switch.
interface
Specifies the FV port interface.
fv slot/dpp-number/fv-port
Displays the FV port interface in the specified slot along with the data
path processor (DPP) number and the FV port number.
interface range
Displays the interfaces in the specified range.
Defaults
None
Command Modes
EXEC
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.2(2).
Usage Guidelines
The interface range must be in ascending order and nonoverlapping. You can specify a range using a
hyphen and several interfaces using commas. The interface range format for a FV interface range is
fvslot/dpp/fvport - fvport , fvslot/dpp/port , fvslot/dpp/port
(For example, show fvport int fv2/1/1 - 3 , fv2/1/5 , fv2/2/5)
Examples
switch# show fvport
fv2/1/1
The N Port if_index is
The N Port pwwn is
The N Port nwwn is
The vsan is
The FV Port if_index is
The FV Port pwwn is
The DPP id is
The NV port type is
The State is
Number of create requests
minus the number of
delete requests =
...
0x01090000
10:00:00:05:30:00:59:20
20:00:00:05:30:00:59:1e
2
0x0e080000
22:0a:00:05:30:00:59:20
0
IPFC
ACTIVE
1
switch# show fvport interface fv2/4/1 , fv2/7/1 - 3
fv2/4/1
The N Port if_index is
0x01094000
The N Port pwwn is
23:05:00:05:30:00:59:20
The N Port nwwn is
23:01:00:05:30:00:59:20
The vsan is
2
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
2-29
Chapter 2
Advanced Services Module Commands
show fvport
The FV Port if_index is
The FV Port pwwn is
The DPP id is
The NV port type is
The State is
Number of create requests
minus the number of
delete requests =
0x0e08c000
23:67:00:05:30:00:59:20
3
INTERNAL PORT
ACTIVE
The N Port if_index is
The N Port pwwn is
The N Port nwwn is
The vsan is
The FV Port if_index is
The FV Port pwwn is
The DPP id is
The NV port type is
The State is
Number of create requests
minus the number of
delete requests =
0x0108c000
23:08:00:05:30:00:59:20
23:01:00:05:30:00:59:20
2
0x0e098000
23:6a:00:05:30:00:59:20
6
INTERNAL PORT
ACTIVE
The N Port if_index is
The N Port pwwn is
The N Port nwwn is
The vsan is
The FV Port if_index is
The FV Port pwwn is
The DPP id is
The NV port type is
The State is
Number of create requests
minus the number of
delete requests =
0x0108d000
23:1a:00:05:30:00:59:20
23:46:00:05:30:00:59:20
3
0x0e098001
23:58:00:05:30:00:59:20
6
INTERNAL PORT
ACTIVE
The N Port if_index is
The N Port pwwn is
The N Port nwwn is
The vsan is
The FV Port if_index is
The FV Port pwwn is
The DPP id is
The NV port type is
The State is
Number of create requests
minus the number of
delete requests =
0x0108e000
23:2c:00:05:30:00:59:20
23:2e:00:05:30:00:59:20
4
0x0e098002
23:61:00:05:30:00:59:20
6
INTERNAL PORT
ACTIVE
1
fv2/7/1
1
fv2/7/2
1
fv2/7/3
1
Cisco MDS 9000 Family Command Reference
2-30
OL-29295-04, Cisco MDS NX-OS Release 6.x
CH A P T E R
3
B Commands
The commands in this chapter apply to the Cisco MDS 9000 Family of multilayer directors and fabric
switches. All commands are shown here in alphabetical order regardless of command mode. See the
“About the CLI Command Modes” section on page 1-3 to determine the appropriate mode for each
command.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
3-1
Chapter 3
B Commands
banner motd
banner motd
To configure a message of the day (MOTD) banner, use the banner motd command in configuration
mode.
banner motd [delimiting-character message delimiting-character]
no banner motd [delimiting-character message delimiting-character]
Syntax Description
delimiting-character
(Optional) Identifies the delimiting character.
message
(Optional) Specifies the banner message that is restricted to 40 lines with a
maximum of 80 characters in each line.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
1.3(4)
This command was introduced.
Usage Guidelines
The configured MOTD banner is displayed before the login prompt on the terminal whenever a user logs
in to a Cisco MDS 9000 Family switch.
Follow these guidelines when choosing your delimiting character:
•
Do not use the delimiting-character in the message string.
•
Do not use " and % as delimiters.
You can include tokens in the form $(token) in the message text. Tokens will be replaced with the
corresponding configuration variable. For example:
Examples
displays the host name for the switch.
•
$(hostname)
•
$(line)
•
The $(line-desc) and $(domain) tokens are not supported.
displays the vty or tty line no or name.
The following example configures a banner message with the following text “Testing the MOTD
Feature:
switch# config terminal
switch(config)# banner motd # Testing the MOTD Feature. #
The following example spans multiple lines and uses tokens to configure the banner message:
switch# config terminal
Cisco MDS 9000 Family Command Reference
3-2
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 3
B Commands
banner motd
switch(config)# banner motd #
Enter TEXT message. End with the character '#'.
Welcome to switch $(hostname).
You tty line is $(line).
#
Related Commands
Command
Description
show banner motd
Displays the configured banner message.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
3-3
Chapter 3
B Commands
boot
boot
To perform operations on the system, use the boot command in configuration mode. To negate this
feature or return to factory defaults, use the no form of the command.
boot {asm-sfn {bootflash: | slot0: | tftp:}[image] [module [slot-number]] | auto-copy | kickstart
{bootflash: | slot0: | tftp:}[image] [sup-1 [sup-2] | sup-2] | lasilc {bootflash: | slot0: |
tftp:}[image] [module [slot-number]] | ssi {bootflash: | slot0:} | system {bootflash: | slot0: |
tftp:}[image] [sup-1 [sup-2] | sup-2]}
no boot {asm-sfn {bootflash: | slot0: | tftp:}[image] [module [slot-number]] | auto-copy |
kickstart {bootflash: | slot0: | tftp:}[image] [sup-1 [sup-2] | sup-2] | lasilc {bootflash: | slot0:
| tftp:}[image] [module [slot-number]] | ssi {bootflash: | slot0:} | system {bootflash: | slot0:
| tftp:}[image] [sup-1 [sup-2] | sup-2]}
Syntax Description
asm-sfn
Configures the virtualization image.
bootflash:
Specifies system image URI for bootflash.
slot0:
Specifies system image URI for slot 0.
tftp:
Specifies system image URI for TFTP.
image
(Optional) Specifies the image file name.
module slot-number
(Optional) Specifies the slot number of the SSM.
auto-copy
Configures auto-copying of boot variable images.
kickstart
Configures the kickstart image.
lasilc
Configures the boot image.
ssi
Configures the SSI image.
system
Configures the system image.
sup-1
(Optional) Configures the upper supervisor.
sup-2
(Optional) Configures the lower supervisor.
Disabled.
The default state for auto-copy is enabled.
Command Modes
Configuration mode
Command History
Release
Modification
1.2(2)
This command was introduced
3.0(1)
Changed the default state for auto-copy to enabled.
Usage Guidelines
The boot kickstart slot0:image command is currently not allowed. For kickstart, only bootflash: is
allowed.
Cisco MDS 9000 Family Command Reference
3-4
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 3
B Commands
boot
You enter the boot auto-copy command, the system copies the boot variable images that are local
(present) in the active supervisor module (but not in the standby supervisor module) to the standby
supervisor module. For kickstart and system boot variables, only those images that are set for the standby
supervisor module are copied. For modules (line card) images, all modules present in standby's
corresponding locations (bootflash: or slot0:) are copied.
Examples
The following example adds the new system image file to the SYSTEM environment variable:
switch(config)# boot system bootflash:system.img
The following example boots from the CompactFlash device (slot0:). The switch updates the SYSTEM
environment variable to reflect the new image file in the specified flash device:
switch(config)# boot system slot0:system.img
The following example overwrites the old Kickstart environment variable in the configuration file:
switch(config)# boot kickstart bootflash:kickstart.img
The following example specifies the SSM image to be used:
switch(config)# boot asm-sfn bootflash:m9000-ek9-asm-sfn-mz.1.2.2.bin
The following example enables automatic copying of boot variables from the active supervisor module
to the standby supervisor module:
switch(config)# boot auto-copy
The following example disables the automatic copy feature (default):
switch(config)# no boot auto-copy
Related Commands
Command
Description
show boot
Displays the configured boot variable information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
3-5
Chapter 3
B Commands
bport
bport
To configure a B port mode on a FCIP interface, use the bport option. To disable a B port mode on a
FCIP interface, use the no form of the command.
bport
no bport
Syntax Description
This command has no other arguments or keywords.
Defaults
Disabled.
Command Modes
Interface configuration submode
Command History
Release
Modification
1.1(1)
This command was introduced.
Usage Guidelines
Access this command from the switch(config-if)# submode.
Examples
The following example shows how to configure a B port mode on an FCIP interface:
switch# config terminal
switch(config)# interface fcip 1
switch(config-if)# bport
Related Commands
Command
Description
bport-keepalive
Configures B port keepalive responses.
show interface fcip
Displays an interface configuration for a specified FCIP interface.
Cisco MDS 9000 Family Command Reference
3-6
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 3
B Commands
bport-keepalive
bport-keepalive
To configure keepalive responses for B port FCIP interfaces, use the bport-keepalive option. To disable
keepalive responses for B port FCIP interfaces, use the no form of the command.
bport-keepalive
no bport-keepalive
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Interface configuration submode
Command History
Release
Modification
1.1(1)
This command was introduced.
Usage Guidelines
Access this command from the switch(config-if)# submode.
Examples
The following example shows how to configure keepalive responses for B port FCIP interfaces:
switch# config terminal
switch(config)# interface fcip 1
switch(config-if)# bport-keepalives
Related Commands
Command
Description
bport
Configures a B port FCIP interface.
show interface fcip
Displays an interface configuration for a specified FCIP interface.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
3-7
Chapter 3
B Commands
broadcast
broadcast
To enable the broadcast frames attribute in a zone attribute group, use the broadcast command. To revert
to the default, use the no form of the command.
broadcast
no broadcast
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Zone attribute configuration submode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
Broadcast frames are sent to all Nx ports.
If any NL port attached to an FL port shares a broadcast zone with the source of the broadcast frame,
then the frames are broadcast to all devices in the loop.
This command only configures the broadcast attribute for enhanced zoning. To enable broadcast zoning
for basic mode, use the attribute broadcast subcommand after entering zone configuration mode using
the zone name command.
Examples
The following example shows how to set the broadcast attribute for a zone attribute group:
switch# config terminal
switch(config)# zone-attribute-group name admin-attributes vsan 10
switch(config-attribute-group)# broadcast
Related Commands
Command
Description
show zone-attribute-group
Displays zone attribute group information.
zone mode enhanced vsan
Enables enhanced zoning for a VSAN.
zone name
Configures zone attributes.
zone-attribute-group name
Configures zone attribute groups.
Cisco MDS 9000 Family Command Reference
3-8
OL-29295-04, Cisco MDS NX-OS Release 6.x
CH A P T E R
4
C Commands
The commands in this chapter apply to the Cisco MDS 9000 Family of multilayer directors and fabric
switches. All commands are shown here in alphabetical order regardless of command mode. See “About
the CLI Command Modes” section on page 1-3 to determine the appropriate mode for each command.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-1
Chapter 4
C Commands
callhome
callhome
To configure the Call Home function, use the callhome command.
callhome
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
The Call Home configuration commands are available in the (config-callhome) submode.
A Call Home message is used to contact a support person or organization in case an urgent alarm is
raised.
Once you have configured the contact information, you must enable the Call Home function. The enable
command is required for the Call Home function to start operating. When you disable the Call Home
function, all input events are ignored.
Note
Even if Call Home is disabled, basic information for each Call Home event is sent to syslog.
The user-def-cmd command allows you to define a command whose outputs should be attached to the
Call Home message being sent. Only show commands can be specified and they must be associated with
an alert group. Five commands can be specified per alert group. Invalid commands are rejected.
Note
Customized show commands are only supported for full text and XML alert groups. Short text alert
groups (short-txt-destination) do not support customized show commands because they only allow 128
bytes of text.
To assign show commands to be executed when an alert is sent, you must associate the commands with
the alert group. When an alert is sent, Call Home associates the alert group with an alert type and attaches
the output of the show commands to the alert message.
Note
Make sure the destination profiles for the non-Cisco-TAC alert group, with a predefined show command,
and the Cisco-TAC alert group are not the same.
The following example assigns contact information:
Cisco MDS 9000 Family Command Reference
4-2
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
callhome
switch# config terminal
config terminal
switch# snmp-server contact [email protected]
switch(config)# callhome
switch(config-callhome)# email-contact [email protected]
switch(config-callhome)# phone-contact +1-800-123-4567
switch(config-callhome)# streetaddress 1234 Picaboo Street, Any city, Any state, 12345
switch(config-callhome)# switch-priority 0
switch(config-callhome)# customer-id Customer1234
switch(config-callhome)# site-id Site1ManhattanNY
switch(config-callhome)# contract-id Company1234
The following example configures a user-defined show command for an alert-group license:
switch(config-callhome)# alert-group license user-def-cmd "show license usage"
Note
The show command must be enclosed in double quotes.
The following example removes a user-defined show command for an alert-group license:
switch(config-callhome)# no alert-group license user-def-cmd "show license usage"
Related Commands
Command
Description
alert-group
Customizes a Call Home alert group with user-defined show commands.
callhome test
Sends a dummy test message to the configured destination(s).
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-3
Chapter 4
C Commands
callhome test
callhome test
To simulate a Call Home message generation, use the callhome test command.
callhome test [inventory]
Syntax Description
inventory
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
(Optional) Sends a dummy Call Home inventory.
Usage Guidelines
You can simulate a message generation by entering a callhome test command.
Examples
The following example sends a test message to the configured destinations:
switch# callhome test
trying to send test callhome message
successfully sent test callhome message
The following example sends a test inventory message to the configured destinations:
switch# callhome test inventory
trying to send test callhome message
successfully sent test callhome message
Related Commands
Command
Description
callhome
Configures Call Home functions.
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
4-4
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cd
cd
To change the default directory or file system, use the cd command.
cd {directory | bootflash: [directory] | slot0: [directory] | volatile: [directory]}
Syntax Description
Defaults
directory
(Optional) Name of the directory on the file system.
bootflash:
URI or alias of the bootflash or file system.
slot0:
URI or alias of the slot0 file system.
volatile:
URI or alias of the volatile file system.
The initial default file system is flash:. For platforms that do not have a physical device named flash:,
the keyword flash: is aliased to the default flash device.
If you do not specify a directory on a file system, the default is the root directory on that file system.
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
For all EXEC commands that have an optional file system argument, the system uses the file system
specified by the cd command when you omit the optional file system argument. For example, the dir
command, which displays a list of files on a file system, contains an optional file system argument. When
you omit this argument, the system lists the files on the file system specified by the cd command.
Examples
The following example sets the default file system to the flash memory card inserted in slot 0:
switch# pwd
bootflash:/
switch# cd slot0:
switch# pwd
slot0:/
Related Commands
Command
Description
copy
Copies any file from a source to a destination.
delete
Deletes a file on a flash memory device.
dir
Displays a list of files on a file system.
pwd
Displays the current setting of the cd command.
show file systems
Lists available file systems and their alias prefix names.
undelete
Recovers a file marked deleted on a Class A or Class B flash file system.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-5
Chapter 4
C Commands
cdp
cdp
To globally configure the Cisco Discovery Protocol parameters, use the cdp command. Use the no form
of this command to revert to factory defaults.
cdp {enable | advertise {v1 | v2} | holdtime holdtime-seconds | timer timer-seconds}
no cdp {enable | advertise | holdtime holdtime-seconds | timer timer-seconds}
Syntax Description
Defaults
enable
Enables CDP globally on all interfaces on the switch.
advertise
Specifies the EXEC command to be executed.
v1
Specifies CDP version 1.
v2
Specifies CDP version 2.
holdtime
Sets the hold time advertised in CDP packets.
holdtime-seconds
The holdtime in seconds. The default is 180 seconds and the valid range is
from 10 to 255 seconds.
timer
Sets the refresh time interval.
timer-seconds
The time interval in seconds. The default is 60 seconds and the valid range
is from 5 to 255 seconds.
CDP is enabled.
The hold time default interval is 180 seconds.
The refresh time interval is 60 seconds.
Command Modes
Configuration mode
Command History
Release
Modification
1.1(1)
This command was introduced.
Usage Guidelines
Use the cdp enable command to enable the Cisco Discovery Protocol (CDP) feature at the switch level
or at the interface level. Use the no form of this command to disable this feature. When the interface link
is established, CDP is enabled by default
CDP version 1 (v1) and version 2 (v2) are supported in Cisco MDS 9000 Family switches. CDP packets
with any other version number are silently discarded when received.
Examples
The following example disables the CDP protocol on the switch. When CDP is disabled on an interface,
one packet is sent to clear out the switch state with each of the receiving devices:
switch(config)# no cdp enable
Operation in progress. Please check global parameters
switch(config-console)#
Cisco MDS 9000 Family Command Reference
4-6
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cdp
The following example enables (default) the CDP protocol on the switch. When CDP is enabled on an
interface, one packet is sent immediately. Subsequent packets are sent at the configured refresh time.
switch(config)# cdp enable
Operation in progress. Please check global parameters
switch(config)#
The following example configures the Gigabit Ethernet interface 8/8 and disables the CDP protocol on
this interface. When CDP is disabled on an interface, one packet is sent to clear out the switch state with
each of the receiving devices.
switch(config)# interface gigbitethernet 8/8
switch(config-if)# no cdp enable
Operation in progress. Please check interface parameters
switch(config-console)#
The following example enables (default) the CDP protocol on the selected interface. When CDP is
enabled on this interface, one packet is sent immediately. Subsequent packets are sent at the configured
refresh time.
switch(config-if)# cdp enable
Operation in progress. Please check interface parameters
switch(config)#
The following example globally configures the refresh time interval for the CDP protocol in seconds.
The default is 60 seconds and the valid range is from 5 to 255 seconds.
switch# config terminal
switch(config)# cdp timer 100
switch(config)#
The following example globally configures the hold time advertised in CDP packet in seconds. The
default is 180 seconds and the valid range is from 10 to 255 seconds.
switch# config terminal
switch(config)# cdp holdtime 200
switch(config)#
The following example globally configures the CDP version. The default is version 2 (v2). The valid
options are v1 and v2.
switch# config terminal
switch(config)# cdp advertise v1
switch(config)#
Related Commands
Command
Description
clear cdp
Clears global or interface-specific CDP configurations.
show cdp
Displays configured CDP settings and parameters.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-7
Chapter 4
C Commands
cfs distribute
cfs distribute
To enable or disable Cisco Fabric Services (CFS) distribution on the switch, use the cfs distribute
command in configuration mode. To disable this feature, use the no form of the command.
cfs distribute
no cfs distribute
Syntax Description
This command has no other arguments or keywords.
Defaults
CFS distribution is enabled.
Command Modes
Configuration mode
Command History
Release
Modification
2.1(1a)
This command was introduced.
Usage Guidelines
By default CFS is in the distribute mode. In the distribute mode, fabric wide distribution is enabled.
Applications can distribute data/configuration to all CFS-capable switches in the fabric where the
application exists. This is the normal mode of operation.
If CFS distribution is disabled, using the no cfs distribute command causes the following to occur:
Examples
•
CFS and the applications using CFS on the switch are isolated from the rest of the fabric even though
there is physical connectivity.
•
All CFS operations are restricted to the isolated switch.
•
All the CFS commands continue to work similar to the case of a physically isolated switch.
•
Other CFS operations (for example, lock, commit, and abort) initiated at other switches do not have
any effect at the isolated switch.
•
CFS distribution is disabled over both Fibre Channel and IP.
The following example shows how to disable CFS distribution:
switch# config terminal
Enter configuration commands, one per line.
switch(config)# no cfs distribute
End with CNTL/Z.
The following example shows how to reenable CFS distribution:
switch# config terminal
Enter configuration commands, one per line.
switch(config)# cfs distribute
End with CNTL/Z.
Cisco MDS 9000 Family Command Reference
4-8
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cfs distribute
Related Commands
Command
Description
show cfs status
Displays whether CFS distribution is enabled or disabled.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-9
Chapter 4
C Commands
cfs ipv4 distribute
cfs ipv4 distribute
To enable Cisco Fabric Services (CFS) distribution over IPv4 for applications that want to use this
feature, use the cfs ipv4 distribute command in configuration mode. To disable this feature, use the no
form of the command.
cfs ipv4 distribute
no cfs ipv4 distribute
Syntax Description
This command has no arguments or keywords.
Defaults
CFS distribution is enabled.
CFS over IP is disabled.
Command Modes
Configuration mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
All CFS over IP enabled switches with similar multicast addresses form one CFS over IP fabric. CFS
protocol specific distributions, such as the keep-alive mechanism for detecting network topology
changes, use the IP multicast address to send and receive information.
Observe the following guidelines when using this command:
Examples
•
If a switch is reachable over both IP and Fibre Channel, application data will be distributed over
Fibre Channel.
•
You can select either an IPv4 or IPv6 distribution when CFS is enabled over IP.
•
Both IPv4 and IPv6 distribution cannot be enabled on the same switch.
•
A switch that operate IPv4 distribution enabled cannot detect a switch that IPv6 distribution enabled.
The switches behave as if they are in two different fabrics even though they are connected to each
other.
The following example shows how to disable CFS IPv4 distribution:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# no cfs ipv4 distribute
This will prevent CFS from distributing over IPv4 network.
Are you sure? (y/n) [n]
The following example shows how to reenable CFS IPv4 distribution:
switch# config terminal
Cisco MDS 9000 Family Command Reference
4-10
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cfs ipv4 distribute
Enter configuration commands, one per line.
switch(config)# cfs ipv4 distribute
Related Commands
End with CNTL/Z.
Command
Description
cfs ipv4 mcast-address
Configures an IPv4 multicast address for Cisco Fabric Services (CFS)
distribution over IPv4.
show cfs status
Displays whether CFS distribution is enabled or disabled.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-11
Chapter 4
C Commands
cfs ipv4 mcast-address
cfs ipv4 mcast-address
To configure an IPv4 multicast address for Cisco Fabric Services (CFS) distribution over IPv4, use the
cfs ipv4 mcast-address command in configuration mode. To disable this feature, use the no form of the
command.
cfs ipv4 mcast-address ipv4-address
no cfs ipv4 mcast-address ipv4-address
Syntax Description
ipv4-address
Specifies an IPv4 multicast address for CFS distribution over IPv4. The
range of valid IPv4 addresses is 239.255.0.0 through 239.255.255.255, and
239.192.0.0 through 239.251.251.251.
Defaults
Multicast address: 239.255.70.83.
Command Modes
Configuration mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Before using this command, enable CFS distribution over IPv4 using the cfs ipv4 distribute command.
All CFS over IP enabled switches with similar multicast addresses form one CFS over IP fabric. CFS
protocol specific distributions, such as the keepalive mechanism for detecting network topology
changes, use the IP multicast address to send and receive information.
Note
CFS distributions for application data use directed unicast.
You can configure a value for a CFS over IP multicast address. The default IPv4 multicast address is
239.255.70.83.
Examples
The following example shows how to configure an IP multicast address for CFS over IPv4:
switch# config t
switch(config)# cfs ipv4 mcast-address 239.255.1.1
Distribution over this IP type will be affected
Change multicast address for CFS-IP ?
Are you sure? (y/n) [n] y
The following example shows how to revert to the default IPv4 multicast address for CFS distribution
over IPv4. The default IPv4 multicast address for CFS is 239.255.70.83:
switch(config)# no cfs ipv4 mcast-address 10.1.10.100
Distribution over this IP type will be affected
Cisco MDS 9000 Family Command Reference
4-12
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cfs ipv4 mcast-address
Change multicast address for CFS-IP ?
Are you sure? (y/n) [n] y
Related Commands
Command
Description
cfs ipv4 distribute
Enables or disables Cisco Fabric Services (CFS) distribution over IPv4.
show cfs status
Displays whether CFS distribution is enabled or disabled.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-13
Chapter 4
C Commands
cfs ipv6 distribute
cfs ipv6 distribute
To enable Cisco Fabric Services (CFS) distribution over IPv6 for applications that want to use this
feature, use the cfs ipv6 distribute command in configuration mode. To disable this feature, use the no
form of the command.
cfs ipv6 distribute
no cfs ipv6 distribute
Syntax Description
This command has no arguments or keywords.
Defaults
CFS distribution is enabled.
CFS over IP is disabled.
Command Modes
Configuration mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
All CFS over IP enabled switches with similar multicast addresses form one CFS over IP fabric. CFS
protocol specific distributions, such as the keepalive mechanism for detecting network topology
changes, use the IP multicast address to send and receive information.
Observe the following guidelines when using this command:
Examples
•
If a switch is reachable over both IP and Fibre Channel, application data will be distributed over
Fibre Channel.
•
You can select either an IPv4 or IPv6 distribution when CFS is enabled over IP.
•
Both IPv4 and IPv6 distribution cannot be enabled on the same switch.
•
A switch that operate IPv4 distribution enabled cannot detect a switch that IPv6 distribution enabled.
The switches behave as if they are in two different fabrics even though they are connected to each
other.
The following example shows how to disable CFS IPv6 distribution:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# no cfs ipv6 distribute
This will prevent CFS from distributing over IPv6 network.
Are you sure? (y/n) [n]
The following example shows how to reenable CFS IPv6 distribution:
switch# config terminal
Cisco MDS 9000 Family Command Reference
4-14
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cfs ipv6 distribute
Enter configuration commands, one per line.
switch(config)# cfs ipv6 distribute
Related Commands
End with CNTL/Z.
Command
Description
cfs ipv6 mcast-address
Configures an IPv6 multicast address for Cisco Fabric Services (CFS)
distribution over IPv6.
show cfs status
Displays whether CFS distribution is enabled or disabled.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-15
Chapter 4
C Commands
cfs ipv6 mcast-address
cfs ipv6 mcast-address
To configure an IPv6 multicast address for Cisco Fabric Services (CFS) distribution over IPv6, use the
cfs ipv6 mcast-address command in configuration mode. To disable this feature, use the no form of the
command.
cfs ipv6 mcast-address ipv6-address
no cfs ipv6 mcast-address ipv6-address
Syntax Description
ipv6-address
Defaults
Multicast address: ff15::efff:4653.
Command Modes
Configuration mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
An IPv6 multicast address or CFS distribution over IPv6. The IPv6 Admin
scope range is [ff15::/16, ff18::/16].
Before using this command, enable CFS distribution over IPv6 using the cfs ipv6 distribute command.
All CFS over IP enabled switches with similar multicast addresses form one CFS over IP fabric. CFS
protocol specific distributions, such as the keepalive mechanism for detecting network topology
changes, use the IP multicast address to send and receive information.
Note
CFS distributions for application data use directed unicast.
You can configure a CFS over IP multicast address value for IPv6. The default IPv6 multicast address is
ff15::efff:4653. Examples of the IPv6 Admin scope range are ff15::0000:0000 to ff15::ffff:ffff and
ff18::0000:0000 to ff18::ffff:ffff.
Examples
The following example shows how to configure an IP multicast address for CFS over IPv6:
switch# config t
switch(config)# cfs ipv6 mcast-address ff13::e244:4754
Distribution over this IP type will be affected
Change multicast address for CFS-IP ?
Are you sure? (y/n) [n] y
The following example shows how to revert to the default IPv6 multicast address for CFS distribution
over IPv6. The default IPv6 multicast address for CFS is ff13:7743:4653.
switch(config)# no cfs ipv6 ff13::e244:4754
Distribution over this IP type will be affected
Cisco MDS 9000 Family Command Reference
4-16
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cfs ipv6 mcast-address
Change multicast address for CFS-IP ?
Are you sure? (y/n) [n] y
Related Commands
Command
Description
cfs ipv6 distribute
Enables or disables Cisco Fabric Services (CFS) distribution over IPv6.
show cfs status
Displays whether CFS distribution is enabled or disabled.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-17
Chapter 4
C Commands
cfs region
cfs region
To create a region that restricts the scope of application distribution to the selected switches, use the cfs
region command in the configuration mode. To disable this feature, use the no form of this command.
cfs region region-id
no cfs region region-id
Syntax Description
region-id
Defaults
None.
Assigns an application to a region. A total of 200 regions are supported.
Configuration mode
Command History
Usage Guidelines
Release
Modification
3.2(1)
This command was introduced.
An application can only be a part of one region on a given switch. By creating the region ID and
assigning it to an application, the application distribution is restricted to switches with a similar region
ID.
Cisco Fabric Services (CFS) regions provide the ability to create distribution islands within the
application scope. Currently, the regions are supported only for physical scope applications. In the
absence of any region configuration, the application will be a part of the default region. The default
region is region ID 0. This command provides backward compatibility with the earlier release where
regions were not supported. If applications are assigned to a region, the configuration check will prevent
the downgrade. Fabric Manager supports CFS regions.
Examples
The following example shows how to create a region ID:
switch# config
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# cfs region 1
The following example shows how to assign an application to a region:
switch# cfs region 1
switch# config
Enter configuration commands, one per line.
switch(config)# cfs region 1
switch(config-cfs-region)# ntp
Note
End with CNTL/Z.
The applications assigned to a region have to be registered with CFS.
The following example shows how to remove an application assigned to a region:
switch# cfs region 1
Cisco MDS 9000 Family Command Reference
4-18
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cfs region
switch# config
Enter configuration commands, one per line.
switch(config)# cfs region 1
switch(config-cfs-region)# no ntp
End with CNTL/Z.
The following example shows how to remove all the applications from a region:
switch(config)# no cfs region 1
WARNING: All applications in the region wiil be
Are you sure? (y/n) [n] y
Related Commands
moved to default region.
Command
Description
show cfs regions
Displays all configured applications with peers.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-19
Chapter 4
C Commands
cfs static-peers
cfs static-peers
To enable static peers interface, use the cfs static-peers command. To disable this feature, use the no
form of the command.
cfs static-peers
no cfs static-peers
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled.
Command Modes
Configuration mode
Command History
Release
Modification
4.1(1b)
This command was introduced.
Usage Guidelines
Note
Examples
This command enables the static peers with status and all the peers in the physical fabric.
The no cfs static-peers displays a warning string, and changes the entire fabric from static to dynamic.
The following example shows how to enable static peers interface:
Switch(config)# cfs static-peers
Warning: This mode will stop dynamic discovery and relay only on these peers.
Do you want to continue?(y/n) [n] y
Switch(config-cfs-static)#ip address 209.165.200.226
Switch(config-cfs-static)#ip address 209.165.200.227
Switch(config-cfs-static)#exit
Switch(config)#
Related Commands
Command
Description
show cfs static peers
Displays configured static peers with status.
Cisco MDS 9000 Family Command Reference
4-20
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
channel mode active
channel mode active
To enable channel mode on a PortChannel interface, use the channel mode active command. To disable
this feature, use the no form of the command.
channel mode active
no channel mode
Syntax Description
This command has no other arguments or keywords.
Defaults
Enabled.
Command Modes
Interface configuration submode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
This command determines the protocol operate for all the member ports in the channel group associated
with the port channel interface.
Examples
The following example shows how to disable channel mode on a PortChannel interface:
switch# config terminal
switch(config)# interface port-channel 10
switch(config-if)# no channel mode active
Related Commands
Command
Description
show interface port-channel
Displays PortChannel interface information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-21
Chapter 4
C Commands
channel-group
channel-group
To add a port to a PortChannel group, use the channel-group command. To remove a port, use the no
form of the command.
channel-group {port-channel number force}
no channel-group {port-channel number force}
Syntax Description
port-channel number
The PortChannel number. The range is 1 to 256.
force
Specifies the PortChannel to add a port, without compatibility check of port
parameters, port mode and port speed.
Defaults
None
Command Modes
Interface configuration mode
Command History
Release
Modification
NX-OS 4.1(3)
Deleted auto keyword from the syntax description.
3.0(1)
This command was introduced.
Usage Guidelines
When ports are added to a PortChannel, manager checks for incompatibility in the port mode and port speed.
If the ports are being added to the PortChannel, do not have compatible parameters, the ports will not be added
to the PortChannel. The force option bypasses, the port parameter compatibility check, and adds the port to
a PortChannel. It also forces the individual member interfaces to inherit the port parameters configured on the
PortChannel itself. If you configure switchport speed 4000 on the PortChannel then the member inerface is
forced to that setting.
force option is used to override the port's parameters. The auto mode support is not available after Release
4.x. To convert auto PortChannel to active mode PortChannel, use the port-channel persistent command.
This command needs to be run on both sides of the auto Port Channel.
Examples
The following example shows how to add a port to the PortChannel:
switch# config terminal
switch(config)# interface fc 1/1
switch(config-if)# channel-group 2 force
fc1/1 added to port-channel 2 and disabled
please do the same operation on the switch at the other end of the port-channel,
then do "no shutdown" at both end to bring them up
switch(config-if)#
Cisco MDS 9000 Family Command Reference
4-22
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
channel-group
Related Commands
Command
Description
show interface port-channel
Displays the PortChannel interface information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-23
Chapter 4
C Commands
cimserver
cimserver
To configure the Common Information Models (CIM) parameters, use the cimserver command. Use the
no form of this command to revert to factory defaults.
cimserver {certificate {bootflash:filename | slot0:filename | volatile:filename} | clearcertificate
filename | enable | enablehttp | enablehttps
no cimserver {certificate {bootflash:filename | slot0:filename | volatile:filename} |
clearcertificate filename | enable | enablehttp | enablehttps}
Syntax Description
certificate
Installs the Secure Socket Layer (SSL) certificate
bootflash:
Specifies the location for internal bootflash memory.
filename
The name of the license file with a .pem extension.
slot0: filename
Specifies the location for the CompactFlash memory or PCMCIA card.
volatile: filename
Specifies the location for the volatile file system.
clearcertificate
filename
Clears a previously installed SSL certificate.
enable
Enables and starts the CIM server.
enablehttp
Enables the HTTP (non-secure) protocol for the CIM server (default).
enablehttps
Enables the HTTPS (secure) protocol for the CIM server.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
1.3(1)
This command was introduced.
5.2(1)
This command was deprecated.
Usage Guidelines
A CIM client is required to access the CIM server. The client can be any client that supports CIM.
Cisco MDS 9000 Family Command Reference
4-24
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cimserver
Examples
The following example installs a Secure Socket Layer (SSL) certificate specified in the file named with
a .pem extension:
switch# config terminal
switch(config)# cimserver certificateName bootflash:simserver.pem
The following example clears the specified SSL certificate:
switch(config)# cimserver clearCertificateName bootflash:simserver.pem
Related Commands
Command
Description
show csimserver
Displays configured CIM settings and parameters.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-25
Chapter 4
C Commands
cimserver clearcertificate
cimserver clearcertificate
To clear the cimserver certificate, use the cimsever clearcertificate command in configuration mode.
cimserver clearcertificate
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
3.3(1a)
This command was introduced.
5.2(1)
This command was deprecated.
Usage Guidelines
You need not specify the certificate name.
Examples
The following example shows how to clear the cimserver certificate:
switch# config
Enter configuration commands, one per line.
switch(config)# cimserver clearcertificate
Related Commands
End with CNTL/Z.
Command
Description
show cimserver
certificate name
Displays the cimserver certificate filename.
Cisco MDS 9000 Family Command Reference
4-26
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cimserver loglevel
cimserver loglevel
To configure the cimserver log level filter, use the cimsever loglevel command in configuration mode.
cimserver loglevel filter value
Syntax Description
filter value
1–Specifies the cimserver log filter levels. The range is 1 to 5.
2–Sets the current value for the log level property to trace.
3–Sets the current value for the log level property to information.
4–Sets the current value for the log level property to warning.
5–Sets the current value for the log level property to severe.
6–Sets the current value for the log level property to fatal.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
3.3(1a)
This command was introduced.
5.2(1)
This command was deprecated.
Usage Guidelines
None
Examples
The following example displays the cimserver log level:
switch# config
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# cimserver loglevel 2
Current value for the property logLevel is set to "INFORMATION" in CIMServer.
Related Commands
Command
Description
show cimserver logs
Displays the cimserver logs.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-27
Chapter 4
C Commands
class
class
To select a QoS policy map class for configuration, use the class command in QoS policy map
configuration submode. To disable this feature, use the no form of the command.
class class-map-name
no class class-map-name
Syntax Description
class-map-name
Defaults
Disabled
Command Modes
QoS policy map configuration submode
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
The QoS policy class map to configure.
Before you can configure a QoS policy map class you must complete the following:
•
Enable the QoS data traffic feature using the qos enable command.
•
Configure a QoS class map using the qos class-map command.
•
Configure a QoS policy map using the qos policy-map command.
After you configure the QoS policy map class, you can configure the Differentiated Services Code Point
(DSCP) and priority for frames matching this class map.
Examples
The following example shows how to select a QoS policy map class to configure:
switch# config terminal
Enter configuration commands, one per line.
switch(config)# qos enable
switch(config)# qos class-map class-map1
switch(config)# qos policy-map policyMap1
switch(config-pmap)# class class-map1
switch(config-pmap-c)#
Related Commands
End with CNTL/Z.
Command
Description
dscp
Configures the DSCP in the QoS policy map class.
qos class-map
Configures a QoS class map.
qos enable
Enables the QoS data traffic feature on the switch.
qos policy-map
Configures a QoS policy map.
Cisco MDS 9000 Family Command Reference
4-28
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
class
Command
Description
priority
Configures the priority in the QoS policy map class.
show qos
Displays the current QoS settings.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-29
Chapter 4
C Commands
clear accounting log
clear accounting log
To clear the accounting log, use the clear accounting log command.
clear accounting log
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None
Examples
The following example clears the accounting log:
switch# clear accounting session
Related Commands
Command
Description
show accounting log
Displays the accounting log contents.
Cisco MDS 9000 Family Command Reference
4-30
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear arp-cache
clear arp-cache
To clear the ARP cache table entries, use the clear arp-cache command in EXEC mode.
clear arp-cache
Syntax Description
This command has no arguments or keywords.
Defaults
The ARP table is empty by default.
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Examples
The following example shows how to clear the arp-cache table entries:
switch# clear arp-cache
Related Commands
Command
Description
show arp
Displays Address Resolution Protocol (ARP) entries.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-31
Chapter 4
C Commands
clear asic-cnt
clear asic-cnt
To clear ASCI counters, use the clear asic-cnt command in EXEC mode.
clear asic-cnt {all | device-id | list-all-devices}
Syntax Description
all
Clears the counter for all device types.
device-id
Clears the counter for device type device ID.
list-all-devices
Lists all device types.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Examples
The following example shows how to clear all counters on the module:
switch(config)# attach module 4
Attaching to module 4 ...
To exit type 'exit', to abort type '$.'
Last login: Mon Jan 5 13:04:02 2009 from 127.1.1.8 on pts/0
Linux lc04 2.6.10_mvl401-pc_target #1 Tue Dec 16 22:58:32 PST 2008 ppc GNU/Linux
module-4# clear asic-cnt all
Cleared counters for asic type id = 63, name = 'Stratosphere'
Cleared counters for asic type id = 46, name = 'transceiver'
Cleared counters for asic type id = 57, name = 'Skyline-asic'
Cleared counters for asic type id = 60, name = 'Skyline-ni'
Cleared counters for asic type id = 59, name = 'Skyline-xbar'
Cleared counters for asic type id = 58, name = 'Skyline-fwd'
Cleared counters for asic type id = 52, name = 'Tuscany-asic'
Cleared counters for asic type id = 54, name = 'Tuscany-xbar'
Cleared counters for asic type id = 55, name = 'Tuscany-que'
Cleared counters for asic type id = 53, name = 'Tuscany-fwd'
Cleared counters for asic type id = 73, name = 'Fwd-spi-group'
Cleared counters for asic type id = 74, name = 'Fwd-parser'
Cleared counters for asic type id = 10, name = 'eobc'
Cleared counters for asic type id = 1, name = 'X-Bus IO'
Cleared counters for asic type id = 25, name = 'Power Mngmnt Epld'
module-4#
The following example shows how to clear the specific counter:
module-4# clear asic-cnt device-id 1
Clearing counters for devId = 1, name = 'X-Bus IO'
module-4#
Cisco MDS 9000 Family Command Reference
4-32
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear asic-cnt
The following example shows how to list all device IDs:
module-4# clear asic-cnt list-all-devices
Asic Name
Stratosphere
transceiver
Skyline-asic
Skyline-ni
Skyline-xbar
Skyline-fwd
Tuscany-asic
Tuscany-xbar
Tuscany-que
Tuscany-fwd
Fwd-spi-group
Fwd-parser
eobc
X-Bus IO
Power Mngmnt Epld
module-4#
Related Commands
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Device ID
63
46
57
60
59
58
52
54
55
53
73
74
10
1
25
Command
Description
show arp
Displays Address Resolution Protocol (ARP) entries.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-33
Chapter 4
C Commands
clear callhome session
clear callhome session
To clear Call Home Cisco Fabric Services (CFS) session configuration and locks, use the clear callhome
session command.
clear callhome session
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to clear the Call Home session configuration and locks:
switch# clear callhome session
Related Commands
Command
Description
show callhome
Displays Call Home information.
Cisco MDS 9000 Family Command Reference
4-34
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear cdp
clear cdp
To delete global or interface-specific CDP configurations, use the clear cdp command.
clear cdp {counters | table} [interface {gigabitethernet slot/port | mgmt 0}]
Syntax Description
counters
Enables CDP on globally or on a per-interface basis.
table
Specifies the EXEC command to be executed.
interface
(Optional) Displays CDP parameters for an interface.
gigabitethernet
Specifies the Gigabit Ethernet interface.
slot/port
Specifies the slot number and port number separated by a slash (/).
mgmt 0
Specifies the Ethernet management interface.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
1.1(1)
This command was introduced.
Usage Guidelines
You can use this command for a specified interface or for all interfaces (management and Gigabit
Ethernet interfaces).
Examples
The following example clears CDP traffic counters for all interfaces:
switch# clear cdp counters
switch#
The following example clears CDP entries for the specified Gigabit Ethernet interface:
switch# clear cdp table interface gigabitethernet 4/1
switch#
Related Commands
Command
Description
cdp
Configures global or interface-specific CDP settings and parameters.
show cdp
Displays configured CDP settings and parameters.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-35
Chapter 4
C Commands
clear cores
clear cores
To clear all core dumps for the switch, use the clear cores command in EXEC mode.
clear cores
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
The system software keeps the last few cores per service and per slot and clears all other cores present
on the active supervisor module.
Examples
The following example shows how to clear all core dumps for the switch:
switch# clear cores
Related Commands
Command
Description
show cores
Displays core dumps that have been made.
Cisco MDS 9000 Family Command Reference
4-36
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear counters (EXEC mode)
clear counters (EXEC mode)
To clear the interface counters, use the clear counters command in EXEC mode.
clear counters {all | interface {fc | mgmt | port-channel | sup-fc | vsan} number}
Syntax Description
all
Clears all interface counters.
interface
Clears interface counters for the specified interface.
number
The number of the slot or interface being cleared.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
The following table lists the number ranges interface types:
Keyword
Interface Type
Number
fc
Fibre Channel
1– 2 or 1– 9 (slot)
gigabitethernet
Gigabit Ethernet
1– 2 or 1– 9 (slot)
mgmt
Management
0–0 (management interface)
port-channel
PortChannel
1–128 (PortChannel)
sup-fc
Inband
0–0 (Inband interface)
vsan
VSAN
1– 4093 (VSAN ID)
This command clears counters displayed in the show interface command output.
Examples
The following example shows how to clear counters for a VSAN interface:
switch# clear counters interface vsan 13
Related Commands
Command
Description
show interface
Displays interface information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-37
Chapter 4
C Commands
clear counters interface all
clear counters interface all
To clear all interface counters, use the clear counters interface all command.
clear counters interface all snmp
Syntax Description
snmp
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
6.2(1)
Added the snmp option to the syntax description.
Clears SNMP interface counters.
Usage Guidelines
This command clears counter displayed in the show interface command output.
Examples
The following example shows how to clear all SNMP interface counters:
switch(config)# clear counters interface all snmp
switch(config)#
Related Commands
Command
Description
show interface
Displays interface information.
Cisco MDS 9000 Family Command Reference
4-38
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear counters interface
clear counters interface
To clear the aggregate counters for the interface, use the clear counters interface command.
clear counters interface interface snmp
Syntax Description
interface
Specifies the interface.
snmp
Clears SNMP interface counters.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
6.2(1)
Added the snmp option to the syntax description.
Usage Guidelines
This command clears counter displayed in the show interface command output.
Examples
The following example shows how to clear the aggregate counters for the interface:
switch(config)# clear counters interface e2/1 snmp
switch(config)#
Related Commands
Command
Description
show interface
Displays interface information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-39
Chapter 4
C Commands
clear counters (SAN extension N port configuration mode)
clear counters (SAN extension N port configuration mode)
To clear SAN extension tuner N port counters, use the clear counters command.
clear counters
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
SAN extension N port configuration submode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to clear SAN extension tuner N port counters:
switch# san-ext-tuner
switch(san-ext)# nWWN 10:00:00:00:00:00:00:00
switch(san-ext)# nport pwwn 12:00:00:00:00:00:00:56 vsan 13 interface gigabitethernet
1/2
switch(san-ext-nport)# clear counters
Related Commands
Command
Description
show san-ext-tuner
Displays SAN extension tuner information.
Cisco MDS 9000 Family Command Reference
4-40
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear crypto ike domain ipsec sa
clear crypto ike domain ipsec sa
To clear the IKE tunnels for IPsec, use the clear crypto ike domain ipsec sa command.
clear crypto ike domain ipsec sa [tunnel-id]
Syntax Description
tunnel-id
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
(Optional) The tunnel ID. The range is 1 to 2147483647.
To use this command, the IKE protocol must be enabled using the crypto ike enable command.
If the tunnel ID is not specified, all IKE tunnels are cleared.
Note
Examples
The crypto ikes feature is not supported on the Cisco MDS 9148 and Cisco MDS 9148S Switches.
The following example shows how to clear all IKE tunnels:
switch# clear crypto ike domain ipsec sa
Related Commands
Command
Description
crypto ike domain ipsec
Configures IKE information.
crypto ike enable
Enables the IKE protocol.
show crypto ike domain
ipsec
Displays IKE information for the IPsec domain.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-41
Chapter 4
C Commands
clear crypto sa domain ipsec
clear crypto sa domain ipsec
To clear the security associations for IPsec, use the clear crypto sa domain ipsec command.
clear crypto sa domain ipsec interface gigabitethernet slot/port {inbound | outbound}
sa sa-index
Syntax Description
interface gigabitethernet
slot/port
Specifies the Gigabit Ethernet interface.
inbound
Specifies clearing inbound associations.
outbound
Specifies clearing output associations.
sa sa-index
Specifies the security association index. The range is 1 to 2147483647.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To clear security associations, IPsec must be enabled using the crypto ipsec enable command.
Examples
The following example shows how to clear a security association for an interface:
switch# clear crypto sa domain ipsec interface gigabitethernet 1/2 inbound sa 1
Related Commands
Command
Description
show crypto sad
domain ipsec
Displays IPsec security association database information.
Cisco MDS 9000 Family Command Reference
4-42
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear debug-logfile
clear debug-logfile
To delete the debug log file, use the clear debug-logfile command in EXEC mode.
clear debug-logfile filename
Syntax Description
filename
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Examples
The name (restricted to 80 characters) of the log file to be cleared. The
maximum size of the log file is 1024 bytes.
The following example shows how to clear the debug logfile:
switch# clear debug-logfile debuglog
Related Commands
Command
Description
show debug logfile
Displays the log file contents.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-43
Chapter 4
C Commands
clear device-alias
clear device-alias
To clear device alias information, use the clear device-alias command.
clear device-alias {database | session | statistics}
Syntax Description
databse
Clears the device alias database.
session
Clears session information.
statistics
Clears device alias statistics.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to clear the device alias session:
switch# clear device-alias session
Related Commands
Command
Description
show device-alias
Displays device alias database information.
Cisco MDS 9000 Family Command Reference
4-44
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear dpvm
clear dpvm
To clear Dynamic Port VSAN Membership (DPVM) information, use the clear dpvm command.
clear dpvm {auto-learn [pwwn pwwn-id] | session}
Syntax Description
auto-learn
Clears automatically learned (autolearn) DPVM entries.
pwwn pwwn-id
(Optional) Specifies the pWWN ID. The format is
hh:hh:hh:hh:hh:hh:hh:hh, where h is a hexadecimal number.
session
Clears the DPVM session and locks.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, DVPM must be enabled using the dpvm enable command.
Examples
The following example shows how to clear a single autolearned entry:
switch# clear dpvm auto-learn pwwn 21:00:00:20:37:9c:48:e5
The following example shows how to clear all autolearn entries:
switch# clear dpvm auto-learn
The following example shows how to clear a session:
switch# clear dpvm session
Related Commands
Command
Description
dpvm enable
Enables DPVM.
show dpvm
Displays DPVM database information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-45
Chapter 4
C Commands
clear dpvm merge statistics
clear dpvm merge statistics
To clear the DPVM merge statistics, use the clear dpvm merge statistics command.
clear dpvm merge statistics
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
NX-OS 4.1(1b)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to clear the DPVM merge statistics:
switch#(config)# clear dpvm merge statistics
switch#(config)#
Related Commands
Command
Description
show dpvm merge statistics
Displays the DPVM merge statistics.
Cisco MDS 9000 Family Command Reference
4-46
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear fabric-binding statistics
clear fabric-binding statistics
To clear fabric binding statistics in a FICON enabled VSAN, use the clear fabric-binding statistics
command in EXEC mode.
clear fabric-binding statistics vsan vsan-id
Syntax Description
vsan vsan-id
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.1(1)
This command was introduced.
Specifies the FICON-enabled VSAN. The ID of the VSAN is from 1 to 4093.
Usage Guidelines
None
Examples
The following example clears existing fabric binding statistics in VSAN 1:
switch# clear fabric-binding statistics vsan 1
Related Commands
Command
Description
show fabric-binding efmd statistics
Displays existing fabric binding statistics information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-47
Chapter 4
C Commands
clear fcanalyzer
clear fcanalyzer
To clear the entire list of configured hosts for remote capture, use the clear fcanalyzer command in
EXEC mode.
clear fcanalyzer
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
This command clears only the list of configured hosts. Existing connections are not terminated.
Examples
The following example shows how to clear the entire list of configured hosts for remote capture:
switch# clear fcanalyzer
Related Commands
Command
Description
show fcanalyzer
Displays the list of hosts configured for a remote capture.
Cisco MDS 9000 Family Command Reference
4-48
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear fcflow stats
clear fcflow stats
To clear Fibre Channel flow statistics, use the clear fcflow stats command in EXEC mode.
clear fcflow stats [aggregated] module module-number index flow-number
Syntax Description
aggregated
(Optional) Clears the Fibre Channel flow aggregated statistics.
module
Clears the statistics for a specified module.
module-number
Specifies the module number.
index
Clears the Fibre Channel flow counters for a specified flow index.
flow-number
Specifies the flow index number.
Defaults
None
Command Modes
EXEC
Command History
Release
Modification
1.0(2)
This command was introduced.
Examples
The following example shows how to clear aggregated Fibre Channel flow statistics for flow index 1 of
module 2:
switch(config)# clear fcflow stats aggregated module 2 index 1
Related Commands
Command
Description
show fcflow
Displays the fcflow statistics.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-49
Chapter 4
C Commands
clear fcns statistics
clear fcns statistics
To clear the name server statistics, use the clear fcns statistics command in EXEC mode.
clear fcns statistics vsan vsan-id
Syntax Description
vsan vsan-id
Defaults
None
Command Modes
EXEC
Command History
Release
Modification
1.0(3)
This command was introduced.
Examples
Clears FCS statistics for a specified VSAN ranging from 1 to 4093.
The following example shows how to clear the name server statistics:
switch# show fcns statistics
Name server statistics for vsan 1
===================================
registration requests received = 0
deregistration requests received = 0
queries received = 23
queries sent = 27
reject responses sent = 23
RSCNs received = 0
RSCNs sent = 0
switch# clear fcns statistics vsan 1
switch# show fcns statistics
Name server statistics for vsan 1
===================================
registration requests received = 0
deregistration requests received = 0
queries received = 0
queries sent = 0
reject responses sent = 0
RSCNs received = 0
RSCNs sent = 0
switch#
Related Commands
Command
Description
show fcns statistics
Displays the name server statistics.
Cisco MDS 9000 Family Command Reference
4-50
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear fcs statistics
clear fcs statistics
To clear the fabric configuration server statistics, use the clear fcs statistics command in EXEC mode.
clear fcs statistics vsan vsan-id
Syntax Description
vsan vsan-id
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Examples
FCS statistics are to be cleared for a specified VSAN ranging from 1 to
4093.
The following example shows how to clear the fabric configuration server statistics for VSAN 10:
switch# clear fcs statistics vsan 10
Related Commands
Command
Description
show fcs statistics
Displays the fabric configuration server statistics information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-51
Chapter 4
C Commands
clear fctimer session
clear fctimer session
To clear fctimer Cisco Fabric Services (CFS) session configuration and locks, use the clear fctimer
session command.
clear fctimer session
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to clear fctimer session:
switch# clear fctimer session
Related Commands
Command
Description
show fctimer
Displays fctimer information.
Cisco MDS 9000 Family Command Reference
4-52
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear fc-redirect config
clear fc-redirect config
To delete a FC-Redirect configuration on a switch, use the clear fc-redirect config command.
clear fc-redirect config vt vt-pwwn [local-switch-only]
Syntax Description
vt vt-pwwn
Specify the VT pWWN for the configuration to be deleted.
local-switch-only
(Optional) The configuration is deleted locally only.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.2(1)
This command was introduced.
Usage Guidelines
This command is used as a last option if deleting the configuration through the application is not
possible.
This command will delete any configuration (including active configurations) on FC-Redirect created
by applications such as SME/DMM that may lead to data loss. When you enter this command, the host
server communicates to the storage array directly by passing the individual Intelligent Service
Applications causing data corruption. Use this command as a last option to clear any leftover
configuration that cannot be deleted from the application (DMM/SME). Use this command while
decommissioning the switch.
Examples
The following example clears the FC-Redirect configuration on the switch:
switch# clear fc-redirect config vt 2f:ea:00:05:30:00:71:64
Deleting a configuration MAY result in DATA CORRUPTION.
Do you want to continue? (y/n) [n] y
Related Commands
Command
Description
show fc-redirect
active-configs
Displays all active configurations on the switch.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-53
Chapter 4
C Commands
clear fc-redirect decommission-switch
clear fc-redirect decommission-switch
To remove all existing FC-Redirect configurations and disable any further FC-Redirect configurations
on a switch, use the clear fc-redirect decommission-switch command.
clear fc-redirect decommission-switch
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.2(1)
This command was introduced.
Usage Guidelines
This command is used after write erase. The command is also used to move a switch from a fabric with
FC-Redirect configurations to another fabric. After using this command, disconnect the switch from the
fabric and reboot the switch before using it in another fabric.
Examples
The following example shows how to decommission FC-Redirect on a switch:
switch# clear fc-redirect decommission-switch
This Command removes any FC-Redirect configuration and disables
FC-Redirect on this switch. Its usage is generally recommended in
the following cases:
1) After 'write erase'
2) When removing the switch from the fabric.
If NOT for the above, Decommissioning a switch MAY result in
DATA CORRUPTION.
Do you want to continue? (Yes/No) [No] Yes
Please check the following before proceeding further:
1) Hosts / targets connected locally are NOT involved in any
FC-Redirect configuration.
2) No application running on this switch created an FC-Redirect
Configuration
Please use the command 'show fc-redirect active-configs' to check
these.
Do you want to continue? (Yes/No) [No] Yes
switch#
Cisco MDS 9000 Family Command Reference
4-54
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear fc-redirect decommission-switch
Related Commands
Command
Description
show fc-redirect
active-configs
Displays all active configurations on a switch.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-55
Chapter 4
C Commands
clear ficon
clear ficon
Use the clear ficon command in EXEC mode to clear the FICON information for the specified VSAN.
clear ficon vsan vsan-id [allegiance | timestamp]
Syntax Description
vsan vsan-id
Specifies the FICON-enabled VSAN. The ID of the VSAN is from 1 to 4093.
allegiance
(Optional) Clears the FICON device allegiance.
timestamp
(Optional) Clears the FICON VSAN specific timestamp.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
The clear ficon vsan vsan-id allegiance command aborts the currently executing session.
Examples
The following example clears the current device allegiance for VSAN 1:
switch# clear ficon vsan 1 allegiance
The following example clears the VSAN clock for VSAN 20:
switch# clear ficon vsan 20 timestamp
Related Commands
Command
Description
show ficon
Displays configured FICON details.
Cisco MDS 9000 Family Command Reference
4-56
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear fspf counters
clear fspf counters
To clear the Fabric Shortest Path First statistics, use the clear fspf counters command in EXEC mode.
clear fspf counters vsan vsan-id [interface type]
Syntax Description
vsan
Indicates that the counters are to be cleared for a VSAN.
vsan-id
The ID of the VSAN is from 1 to 4093.
interface type
(Optional). The counters are to be cleared for an interface. The interface
types are fc for Fibre Channel, and port-channel for PortChannel.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
If the interface is not specified, then all of the counters of a VSAN are cleared. If the interface is
specified, then the counters of the specific interface are cleared.
Examples
The following example clears the FSPF t statistics on VSAN 1:
switch# clear fspf counters vsan 1
The following example clears FSPF statistics specific to the Fibre Channel interface in VSAN 1, Slot 9
Port 32:
switch#
Related Commands
clear fspf counters vsan 1 interface fc 9/32
Command
Description
show fspf
Displays global FSPF information for a specific VSAN.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-57
Chapter 4
C Commands
clear install failure-reason
clear install failure-reason
To remove the upgrade failure reason log created during in-service software upgrades (ISSUs) on the
Cisco MDS 9124 Fabric Switch, use the clear install failure-reason command.
Caution
If you remove the upgrade failure reason log, then you will not have any information to help you debug
in the event of an ISSU failure.
clear install failure-reason
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.1(1)
This command was introduced.
Usage Guidelines
This command is supported only on the Cisco MDS 9124 Fabric Switch.
Examples
The following example removes all upgrade failure reason logs on a Cisco MDS 9124 Fabric Switch:
switch# clear install failure-reason
Related Commands
Command
Description
show install all
failure-reason
Displays the reasons why an upgrade cannot proceed in the event of an
ISSU failure.
show install all status
Displays the status of an ISSU on a Cisco MDS 9124 Fabric Switch.
Cisco MDS 9000 Family Command Reference
4-58
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear ip access-list counters
clear ip access-list counters
To clear IP access list counters, use the clear ip access-list counters command in EXEC mode.
clear ip access-list counters list-name
Syntax Description
list-name
Defaults
None
Command Modes
EXEC
Command History
Release
Modification
1.1(1)
This command was introduced.
Examples
Specifies the IP access list name (maximum 64 characters).
The following example clears the counters for an IP access list:
switch# clear ip access-list counters adminlist
Related Commands
Command
Description
show ip access-list
Displays IP access list information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-59
Chapter 4
C Commands
clear ips arp
clear ips arp
To clear ARP caches, use the clear ips arp command in EXEC mode.
clear ips arp {address ip-address | interface gigabitethernet module-number}
Syntax Description
address
Clears fcflow aggregated statistics.
ip-address
Enters the peer IP address.
interface
gigabitethernet
Specifies the Gigabit Ethernet interface.
module-number
Specifies the slot and port of the Gigabit Ethernet interface.
Defaults
None
Command Modes
EXEC
Command History
Release
Modification
1.1(1)
This command was introduced.
Examples
The ARP cache can be cleared in two ways: clearing just one entry or clearing all entries in the ARP
cache.
The following example clears one ARP cache entry:
switch# clear ips arp address 10.2.2.2 interface gigabitethernet 8/7
arp clear successful
The following example clears all ARP cache entries:
switch# clear ips arp interface gigabitethernet 8/7
arp clear successful
Cisco MDS 9000 Family Command Reference
4-60
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear ips stats
clear ips stats
To clear IP storage statistics, use the clear ips stats command in EXEC mode.
clear ips stats {all [interface gigabitethernet slot/port] | buffer interface gigabitethernet
slot/port | dma-bridge interface gigabitethernet slot/port | icmp interface gigabitethernet
slot/port | ip interface gigabitethernet slot/port | ipv6 traffic interface gigabitethernet
slot/port | mac interface gigabitethernet slot/port | tcp interface gigabitethernet slot/port}
Syntax Description
all
Clears all IPS statistics.
interface
gigabitethernet
(Optional) Clears the Gigabit Ethernet interface.
slot/port
Specifies the slot and port numbers.
buffer
Clears IP storage buffer information.
dma-bridge
Clears direct memory access (DMA) statistics.
icmp
Clears ICMP statistics.
ip
Clears IP statistics.
ipv6
Clears IPv6 statistics.
mac
Clears Ethernet MAC statistics.
tcp
Clears TCP statistics.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Examples
The following example clears all IPS statistics on the specified interface:
switch# clear ips all interface gigabitethernet 8/7
switch#
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-61
Chapter 4
C Commands
clear ips stats fabric interface
clear ips stats fabric interface
To clear the statistics for a given iSCSI or FCIP interface on a Cisco MDS 9000 18/4-Port Multi Service
Module IPS linecard, use the clear ips stats fabric interface command.
clear ips stats fabric interface [iscsi slot/port | fcip N]
Syntax Description
iscsi slot/port
(Optional) Clears Data Path Processor (DPP) fabric statistics for the iSCSI
interface.
fcip N
(Optional) Clears DPP fabric statistics for the FCIP interface.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example clears the statistics for a given iSCSI or FCIP interface:
switch# clear ips stats fabric interface fcip ?
<1-255> Fcip interface number
switch# clear ips stats fabric interface fcip 1
switch#
switch# clear ips stats fabric interface iscsi 1/1
switch#
Related Commands
Command
Description
show ips stats fabric
interface
Displays the fabric-related statistics for the given iSCSI or FCIP interface on
a Cisco MDS 9000 18/4-Port Multi Service Module IPS linecard.
Cisco MDS 9000 Family Command Reference
4-62
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear ipv6 access-list
clear ipv6 access-list
To clear IPv6 access control list statistics, use the clear ipv6 access-list command.
clear ipv6 access-list [list-name]
Syntax Description
access-list
Displays a summary of access control lists (ACLs).
list-name
(Optional) Specifies the name of the ACL. The maximum size is 64.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.1(0)
This command was introduced.
Usage Guidelines
You can use the clear ipv6 access-list command to clear IPv6-ACL statistics.
Examples
The following example displays information about an IPv6-ACL:
switch# clear ipv6 access-list testlist
switch#
Related Commands
Command
Description
ipv6 access-list
Configures an IPv6-ACL.
show ipv6
Displays IPv6 configuration information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-63
Chapter 4
C Commands
clear ipv6 neighbors
clear ipv6 neighbors
To clear the IPv6 neighbor cache table, use the clear ipv6 neighbors command.
clear ipv6 neighbors
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.1(0)
This command was introduced.
Usage Guidelines
None.
Examples
The following example flushes the IPv6 neighbor cache table:
switch# clear ipv6 neighbors
switch#
Related Commands
Command
Description
ipv6 nd
Configures IPv6 neighbor discovery commands.
show ipv6 neighbors
Displays IPv6 neighbors configuration information.
Cisco MDS 9000 Family Command Reference
4-64
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear islb session
clear islb session
To clear a pending iSLB configuration, use the clear islb session command.
clear islb session
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
You can use the clear islb session command to clear a pending iSLB configuration. This command can
be executed from any switch by a user with admin privileges.
Examples
The following example clears a pending iSLB configuration:
switch# clear islb session
Related Commands
Command
Description
islb abort
Discards a pending iSLB configuration.
show islb cfs-session
status
Displays iSLB session details.
show islb pending
Displays an iSLB pending configuration.
show islb pending-diff
Displays iSLB pending configuration differences.
show islb session
Displays iSLB session information.
show islb status
Displays iSLB CFS status.
show islb vrrp
Displays iSBL VRRP load balancing information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-65
Chapter 4
C Commands
clear ivr fcdomain database
clear ivr fcdomain database
To clear the IVR fcdomain database, use the clear ivr fcdomain database command in EXEC mode.
clear ivr fcdomain database
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.1(2)
This command was introduced.
Usage Guidelines
None
Examples
The following example clears all IVR fcdomain database information:
switch# clear ivr fcdomain database
Related Commands
Command
Description
show ivr fcdomain database
Displays IVR fcdomain database entry information.
Cisco MDS 9000 Family Command Reference
4-66
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear ivr service-group database
clear ivr service-group database
To clear an inter-VSAN routing (IVR) service group database, use the clear ivr service-group database
command.
clear ivr service-group database
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
None
Examples
The following example clears the ivr service-group database:
switch# clear ivr service-group database
Related Commands
Command
Description
show ivr service-group Displays an IVR service group database.
database
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-67
Chapter 4
C Commands
clear ivr zone database
clear ivr zone database
To clear the Inter-VSAN Routing (IVR) zone database, use the clear ivr zone database command in
EXEC mode.
clear ivr zone database
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC
Command History
Release
Modification
1.3(1)
This command was introduced.
Examples
The following example clears all configured IVR information:
switch# clear ivr zone database
Cisco MDS 9000 Family Command Reference
4-68
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear license
clear license
To uninstall a license, use the clear license command in EXEC mode.
clear license filename
Syntax Description
filename
Defaults
None
Command Modes
EXEC
Command History
Release
Modification
1.3(2)
This command was introduced.
Examples
Specifies the license file to be uninstalled.
The following example clears a specific license:
switch# clear license Ficon.lic
Clearing license Ficon.lic:
SERVER this_host ANY
VENDOR cisco
# An example fcports license
INCREMENT SAN_EXTN_OVER_IP cisco 1.000 permanent 1 HOSTID=VDH=ABCD \
NOTICE=<LicFileID>san_extn2.lic</LicFileID><LicLineID>1</LicLineID> \
SIGN=67CB2A8CCAC2
Do you want to continue? (y/n) y
Clearing license ..done
switch#
Related Commands
Command
Description
show license
Displays license information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-69
Chapter 4
C Commands
clear line
clear line
To clear VTY sessions, use the clear line command in EXEC mode.
clear line vty-name
Syntax Description
vty-name
Defaults
None
Command Modes
EXEC
Command History
Release
Modification
1.2(1)
This command was introduced.
Examples
Specifies the VTY name (maximum 64 characters).
The following example clears one ARP cache entry:
switch# clear line Aux
arp clear successful
Related Commands
Command
Description
show line
Displays line information.
Cisco MDS 9000 Family Command Reference
4-70
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear logging
clear logging
To delete the syslog information, use the clear logging command in EXEC mode.
clear logging {logfile | nvram | onboard information [module slot] | session}
Syntax Description
logfile
Clears log file messages.
nvram
Clears NVRAM logs.
onboard information
Clears onboard failure logging (OBFL) information. The types of
information include boot-uptime, cpu-hog, device-version, endtime,
environmental-history, error-stats, exception-log, interrupt-stats,
mem-leak, miscellaneous-error, module, obfl-history, obfl-log,
register-log, stack-trace, starttime, status, and system-health.
module slot
(Optional) Clears OBFL information for a specified module.
session
Clears a logging session.
Defaults
None
Command Modes
EXEC
Command History
Release
Modification
1.0(2)
This command was introduced.
3.0(1)
Added the onboard, module and session options.
Examples
The following example shows how to clear the debug log file:
switch# clear logging logfile
The following example shows how to clear the onboard system health log file:
switch# clear logging onboard system-health
!!!WARNING! This will clear the selected logging buffer!!
Do you want to continue? (y/n) [n]
Related Commands
Command
Description
show logging
Displays logging information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-71
Chapter 4
C Commands
clear ntp
clear ntp
To clear Network Time Protocol (NTP) information, use the clear ntp command in EXEC mode.
clear ntp {session | statistics {all-peers | io | local | memory}}
Syntax Description
session
Clears NTP CFS session configuration and locks.
statistics
Clears NTP statistics.
all-peers
Clears I/O statistics for all peers.
io
Clears I/O statistics for I/O devices.
local
Clears I/O statistics for local devices.
memory
Clears I/O statistics for memory.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to clear NTP statistics for all peers:
switch# clear ntp statistics all-peers
The following example shows how to clear NTP statistics for I/O devices:
switch# clear ntp statistics io
The following example shows how to clear NTP statistics for local devices:
switch# clear ntp statistics local
The following example shows how to clear NTP statistics for memory:
switch# clear ntp statistics memory
Related Commands
Command
Description
show ntp
Displays the configured server and peer associations.
Cisco MDS 9000 Family Command Reference
4-72
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear port-security
clear port-security
To clear the port security information on the switch, use the clear port-security command in EXEC
mode.
clear port-security {database auto-learn {interface fc slot/port | port-channel port} | session |
statistics} vsan vsan-id
Syntax Description
database
Clears the port security active configuration database.
auto-learn
Clears the auto-learn entries for a specified interface or VSAN.
interface fc slot/port
Clears entries for a specified interface.
port-channel port
Clears entries for a specified PortChannel. The range is 1 to 128.
session
Clears the port security CFS configuration session and locks.
statistics
Clears the port security counters.
vsan vsan-id
Clears entries for a specified VSAN ID. The range is 1 to 4093.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.2(1)
This command was introduced.
2.0(x)
Added the session option.
Usage Guidelines
The active database is read-only and clear port-security database command can be used when
resolving conflicts.
Examples
The following example clears all existing statistics from the port security database for a specified VSAN:
switch# clear port-security statistics vsan 1
The following example clears learnt entries in the active database for a specified interface within a
VSAN:
switch# clear port-security database auto-learn interface fc1/1 vsan 1
The following example clears learnt entries in the active database up to for the entire VSAN:
switch# clear port-security database auto-learn vsan 1
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-73
Chapter 4
C Commands
clear port-security
Related Commands
Command
Description
show port-security
Displays the configured port security information.
Cisco MDS 9000 Family Command Reference
4-74
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear processes log
clear processes log
To clear the log files on the switch, use the clear processes log command in EXEC mode.
clear processes log {all | pid pid-number}
Syntax Description
all
Deletes all of the log files.
pid
Deletes the log files of a specific process.
pid-number
Specifies the process ID, which must be from 0 to 2147483647.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to clear all of the log files on the switch :
switch# clear processes log all
Related Commands
Command
Description
show processes
Displays the detailed running or log information of processes or high
availability applications.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-75
Chapter 4
C Commands
clear qos statistics
clear qos statistics
To clear the quality of services statistics counters, use the clear qos statistics command in EXEC mode.
clear qos statistics
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to clear the quality of service counters:
switch# clear qos statistics
Related Commands
Command
Description
show qos statistics
Displays the current QoS settings, along with a number of frames marked
high priority.
Cisco MDS 9000 Family Command Reference
4-76
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear radius-server statistics
clear radius-server statistics
To clear radius server statistics, use the clear radius-server statistics command.
clear radius-server statistics {name}
Syntax Description
name
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Specifies the RADIUS name or IP address.
Usage Guidelines
None
Examples
The following example shows how to clear the statistics sent or received from the specified server:
switch(config)# clear radius-server statistics 10.64.65.57
switch(config)#
Related Commands
Command
Description
tacacs+ enable
Enables TACACS+.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-77
Chapter 4
C Commands
clear radius session
clear radius session
To clear RADIUS Cisco Fabric Services (CFS) session configuration and locks, use the clear radius
session command.
clear radius session
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to clear RADIUS session:
switch# clear radius session
Related Commands
Command
Description
show radius
Displays RADIUS CFS distribution status and other details.
Cisco MDS 9000 Family Command Reference
4-78
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear rlir
clear rlir
To clear the Registered Link Incident Report (RLIR), use the clear rlir command in EXEC mode.
clear rlir {history | recent {interface fc slot/port | portnumber port-number} |
statistics vsan vsan-id}
Note
Syntax Description
On a Cisco Fabric Switch for HP c-Class BladeSystem and on a Cisco Fabric Switch for IBM
BladeCenter, the syntax differs as follows:
interface bay port | ext port
history
Clears RLIR link incident history.
recent
Clears recent link incidents.
interface fc slot/port
Clears entries for a specified interface.
bay port | ext port
Clears entries for a specified interface on a Cisco Fabric Switch for HP
c-Class BladeSystem and on a Cisco Fabric Switch for IBM
BladeCenter.
portnumber port-number
Displays the port number for the link incidents.
statistics
Clears RLIR statistics.
vsan vsan-id
Specifies the VSAN ID for which the RLIR statistics are to be cleared.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.3(1)
This command was introduced.
3.1(2)
Added the interface bay | ext option.
Usage Guidelines
None.
Examples
The following example clears all existing statistics for a specified VSAN:
switch# clear rlir statistics vsan 1
The following example clears the link incident history:
switch# clear rlir history
The following example clears recent RLIR information for a specified interface:
switch# clear rlir recent interface fc 1/2
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-79
Chapter 4
C Commands
clear rlir
The following example clears recent RLIR information for a specified port number:
switch# clear rlir recent portnumber 16
Related Commands
Command
Description
show rscn
Displays RSCN information.
Cisco MDS 9000 Family Command Reference
4-80
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear rmon alarms
clear rmon alarms
To clear all the 32-bit remote monitoring (RMON) alarms from the running configuration, use the clear
rmon alarms command.
clear rmon alarms
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.3(1a)
This command was introduced.
Usage Guidelines
You must save the changes to startup configuration to make them permanent.
Examples
The following example clears all 32-bit RMON alarms from the running configuration:
switch# clear rmon alarms
switch#
Related Commands
Command
Description
clear rmon all-alarms
Clears all the 32-bit and 64-bit RMON alarms.
clear rmon hcalarms
Clears all the 64-bit RMON alarms.
clear rmon log
Clears RMON log information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-81
Chapter 4
C Commands
clear rmon all-alarms
clear rmon all-alarms
To clear all the 32-bit and 64-bit RMON alarms from the running configuration, use the clear rmon
all-alarms command.
clear rmon all-alarms
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.3(1a)
This command was introduced.
Usage Guidelines
You must save the changes to startup configuration to make them permanent.
Examples
The following example clears all the 32-bit and 64-bit RMON alarms from the running configuration:
switch# clear rmon all-alarms
switch#
Related Commands
Command
Description
clear rmon alarms
Clears all the 32-bit RMON alarms.
clear rmon hcalarms
Clears all the 64-bit RMON alarms.
clear rmon log
Clears RMON log information.
Cisco MDS 9000 Family Command Reference
4-82
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear rmon hcalarms
clear rmon hcalarms
To clear all the 64-bit RMON alarms from the running configuration, use the clear rmon hcalarms
command.
clear rmon hcalarms
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.3(1a)
This command was introduced.
Usage Guidelines
You must save the changes to startup configuration to make them permanent.
Examples
The following example clears all the 64-bit RMON alarms from the running configuration:
switch# clear rmon hcalarms
switch#
Related Commands
Command
Description
clear rmon all-alarms
Clears all the 32-bit and 64-bit RMON alarms.
clear rmon alarms
Clears all the 32-bit RMON alarms.
clear rmon log
Clears RMON log information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-83
Chapter 4
C Commands
clear rmon log
clear rmon log
To clear all entries from RMON log on the switch, use the clear rmon log command.
clear rmon log
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.3(1a)
This command was introduced.
Usage Guidelines
None
Examples
The following example clears all entries from RMON log on the switch:
switch# clear rmon log
switch#
Related Commands
Command
Description
clear rmon alarm
Clears all the 32-bit RMON alarms.
clear rmon hcalarms
Clears all the 64-bit RMON alarms.
clear rmon all-alarms
Clears all the 32-bit and 64-bit RMON alarms.
Cisco MDS 9000 Family Command Reference
4-84
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear role session
clear role session
To clear authentication role Cisco Fabric Services (CFS) session configuration and locks, use the clear
role session command.
clear role session
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to clear authentication role CFS session:
switch# clear role session
Related Commands
Command
Description
show role
Displays role configuration information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-85
Chapter 4
C Commands
clear rscn session vsan
clear rscn session vsan
To clear a Registered State Change Notification (RSCN) session for a specified VSAN, use the clear
rscn session vsan command.
clear rscn session vsan vsan-id
Syntax Description
vsan-id
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Specifies a VSAN where the RSCN session should be cleared. The ID of the
VSAN is from 1 to 4093.
Usage Guidelines
None
Examples
The following example clears an RSCN session on VSAN 1:
switch# clear rscn session vsan 1
Related Commands
Command
Description
rscn
Configures an RSCN.
show rscn
Displays RSCN information.
Cisco MDS 9000 Family Command Reference
4-86
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear rscn statistics
clear rscn statistics
To clear the registered state change notification RSCN statistics for a specified VSAN, use the clear rscn
statistics command in EXEC mode.
clear rscn statistics vsan vsan-id
Syntax Description
vsan
The RSCN statistics are to be cleared for a VSAN.
vsan-id
The ID for the VSAN for which you want to clear RSCN statistics.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to clear RSCN statistics for VSAN 1:
switch# clear rscn statistics 1
Related Commands
Command
Description
show rscn
Displays RSCN information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-87
Chapter 4
C Commands
clear santap module
clear santap module
To clear SANTap information, use the clear santap module command.
clear santap module slot-number {avt avt-pwwn [lun avt-lun] | itl target-pwwn host-pwwn |
session session-id}
Syntax Description
slot-number
Specifies the Storage Services Module (SSM) module number. The range is
1 through 13.
avt avt-pwwn
Removes the appliance virtual target (AVT) pWWN. The format is
hh:hh:hh:hh:hh:hh:hh:hh.
lun avt-lun
(Optional) Removes the appliance virtual target (AVT) LUN. The format is
0xhhhh[:hhhh[:hhhh[:hhhh]]].
itl target-pwwn
host-pwwn
Removes the SANTap Initiator Target LUN (ITL) triplet. The format of the
target-pwwn and the host-pwwn is hh:hh:hh:hh:hh:hh:hh:hh.
session session-id
Removes a session. The range for session ID is 0 through 2147483647.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to remove a SANTap session:
switch# clear santap module 13 session 2020
Related Commands
Command
Description
santap module
Configures the mapping between the Storage Services Module (SSM) and
the VSAN where the appliance is configured.
show santap module
Displays the configuration and statistics of the SANTap feature.
Cisco MDS 9000 Family Command Reference
4-88
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear ssm-nvram santap module
clear ssm-nvram santap module
To clear the SANTap configuration for a specific slot stored on the supervisor flash, use the clear
ssm-nvram santap module command in the configuration mode.
clear ssm-nvram santap module slot
Syntax Description
slot
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.2(1)
This command was introduced.
Displays SANTap configuration for a module in the specified slot.
Usage Guidelines
None
Examples
The following example shows how to clear the SANTap configuration for a slot 2:
switch# clear ssm-nvram santap module 2
Related Commands
Command
Description
ssm enable feature
Enables the SANTap feature on the SSM.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-89
Chapter 4
C Commands
clear scheduler logfile
clear scheduler logfile
To clear the command scheduler logfile, use the clear scheduler logfile command.
clear scheduler logfile
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to clear the command scheduler logfile:
switch# clear scheduler logfile
Related Commands
Command
Description
show scheduler
Displays command scheduler information.
Cisco MDS 9000 Family Command Reference
4-90
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear screen
clear screen
To clear the terminal screen, use the clear screen command in EXEC mode.
clear screen
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to clear the terminal screen:
switch# clear screen
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-91
Chapter 4
C Commands
clear scsi-flow statistics
clear scsi-flow statistics
To clear the SCSI flow statistics counters, use the clear scsi-flow statistics command.
clear scsi-flow statistics flow-id flow-id
Syntax Description
flow-id flow-id
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(2)
This command was introduced.
Configures the SCSI flow identification number.
Usage Guidelines
None
Examples
The following example shows how to clear the SCSI flow statistics counters for SCSI flow ID 3:
switch# clear scsi-flow statistics flow-id 3
Related Commands
Command
Description
scsi-flow flow-id
Configures the SCSI flow services.
show scsi-flow
Displays SCSI flow configuration and status.
Cisco MDS 9000 Family Command Reference
4-92
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear sdv
clear sdv
To clear specified SAN device virtualization parameters, use the clear sdv command in EXEC mode.
clear sdv {database vsan vsan-id | session vsan vsan-id | statistics vsan vsan-id}
Syntax Description
database
Clears the SDV database.
vsan vsan-id
Specifies the number of the VSAN. The range is 1 to 4093.
session
Clears the SDV session.
statistics
Clears the SDV statistics.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.1(2)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to clear SDV statistics:
switch# clear sdv statistics vsan 2
Related Commands
Command
Description
sdv enable
Enables or disables SAN device virtualization.
show sdv statistics
Displays SAN device virtualization statistics.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-93
Chapter 4
C Commands
clear snmp hostconfig
clear snmp hostconfig
To clear all SNMP hosts from the running configuration, use the clear snmp hostconfig command.
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.3(1a)
This command was introduced.
Usage Guidelines
Examples
You must save the changes to startup configuration to make them permanent:
The following example clears the SNMP host list.
switch# clear snmp hostconfig
switch#
Related Commands
Command
Description
show snmp host
Displays the SNMP status and setting information.
Cisco MDS 9000 Family Command Reference
4-94
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear ssh hosts
clear ssh hosts
To clear trusted SSH hosts, use the clear ssh hosts command in EXEC mode.
clear ssh hosts
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.2(1)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to clear reset-reason information from NVRAM and volatile storage:
switch# clear ssh hosts
Related Commands
Command
Description
show ssh hosts
Displays SSH host information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-95
Chapter 4
C Commands
clear system reset-reason
clear system reset-reason
To clear the reset-reason information stored in NVRAM and volatile persistent storage, use the clear
system reset-reason command in EXEC mode.
clear system reset-reason
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.3(2a)
This command was introduced.
Usage Guidelines
Examples
Use this command as follows for these switches:
•
In a Cisco MDS 9500 Series switch, this command clears the reset-reason information stored in
NVRAM and volatile persistent storage in the active and standby supervisor modules.
•
In a Cisco MDS 9200 Series switch, this command clears the reset-reason information stored in
NVRAM and volatile persistent storage in the active supervisor module.
The following example shows how to clear trusted SSH hosts:
switch# clear system reset-reason
Related Commands
Command
Description
show system reset-reason
Displays system reset-reason information.
Cisco MDS 9000 Family Command Reference
4-96
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear tacacs-server statistics
clear tacacs-server statistics
To clear TACACS server statistics, use the clear tacacs-server statistics command.
clear tacacs-server statistics {name}
Syntax Description
name
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Specifies the TACACS name or IP address.
Usage Guidelines
None
Examples
The following example shows how to clear the tacacs server statistics:
switch(config)# clear tacacs-server statistics 10.64.65.57
switch(config)#
Related Commands
Command
Description
tacacs+ enable
Enables TACACS+.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-97
Chapter 4
C Commands
clear tacacs+ session
clear tacacs+ session
To clear TACACS+ Cisco Fabric Services (CFS) session configuration and locks, use the clear tacacs+
session command.
clear tacacs+ session
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, TACACS+ must be enabled using the tacacs+ enable command.
Examples
The following example shows how to clear the TACACS+ session:
switch# clear tacacs+ session
Related Commands
Command
Description
show tacacs+
Displays TACACS+ CFS distribution status and other details.
tacacs+ enable
Enables TACACS+.
Cisco MDS 9000 Family Command Reference
4-98
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear tlport alpa-cache
clear tlport alpa-cache
To clear the entire contents of the alpa-cache, use the clear tlport alpa-cache command in EXEC mode.
clear tlport alpa-cache
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
NX-OS 5.0 and later
releases
This command was deprecated.
1.3(5)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to clear a TL port ALPA cache:
switch# clear tlport alpa-cache
Related Commands
Command
Description
show tlport alpa-cache
Displays TL port alpa-cache information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-99
Chapter 4
C Commands
clear user
clear user
To clear trusted SSH hosts, use the clear user command in EXEC mode.
clear user username
Syntax Description
username
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.2(1)
This command was introduced.
Specifies the user name to clear.
Usage Guidelines
None
Examples
The following example shows how to log out a specified user:
switch# clear user vsam
Related Commands
Command
Description
show users
Displays user information.
Cisco MDS 9000 Family Command Reference
4-100
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear vrrp
clear vrrp
To clear all the software counters for the specified virtual router, use the clear vrrp command in EXEC
mode.
clear vrrp {statistics [ipv4 | ipv6] vr number interface {gigabitethernet slot/port | mgmt 0 |
port-channel portchannel-id | vsan vsan-id}}
Syntax Description
statistics
Clears global VRRP statistics.
ipv4
(Optional) Clears IPv4 virtual router statistics.
ipv6
(Optional) Clears IPv6 virtual router statistics.
vr number
Clears specific virtual router statistics and specifies a VR number from 1 to
255.
interface
Clears an interface.
gigabitethernet
slot/port
Clears a specified Gigabit Ethernet interface.
mgmt 0
Specifies the management interface.
port-channel
port-channel-id
Clears a specified PortChannel interface.The ID of the PortChannel
interface is from 1 to 128.
vsan vsan-id
Clears a specified VSAN. The ID of the VSAN is from 1 to 4093.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
3.0(1)
Added the ipv4 and ipv6 arguments.
Usage Guidelines
None
Examples
The following example shows how to clear all the software counters for virtual router 7 on VSAN 2:
switch# clear vrrp vr 7 interface vsan2
Related Commands
Command
Description
show vrrp
Displays VRRP configuration information.
vrrp
Enables VRRP.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-101
Chapter 4
C Commands
clear zone
clear zone
To clear all configured information in the zone server for a specified VSAN, use the clear zone command
in EXEC mode.
clear zone {database | lock | statistics {lun-zoning | read-only-zoning}} vsan vsan-id
Syntax Description
database
Clears zone server database information.
lock
Clears a zone server database lock.
statistics
Clears zone server statistics.
lun-zoning
Clears LUN-zoning related statistics.
read-only-zoning
Clears read-only zoning related statistics.
vsan
Clears zone information for a VSAN.
vsan-id
The ID of the VSAN is from 1 to 4093.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
3.0(1)
Added the lock option.
Usage Guidelines
After issuing a clear zone database command, you need to explicitly issue the copy running-config
startup-config to ensure that the running configuration is used when you next start the switch.
When you issue the clear zone lock command from a remote switch, only the lock on that remote switch
is cleared. When you issue the clear zone lock command from the switch where the lock originated, all
locks in the VSAN are cleared.
Note
Examples
The recommended method to clear a session lock on a switch where the lock originated is by issuing the
no zone commit vsan command.
The following example shows how to clear all configured information in the zone server for VSAN 1:
switch# clear zone database vsan 1
Related Commands
Command
Description
show zone
Displays zone information for any configured interface.
Cisco MDS 9000 Family Command Reference
4-102
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clear zone smart-zoning
clear zone smart-zoning
To clear the smart zoning configuration, use the clear zone smart-zoning command.
clear zone smart-zoning {fcalias name fcalias-name vsan vsan-id | vsan vsan-id | zone name
zone-name vsan vsan-id | zoneset name zoneset-name vsan vsan-id}
Syntax Description
fcalias name
Specifies auto-convert commands for an fcalias.
fcalias-name
Specifies the fcalias name. The maximum size is 64 characters.
vsan
Specifies the auto convert commands for a VSAN.
vsan-id
Specifies the VSAN ID. The range is from 1 to 4093.
zone name
Specifies the auto convert commands for a given zone.
zone-name
Specifies the zone name. The maximum size is 64 characters.
zoneset name
Specifies the auto convert commands for a zoneset.
zoneset-name
Specifies the zoneset name. The maximum size is 64 characters.
vsan
Specifies the VSAN.
vsan-id
Specifies the VSAN ID. The range is from 1to 4093.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
5.2(6)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to clear the smart zoing command for a VSAN:
switch(config)# clear zone smart-zoning vsan 1
WARNING: This command will clear smart zoning configs from the specified zone/zo
neset/fcalias/vsan. Do you want to continue? (y/n) [n] y
switch(config)#
Related Commands
Command
Description
show zone
Displays zone information for any configured interface.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-103
Chapter 4
C Commands
cli
cli
To execute Cisco NX-OS commands verbosely in Tcl, use the cli command.
cli arguments
Syntax Description
arguments
Defaults
None.
Command Modes
Interactive Tcl shell and Tcl script.
Command History
Release
Modification
NX-OS 5.1(1)
This command was introduced.
Usage Guidelines
arguments takes the form of a single NX-OS command line to execute
in a subprocess. This may include pipes and semicolon separated
commands. Normal abbreviations of NX-OS keywords are allowed.
Enclosing arguments in quotes ("") is optional, but good style that adds
clarity to code. The specified NX-OS command line must not cause any
prompts for input from the user.
The cli command prints the output of the specified command to the terminal and returns the output as a
single string to Tcl. This would be the preferred behavior when using the interactive Tcl shell as it allows
the user to verify the output of the executed NX-OS commands.
In a Tcl script, the cli or clis command is required to execute NX-OS commands.
In the Tcl shell interactive mode, the cli and clis commands are optional to execute NX-OS commands;
commands that are not recognized by the Tcl shell are passed to the NX-OS shell for execution.
Examples
The following example enables the locator LED for module 1 in an interactive Tcl shell:
switch# tclsh
switch-tcl# cli "locator-led module 1"
switch-tcl#
The following example shows how to quote a variable and use the pipe in an interactive Tcl shell. It
creates a list of Supervisor-3 modules in the system and assigns it to the variable sups. string trimright
removes the trailing blank line from the variable added by Tcl, but not from the terminal output:
switch-tcl# set type "Supervisor Module-3"
Supervisor Module-3
switch-tcl# set sups [split [string trimright [cli "show module | include \"$type\""]]
'\n']
5
0
Supervisor Module-3
DS-X97-SF1-K9
active *
6
0
Supervisor Module-3
DS-X97-SF1-K9
ha-standby
switch-tcl#
Cisco MDS 9000 Family Command Reference
4-104
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cli
Related Commands
Command
Description
clis
Execute an NX-OS CLI command silently from Tcl.
open
Open a file or command pipeline and return a channel identifier.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-105
Chapter 4
C Commands
cli alias name
cli alias name
To define a command alias name, use the cli alias name command in configuration submode. To remove
the user-defined command alias, use the no form of the command.
cli alias name command definition
no cli alias name command definition
Syntax Description
command
Specifies an alias command name. The maximum size is 30 characters.
definition
Specifies the alias command definition. The maximum size is 80
characters.
Defaults
alias command.
Command Modes
Configuration submode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
When defining a command alias follow these guidelines:
•
Command aliases are global for all user sessions.
•
Command aliases persist across reboots.
•
Commands being aliased must be typed in full without abbreviation.
•
Command alias translation always takes precedence over any keyword in any configuration mode or
submode.
•
Command alias support is only available on the supervisor module, not the switching modules.
•
Command alias configuration takes effect for other user sessions immediately.
•
You cannot override the default command alias alias, which is an alias for show cli alias.
•
Nesting of command aliases is permitted to a maximum depth of 1. One command alias can refer to
another command alias that refers to a valid command, not to another command alias.
•
A command alias always replaces the first command keyword on the command line.
•
You can define command aliases in either EXEC mode or configuration submode.
Cisco MDS 9000 Family Command Reference
4-106
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cli alias name
Examples
The following example shows how to define command aliases in configuration submode:
switch# config t
switch(config)# cli alias name gigint interface gigabitethernet
switch(config)# cli alias name shintbr show interface brief
switch(config)# cli alias name shfcintup shintbr| include up | include fc
You can display the command aliases defined on the switch using the alias default command alias.
The following example shows how to display the command aliases defined on the switch:
switch(config)# alias
CLI alias commands
==================
alias
:show cli alias
shfcintup
:shintbr | include up | include fc
switch(config)# shfcintup
Related Commands
fc3/1
18
F
on
up
swl
F
4
--
fc3/3
1
SD
--
up
swl
SD
2
--
fc6/1
22
E
auto
up
swl
E
2
--
Command
Description
alias
Displays the default alias command for show cli alias.
show cli alias
Displays all configured aliases.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-107
Chapter 4
C Commands
cli var name (EXEC)
cli var name (EXEC)
To define a CLI session variable that persists only for the duration of a CLI session, use the cli var name
command in either EXEC mode or configuration submode. To remove a user-defined session CLI
variable, use the no form of the command.
cli var name name value
no cli var name name value
Syntax Description
name
Specifies a variable name. The maximum size is 31 characters.
value
Specifies a variable value. The maximum size is 80.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
CLI session variables can be used as follows:
•
Entered directly on the command line.
•
Passed to the child script and initiated using the run-script command. The variables defined in the
parent shell are available for use in the child run-script command process.
•
Passed as command-line arguments to the run-script command.
•
Referenced using the syntax $(variable).
CLI variables have the following limitation:
•
Examples
You cannot reference a variable through another variable using nested references.
The following example creates a user-defined CLI variable for a session:
switch# cli var name testinterface 3/4
The following example removes a user-defined CLI variable for a session:
switch# cli no var name testinterface 3/4
Related Commands
Command
Description
cli no var name
Removes a user-defined session CLI variable.
show cli variables
Displays all CLI variables (persistent, session and system).
Cisco MDS 9000 Family Command Reference
4-108
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cli var name (configuration)
cli var name (configuration)
To define a CLI variable that persists across CLI sessions and switch reloads, use the cli var name
command in configuration submode. To remove the user-defined persistent CLI variable, use the no form
of the command.
cli var name name value
no cli var name name value
Syntax Description
name
Specifies a variable name. The maximum size is 31 characters.
value
Specifies a variable value. The maximum size is 80.
Defaults
None
Command Modes
Configuration submode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
CLI variables can be used as follows:
•
Entered directly on the command line.
•
Passed to the child script and initiated using the run-script command. The variables defined in the
parent shell are available for use in the child run-script command process.
•
Passed as command-line arguments to the run-script command.
•
Referenced using the syntax $(variable).
CLI variables have the following limitations:
•
Examples
You cannot reference a variable through another variable using nested references.
The following example creates a persistent user-defined CLI variable:
switch# config t
switch(config)# cli var name mgmtport mgmt 0
Related Commands
Command
Description
show cli variables
Displays all CLI variables (persistent, session and system).
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-109
Chapter 4
C Commands
clis
clis
To execute Cisco NX-OS commands silently in Tcl, use the clis command.
clis arguments
Syntax Description
arguments
Defaults
None.
Command Modes
Interactive Tcl shell and Tcl script.
Command History
Release
Modification
NX-OS 5.1(1)
This command was introduced.
Usage Guidelines
arguments takes the form of a single NX-OS command line to execute
in a subprocess. This may include pipes and semicolon separated
commands. Normal abbreviations of NX-OS keywords are allowed.
Enclosing arguments in quotes ("") is optional, but good style that adds
clarity to code. The specified NX-OS command line must not cause any
prompts for input from the user.
The clis returns the output as a single string. It does not print any output to the terminal. This is usually
the desired behavior when running Tcl scripts. This prevents the terminal from getting flooded with the
outputs of the executed NX-OS commands.
In a Tcl script, the cli or clis command is required to execute NX-OS commands.
In the Tcl shell interactive mode, the cli and clis commands are optional to execute NX-OS commands;
commands that are not recognized by the Tcl shell are passed to the NX-OS shell for execution.
Examples
The following example shows enables the locator LED for module 1 in a Tcl script:
clis "locator-led module 1"
The following Tcl example shows how to quote a variable and use the pipe in an interactive Tcl shell. It
creates a list of Supervisor-3 modules in the system and assigns it to the variable sups. string trimright
removes the trailing blank line from the variable added by Tcl:
switch-tcl# set type "Supervisor Module-3"
Supervisor Module-3
switch-tcl# set sups [split [string trimright [clis "show module | include \"$type\""] ]
'\n']
switch-tcl#
Cisco MDS 9000 Family Command Reference
4-110
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clis
Related Commands
Command
Description
cli
Execute an NX-OS CLI command in Tcl verbosely.
open
Open a file or command pipeline and return a channel identifier.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-111
Chapter 4
C Commands
clock
clock
To configure the time zone or daylight savings time, use the clock command in configuration mode. To
disable the daylight saving time adjustment, use the no form of the command.
clock {summer-time summer-time-name start-week start-day start-month start-time end-week
end-day end-month end-time offset-minutes | timezone timezone-name hours-offset
minute-offset}
no clock {summer-time summer-time-name start-week start-day start-month start-time end-week
end-day end-month end-time offset-minutes | timezone timezone-name hours-offset
minute-offset}
Syntax Description
summer-time
Specifies the name of the time zone in summer.
summer-time-name
Specifies the name of the daylight savings time zone, ranging from 1 to 8
characters.
start-week
end-week
Specifies the starting week and ending week, ranging from 1 (week 1) to 5
(week 5).
start-day
end-day
Specifies the starting day and ending day, ranging from 1 to 8 characters
(Sunday to Saturday).
start-month
end-month
Specifies the starting month and ending month, ranging from 1 to 8 characters
(January to December).
start-time
end-time
Specifies the starting time and ending time, ranging from 00:00 to 23:59.
offset-minutes
Specifies the daylight savings time offset, ranging from 1 to 1440 minutes.
timezone
Specifies the name of the time zone.
timezone-name
Specifies the name of the time zone, ranging from 1 to 8 characters.
hours-offset
Specifies the offset time in hours, ranging from 0 to 23. Include a dash before
the number; for example, -23.
minutes-offset
Specifies the offset time in minutes, ranging from 0 to 59. Include a dash
before the number; for example, -59.
Defaults
Coordinated Universal Time (UTC) is the same as Greenwich Mean Time (GMT).
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
3.1(1)
Added a new set of arguments for timezone.
Usage Guidelines
The appropriate daylight savings time zone name should be specified. If it is not, the default name is
used.
Cisco MDS 9000 Family Command Reference
4-112
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
clock
Specify the hours-offset argument with a dash before the number; for example, -23 . Specify the
minutes-offset argument with a dash before the number; for example, -59.
Examples
The following example shows how to set Pacific Daylight Time starting on Sunday in the second week
of March at 2:00 A.M. and ending on Sunday in the first week of November at 2:00 A.M:
switch# config t
switch# clock summer-time PDT 2 sunday march 02:00 1 sunday november 02:00 60
The following example shows how to set the time zone to Pacific Standard Time:
switch# config t
switch(config)# clock timezone PST 0 0
Related Commands
Command
Description
clock set
Changes the time on the switch.
show clock
Displays the current date and time.
show run
Displays changes made to the time zone configuration along with other
configuration information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-113
Chapter 4
C Commands
clock set
clock set
To change the system time on a Cisco MDS 9000 Family switch, use the clock set command in EXEC
mode.
clock set HH:MM:SS DD Month YYYY
Syntax Description
HH:
The two-digit time in hours in military format (15 for 3 p.m.).
MM:
The two-digit time in minutes (58).
SS
The two-digit time in seconds (15).
DD
The two-digit date (12).
Month
The month in words (August).
YYYY
The four-digit year (2002).
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Generally, if the system is synchronized by a valid outside timing mechanism, such as an NTP clock
source, or if you have a switch with calendar capability, you do not need to set the system clock. Use this
command if no other time sources are available. The time specified in this command is relative to the
configured time zone.
The clock set command changes are saved across system resets.
Examples
The following example shows how to set the system time:
switch# clock set 15:58:15 12 August 2002
Mon Aug 12 15:58:00 PDT 2002
Cisco MDS 9000 Family Command Reference
4-114
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cloud discover
cloud discover
To initiate manual, on-demand cloud discovery, use the cloud discover command.
cloud discover [interface {gigabitethernet slot/port | port-channel port-channel-number}]
Syntax Description
interface
(Optional) Specifies an interface for cloud discovery.
gigabitethernet
slot/port
(Optional) Specifies a Gigabit Ethernet interface.
port-channel
port-channel-number
(Optional) Specifies a PortChannel interface. The range for the PortChannel
number is 1 to 256.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.0(1)
This command was introduced.
3.2(2c)
This command was deprecated.
Usage Guidelines
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
Examples
The following example initiates manual, on-demand cloud discovery:
switch# cloud discover
The following example initiates manual, on-demand cloud discovery on Gigabit Ethernet interface 2/2:
switch# cloud discover interface gigabitethernet 2/2
Related Commands
Command
Description
cloud discovery
Configures cloud discovery.
cloud-discovery enable
Enables discovery of cloud memberships.
show cloud discovery
Displays discovery information about the cloud.
show cloud membership
Displays information about members of the cloud.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-115
Chapter 4
C Commands
cloud discovery
cloud discovery
To configure cloud discovery, use the cloud discovery command in configuration mode. To remove the
configuration, use the no form of the command.
cloud discovery {auto | fabric distribute | message icmp}
no cloud discovery {auto | fabric distribute | message icmp}
Syntax Description
auto
Enables auto fabric discovery.
fabric distribute
Enables cloud discovery fabric distribution.
message icmp
Configures Internet Control Message Protocol (ICMP) as the method for
sending a discovery message.
Defaults
Auto.
Command Modes
Configuration mode
Command History
Release
Modification
3.0(1)
This command was introduced.
3.2(2c)
This command was deprecated.
Usage Guidelines
Examples
The iSNS server distributes cloud and membership information across all of the switches using CFS. The
cloud view is the same on all of the switches in the fabric.
Note
If auto discovery is disabled, interface changes result in new members becoming part of an undiscovered
cloud. No new clouds are formed.
Note
This command is not supported on the Cisco MDS 9124 switch.
The following example enables auto cloud discovery:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# cloud disovery auto
The following example enables auto cloud discovery fabric distribution:
switch(config)# cloud disovery fabric distribute
The following example disables auto cloud discovery fabric distribution:
Cisco MDS 9000 Family Command Reference
4-116
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cloud discovery
switch(config)# no cloud disovery fabric distribute
Related Commands
Command
Description
cloud discover
Initiates manual, on-demand cloud discovery.
cloud-discovery enable
Enables discovery of cloud memberships.
show cloud discovery
Displays cloud discovery information.
show cloud membership
Displays information about members of the cloud.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-117
Chapter 4
C Commands
cloud-discovery enable
cloud-discovery enable
To enable discovery of cloud memberships, use the cloud-discovery command in configuration mode.
To disable discovery of cloud memberships, use the no form of the command.
cloud-discovery enable
no cloud-discovery enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode
Command History
Release
Modification
3.0(1)
This command was introduced.
3.2(2c)
This command was deprecated.
Usage Guidelines
This command is not supported on the Cisco MDS 9124 switch.
Examples
The following example enables discovery of cloud memberships:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# cloud-discovery enable
The following example disables discovery of cloud memberships:
switch(config)# no cloud-discovery enable
Related Commands
Command
Description
cloud discover
Initiates manual, on-demand cloud discovery.
cloud discovery
Configures cloud discovery.
show cloud
Displays cloud discovery and membership information.
Cisco MDS 9000 Family Command Reference
4-118
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
cluster
cluster
To configure a cluster feature, use the cluster command.
cluster enable
Syntax Description
enable
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
3.2(2)
This command was introduced.
NX-OS 4.1(1c)
The cluster command is replaced by the feature command.
Enables or disables a cluster.
Usage Guidelines
Starting from Cisco NX-OS 4.x Release, the cluster command is replaced by the feature command.
Examples
The following example enables the Cisco SME clustering:
switch# config terminal
switch(config)# cluster enable
switch(config)#
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-119
Chapter 4
C Commands
code-page
code-page
Use the code-page command to configure the EBCDIC format. To disable the configuration or to revert
to factory defaults, use the no form of the command.
code-page brazil | france | international-5 | italy | japan | spain-latinamerica | uk | us-canada
no code-page brazil | france | international-5 | italy | japan | spain-latinamerica | uk | us-canada
Syntax Description
code-page
Configures code page on a FICON-enabled VSAN
brazil
Configures the brazil EBCDIC format.
france
Configures the france EBCDIC format.
international-5
Configures the international-5 EBCDIC format.
italy
Configures the italy EBCDIC format.
japan
Configures the japan EBCDIC format.
spain-latinamerica
Configures the spain-latinamerica EBCDIC format.
uk
Configures the uk EBCDIC format.
us-canada
Configures the us-canada EBCDIC format.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
This is an optional configuration. If you are not sure of the EBCDIC format to be used, we recommend
retaining the us-canada (default) option.
Examples
The following example configures the italy EBCDIC format:
switch(config)# ficon vsan 2
switch(config-ficon)# code-page italy
The following example reverts to the factory default of using the us-canada EBCDIC format:
switch(config-ficon)# no code-page
Cisco MDS 9000 Family Command Reference
4-120
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
code-page
Related Commands
Command
Description
ficon vsan vsan-id
Enables FICON on the specified VSAN.
show ficon
Displays configured FICON details.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-121
Chapter 4
C Commands
commit
commit
To apply the pending configuration pertaining to the Call Home configuration session in progress, use
the commit command in Call Home configuration submode.
commit
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
Call Home configuration submode
Command History
Release
Modification
1.3(1)
This command was introduced.
2.0(1b)
This command was introduced.
Usage Guidelines
CFS distribution must be enabled before you can commit the Call Home configuration.
Examples
The following example shows how to commit the Call Home configuration commands:
switch# config terminal
Enter configuration commands, one per line.
switch(config)# callhome
switch(config-callhome)# commit
Related Commands
End with CNTL/Z.
Command
Description
callhome
Configures the Call Home function.
callhome test
Sends a dummy test message to the configured destination(s).
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
4-122
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
commit (DMM job configuration submode)
commit (DMM job configuration submode)
To commit a DMM job, use the commit command in DMM job configuration submode. To remove the
DMM job, use the no form of the command.
commit
no commit
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
DMM job configuration submode
Command History
Release
Modification
3.2(1)
This command was introduced.
Usage Guidelines
You need to configure server HBA ports, storage ports, and job attributes before you commit the job.
Examples
The following example shows how to commit a data migration job:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# dmm module 3 job 1 destroy
switch(config-dmm-job)#
Related Commands
Command
Description
show dmm job
Displays job information.
show dmm srvr-vt-login
Enables DMM.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-123
Chapter 4
C Commands
contract-id
contract-id
To configure the service contract ID of the customer with the Call Home function, use the contract-id
command in Call Home configuration submode. To disable this feature, use the no form of the command.
contract-id customer-id
no contract-id customer-id
Syntax Description
customer-id
Defaults
None
Command Modes
Call Home configuration submode
Command History
Release
Modification
1.0(2)
This command was introduced.
Configures the service contract ID of the customer. Allows up to 64
characters for the contract number.
Usage Guidelines
None.
Examples
The following example shows how to configure the contract ID in the Call Home configuration:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# contract-id Customer1234
Related Commands
Command
Description
callhome
Configures the Call Home function.
callhome test
Sends a dummy test message to the configured destination(s).
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
4-124
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
configure terminal
configure terminal
To enter the configuration mode, use the configure terminal command in EXEC mode.
configure terminal
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None
Examples
The following example enters the configuration mode:
switch# configure terminal
switch(config)#
The following example enters the configuration mode using an abbreviated format of the command:
switch# config terminal
switch(config)#
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-125
Chapter 4
C Commands
copy
copy
To save a backup of the system software, use the copy command in EXEC mode.
copy source-URL destination-URL
Syntax Description
source-URL
The location URL or alias of the source file or directory to be copied.
destination-URL
The destination URL or alias of the copied file or directory.
The following table lists the aliases for source and destination URLs.
running-config
Specifies the configuration currently running on the switch. The
system:running-config keyword represents the current running
configuration file.
startup-config
Specifies the configuration used during initialization (startup). You can
copy the startup configuration from NVRAM. The nvram:startup-config
keyword represents the configuration file used during initialization.
bootflash:
Specifies the location for internal bootflash memory.
log:
Specifies the location for the log file system.
slot0:
Specifies the location for the CompactFlash memory or PCMCIA card.
volatile:
Specifies the location for the volatile file system.
system:
Specifies the location for system memory, which includes the running
configuration.
fabric
Specifies a fabric wide startup configuration update using Cisco Fabric
Services (CFS) where all the remote switches in the fabric copy their
running configuration (source) file into their startup configuration
(destination) file. The syntax for this command is copy running-config
startup-config fabric.
tftp:
Specifies the location for a Trivial File Transfer Protocol (TFTP) network
server. The syntax for this alias is tftp:[[//location]/directory]/filename.
ftp:
Specifies the location for a File Transfer Protocol (FTP) network server.
The syntax for this alias is ftp:[[//location]/directory]/filename.
scp:
Specifies the location for a secure copy (scp) network server. The syntax
for this alias is scp:[[//location]/directory]/filename.
sftp:
Specifies the location for a Secure Trivial File Transfer Protocol (SFTP)
network server. The syntax for this alias is
sftp:[[//location]/directory]/filename.
log:
Specifies the location for log files stored in the same directory.
debug:
Specifies the location for the debug files stored in the debug partition.
nvram:
Specifies the switch NVRAM.
core:
Specifies the location of the cores from any switching or supervisor
module to an external flash (slot 0) or a TFTP server.
filename
The name of the flash file.
sup-1
sup-2
The number of the supervisor module, where sup-1 is the slot 5 supervisor
(active) and sup-2 is the slot 6 supervisor (standby).
Cisco MDS 9000 Family Command Reference
4-126
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
copy
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
NX-OS 4.2(1)
Added a note.
1.3(4)
Command modified.
2.1(1a)
Added the fabric keyword and functionality.
Usage Guidelines
This command makes the running and the backup copy of the software identical.
A file can only be copied from an active supervisor to a standby supervisor, not from standby to active.
This command does not allow 127.x.x.x IP addresses.
The copy function will not be completed if the required space is not available in the directory. First
change to the required directory (for example, cd bootflash:) and verify the available space (for
example, dir bootflash:).
The entire copying process may take several minutes.
Do not copy a file from an external source directly to the standby supervisor. You must copy from the
external source to the active supervisor, and then copy the saved file to the standby supervisor.
You can save cores (from the active supervisor module, the standby supervisor module, or any switching
module) to an external flash (slot 0) or to a TFTP server in one of two ways:
•
On demand—to copy a single file based on the provided process ID.
•
Periodically—to copy core files periodically as configured by the user.
You copy the logfile to a different location using the copy log:messages command.
The debug partition contains debugging files created by the software for troubleshooting purposes.
The running-config startup-config fabric parameters allow you to use CFS to force every switch in the
Fibre Channel fabric to copy their running configuration (source) to their startup configuration
(destination).
Note
Examples
If any remote switch fails to complete the copy running-config startup-config fabric process, the
initiator switch also does not complete saving its startup-configuration. This means that both the remote
switch and the initiator switch have failed to save their startup-configuration (the old
startup-configuration reverts back). All the other switches in the network would have succeeded.
The following example saves your configuration to the startup configuration:
switch# copy system:running-config nvram:startup-config
The following example copies the file called samplefile from the slot0 directory to the mystorage
directory:
switch# copy slot0:samplefile slot0:mystorage/samplefile
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-127
Chapter 4
C Commands
copy
The following example copies a file from the current directory level:
switch# copy samplefile mystorage/samplefile
If the current directory is slot0:mydir, this command copies slot0:mydir/samplefile to
slot0:mydir/mystorage/samplefile.
The following example downloads a configuration file from an external CompactFlash to the running
configuration:
switch copy slot0:dns-config.cfg system:running-config
The following example saves a running configuration file to an external CompactFlash:
switch# copy system:running-config slot0:dns-config.cfg
The following example saves a startup configuration file to an external CompactFlash:
switch# copy system:startup-config slot0:dns-config.cfg
The following example uses CFS to cause all switches in the fabric to copy their running configuration
(source) file to their startup configuration (destination) file:
switch# copy running-config startup-config fabric
[########################################] 100%
switch#
Note
If any remote switch fails to complete the copy running-config startup-config fabric process, the
initiator switch also does not complete saving its startup-configuration. This means both the remote
switch and the initiator switch have failed to save their startup-configuration (the old
startup-configuration reverts back). All the other switches in the network would have succeeded.
Note
When you copy a file to an ftp server from a Cisco Fabric Switch for IBM BladeCenter, you must enter
the full path. For example: switch# copy running-config
ftp://172.25.161.201/mnt/hd2/bch6-inagua-bay3_cfg1.txt, If you do not enter the full path, the
command will not succeed.
The following example creates a backup copy of the binary configuration:
switch# copy nvram:startup-config nvram:snapshot-config
The following example copies an image in bootflash on the active supervisor to the bootflash on the
standby supervisor:
switch# copy bootflash:myimage bootflash://sup-2/myimage
The following example creates a running configuration copy in bootflash:
switch# copy system:running-config bootflash:my-config
The following examples creates a startup configuration copy in bootflash:
switch# copy nvram:startup-config bootflash:my-config
Cisco MDS 9000 Family Command Reference
4-128
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
copy
Related Commands
Command
Description
cd
Changes the default directory or file system.
dir
Displays a list of files on a file system.
reload
Reloads the operating system.
show version
Displays the version of the running configuration file.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-129
Chapter 4
C Commands
copy licenses
copy licenses
To save a backup of the installed license files, use the copy licenses command in EXEC mode.
copy licenses source-URL destination-URL
Syntax Description
source-URL
The location URL or alias of the source file or directory to be copied.
destination-URL
The destination URL or alias of the copied file or directory.
The following table lists the aliases for source and destination URLs.
bootflash:
Specifies the location for internal bootflash memory.
slot0:
Specifies the location for the CompactFlash memory or PCMCIA card.
volatile:
Specifies the location for the volatile file system.
filename
Specifies the name of the license file with a.tar extension.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
1.3(4)
This command was introduced.
Usage Guidelines
The copy function will not be completed if the required space is not available in the directory. First
change to the required directory (for example, cd bootflash:) and verify the available space (for
example, dir bootflash:).
We recommend backing up your license files immediately after installing them and just before issuing a
write erase command.
Examples
The following example saves a file called Enterprise.tar to the bootflash: directory:
switch# copy licenses bootflash:/Enterprise.tar
Backing up license done
Related Commands
Command
Description
cd
Changes the default directory or file system.
dir
Displays a list of files on a file system.
install license
Installs a license file.
Cisco MDS 9000 Family Command Reference
4-130
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
copy ssm-nvram standby-sup
copy ssm-nvram standby-sup
To copy the contents of the Storage Services Module (SSM) NVRAM to the standby Supervisor 2
module when migrating from a Supervisor 1 to Supervisor 2 module, use the copy ssm-nvram
standby-sup command in EXEC mode.
copy ssm-nvram standby-sup
Syntax Description
This command has no arguments or keywords.
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
This command should only be used for migrating from a Supervisor 1 to a Supervisor 2 module. When
both modules in the switch are the same, you should not use this command; use the copy command
instead.
Examples
The following example copies the contents of the SSM NVRAM to the standby Supervisor 2 module:
switch# copy ssm-nvram standby-sup
Related Commands
Command
Description
copy
Saves a backup of the system software.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-131
Chapter 4
C Commands
counter (port-monitor configuration mode)
counter (port-monitor configuration mode)
To configure individual counter in a port-monitor policy to use non-default values, use the counter
command. To reset the counter to its default values in a Port Monitor policy, use the no form of the
command.
counter {credit-loss-reco | err-pkt-from-port | err-pkt-from-xbar | err-pkt-to-xbar | invalid-crc
| invalid-words | link-loss | lr-rx | lr-tx | rx-datarate | signal-loss | state-change | sync-loss |
timeout-discards | tx-credit-not-available | tx-datarate | tx-discards | tx-slowport-count |
tx-slowport-oper-delay | txwait} poll-interval poll-interval seconds {absolute | delta}
rising-threshold rising threshold event event-id warning-threshold warning threshold
falling-threshold falling threshold event event-id [portguard {errordisable | flap}]
no counter {credit-loss-reco | err-pkt-from-port | err-pkt-from-xbar | err-pkt-to-xbar |
invalid-crc | invalid-words | link-loss | lr-rx | lr-tx | rx-datarate | signal-loss | state-change |
sync-loss | timeout-discards | tx-credit-not-available | tx-datarate | tx-discards |
tx-slowport-count | tx-slowport-oper-delay | txwait} poll-interval poll-interval seconds
{absolute | delta} rising-threshold rising threshold event event-id warning-threshold
warning threshold falling-threshold falling threshold event event-id [portguard
{errordisable | flap}]
credit-loss-reco
Configures the credit loss recovery counter 1.3.6.1.4.1.9.9.289.1.2.1.1.37.
err-pkt-from-port
Configures the err-pkt-from-port counter 1.3.6.1.4.1.9.9.779.1.1.1.1.4.0.1.
err-pkt-from-xbar Configures the err-pkt-from-xbar counter 1.3.6.1.4.1.9.9.779.1.1.1.1.4.0.2.
err-pkt-to-xbar
Configures the err-pkt-to-xbar counter 1.3.6.1.4.1.9.9.779.1.1.1.1.4.0.3.
invalid-crc
Configures the invalid crc counter 1.3.6.1.4.1.9.9.289.1.2.1.1.6.
invalid-words
Configures the invalid words counter 1.3.6.1.4.1.9.9.289.1.2.1.1.5.
link-loss
Configures the link failure counter 1.3.6.1.4.1.9.9.289.1.2.1.1.1.
lr-rx
Configures the number of link reset responses received by the Fc port
1.3.6.1.4.1.9.9.289.1.2.1.1.9.
lr-tx
Configures the link reset responses transmitted by the FC port
1.3.6.1.4.1.9.9.289.1.2.1.1.10.
rx-datarate
Configures the rx performance counter 1.3.6.1.2.1.31.1.1.1.6.
signal-loss
Configures the signal loss counter. 1.3.6.1.4.1.9.9.289.1.2.1.1.3
state-change
Configures the state-change counter.
The state-change counter records the port down to port up as one state-change.
sync-loss
Configures the sync loss counter. 1.3.6.1.4.1.9.9.289.1.2.1.1.2
timeout-discards
Configures the timeout discards counter. 1.3.6.1.4.1.9.9.289.1.2.1.1.35
tx-credit-available Configures the credit not available counter. 1.3.6.1.4.1.9.9.289.1.2.1.1.38
tx-datarate
Configures the tx performance counter. 1.3.6.1.2.1.31.1.1.1.10
tx-discards
Configures the tx discards counter. 1.3.6.1.4.1.9.9.289.1.2.1.1.36
Cisco MDS 9000 Family Command Reference
4-132
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
counter (port-monitor configuration mode)
tx-slowport-count
Configures the tx slow port count counter. This is a count of slowport-monitor
events in the polling-interval.
This counter is applicable only for Cisco MDS 9500 Series Switch with the
following modules:
•
Cisco MDS 9000 Series 1/2/4/8-Gbps 4/44-Port Host-Optimized FC Module
•
Cisco MDS 9000 Series 1/2/4/8-Gbps 48-Port FC Module
•
Cisco MDS 9000 Series 1/2/4/8-Gbps 24-Port FC Module
Note
tx-slowport-operdelay
system timeout slowport-monitor command must be configured for this
to alert. See the system timeout slowport-monitor command for more
information.
Configures the tx slow port operational delay. This is a value in ms of the average
operational delay as reported by the slowport-monitor.
This counter is applicable only for the following switches and modules:
•
Cisco MDS 9500 Series Switch
– Cisco MDS 9000 Series 32-Port 8-Gbps Advanced Fiber Channel
Switching Module
– Cisco MDS 9000 Series 48-Port 8-Gbps Advanced Fibre Channel
Switching Module
•
Cisco MDS 9700 Series Switch
– Cisco MDS 9000 Series 48-Port 16-Gbps Fibre Channel Switching
Module
•
Cisco MDS 9148S 16G Multilayer Fabric Switch
•
Cisco MDS 9250i Multiservice Fabric Switch
•
Cisco MDS 9396S 16G Multilayer Fabric Switch
Note
For the MDS 9500 8-Gbps Advanced Fiber Channel Switching Module,
the slowport operational delay is the total amount of txwait delay that
occurs in the polling internal.
Note
system timeout slowport-monitor command must be configured for this
to alert. See the system timeout slowport-monitor command for more
information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-133
Chapter 4
C Commands
counter (port-monitor configuration mode)
txwait
Configures the tx total wait counter. This is the aggregate amount of time that a
port is at zero Tx B2B credits while there are frames enqueued in a polling
interval. This is not a continuous interval, but a total amount of time the TxWait
counter has increased during the polling-interval. It is configured as a percentage
of the polling interval. Typically the polling-interval should be 1 second. So, if a
value of 40% is used that represents 40% of 1 second or 400 ms of aggregate
TxWait on an interface.
This counter is applicable only for the following switches and modules:
•
Cisco MDS 9500 Series Switch
– Cisco MDS 9000 Series 32-Port 8-Gbps Advanced Fiber Channel
Switching Module
– Cisco MDS 9000 Series 48-Port 8-Gbps Advanced Fibre Channel
Switching Module
•
Cisco MDS 9700 Series Switch
– Cisco MDS 9000 Series 48-Port 16-Gbps Fibre Channel Switching
Module
•
Cisco MDS 9148S 16G Multilayer Fabric Switch
•
Cisco MDS 9250i Multiservice Fabric Switch
•
Cisco MDS 9396S 16G Multilayer Fabric Switch
poll-interval
Configures the poll interval for counter.
poll-interval
seconds
Displays the poll interval in seconds. The range is from 1 to 700000 seconds.
absolute
Absolute threshold type.
delta
Displays the threshold type.
Cisco MDS 9000 Family Command Reference
4-134
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
counter (port-monitor configuration mode)
rising-threshold
Configures the upper threshold value.
Rising threshold and falling threshold work together to generate alerts when the
counter reaches configured values at the end of a polling interval and to minimize
unnecessary alerts. When the counter reaches or exceeds the configured
rising-threshold at the end of a polling interval, a rising-threshold alert is
generated. After a rising-threshold alert is generated, another rising-threshold
alert will not be generated until the counter's falling-threshold alert has been
generated. This is true even if the counter exceeds the rising-threshold at the end
of subsequent polling intervals. When falling-threshold is reached, the
falling-threshold alert is generated, and the counter is once again eligible for
another rising-threshold alert.
When the threshold type is absolute, the rising-threshold value is the actual value
the counter must reach for an alert to be generated.
When the threshold type is delta then the value that is used is the difference
between the current value of the counter and the value obtained at the previous
poll interval. Additionally, some rising and falling thresholds are configured as a
percentage of the polling interval. These are displayed in show port-monitor
default with a “%”. The following counters are configured as a percentage of the
polling interval:
•
rx-datarate
•
tx-datarate
•
tx-credit-not-available
•
txwait
For example if tx-credit-not-available is configured with a polling-interval of 1
(second) and a rising-threshold of 10(%) then an alert will be generated when Tx
credits are not available for 100ms (10% of 1 second).
rising-threshold
Sets numerical upper threshold limit. The range is from 0 to
9223372036854775807.
event
Configures the rising-threshold event.
Note
Following are the default RMON events and their meaning:
– Event 1: Fatal
– Event 2: Critical
– Event 3: Error
– Event 4: Warning
– Event 5: Information
event-id
Event ID. The range is from 0 to 65535.
warning-threshold Configures a warning threshold whose value must be less than or equal to the
rising-threshold value.
Note
Configuring warning threshold causes a syslog message to be displayed
when the warning threshold value has been reached.
warning-threshold
Set numerical threshold value that is less than or equal to the rising-threshold
value.
falling-threshold
Configures the lower threshold value which is the percentage of the polling
interval.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-135
Chapter 4
C Commands
counter (port-monitor configuration mode)
falling-threshold
Sets numerical lower threshold limit. The range is from 0 to
9223372036854775807.
event
Configures the falling threshold event.
Note
Following are the default RMON events and their meanings:
– Event 1: Fatal
– Event 2: Critical
– Event 3: Error
– Event 4: Warning
– Event 5: Information
The event numbers are included in the generated event and will be displayed in
DCNM Health Events with appropriate symbols to differentiate various counters.
event-id
Event ID. The range is from 0 to 65535.
portguard
Enables port guard.
errordisable
Specifies the portguard action to error disable the port when the rising-threshold
is reached.
flap
Specifies the portguard action to flap the port when the rising-threshold is
reached.
Defaults
Each counter has its own unique defaults. Issue the show port-monitor default command to see all the
defaults.
Command Modes
Configuration Port Monitor mode.
Command History
Release
Modification
6.2(17)
Added the state-change keyword.
6.2(15)
Added the warning threshold keyword.
6.2(13)
Added tx-slowport-count, tx-slowport-oper-delay, and txwait keywords.
5.2(2a)
Added err-pkt-from-port, err-pkt-from-xbar, err-pkt-to-xbar keywords.
4.2(1)
This command was introduced.
Usage Guidelines
•
The counter command configures the pthresholds and other parameters for the counter. To turn
monitoring off or on for a counter within a given port-monitor policy use the no monitor counter
countername command.
•
Once a port-monitor policy has been configured, the policy must be activated for it to take affect.
See the port-monitor activate policyname command for further details.
•
This command is available in port-monitor configuration mode.
•
It is recommended not to have a port guard action set to the state-change counter when an interface
state is changed from down state to up state.
Cisco MDS 9000 Family Command Reference
4-136
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
counter (port-monitor configuration mode)
Examples
The following example shows how to configure the credit loss recovery counter within a Port Monitor
policy:
switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)#port-monitor name PMON-policy
switch(config-port-monitor)# counter credit-loss-reco poll-interval 60 delta
rising-threshold 5 event 2 falling-threshold 2 event 4
switch(config-port-monitor)#
The following example shows how to configure the err-pkt-from-port counter:
switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)#port-monitor name PMON-policy
switch(config-port-monitor)# counter err-pkt-from-port poll-interval 30 delta ri
sing-threshold 50 event 50 falling-threshold 40 event 40
switch(config-port-monitor)#
The following example shows how to configure the state-change counter:
switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)#port-monitor name PMON-policy
switch(config-port-monitor)# counter state-change poll-interval 60 delta rising-threshold
100 event 2 warning-threshold 50 falling-threshold 0 event 4 portguard errordisable
switch(config-port-monitor)#
Related Commands
Command
Description
monitor counter
Configures monitoring of a specific counter within a Port Group Monitor
policy.
port-monitor activate
policyname
Activates the specified port monitor policy.
port-monitor name
policyname
Configures a port-monitor policy.
show port-monitor
Displays Port Monitor information.
system timeout
slowport-monitor
Configures the default slow port monitor timeout value for the specified port
type.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-137
Chapter 4
C Commands
counter (port-group-monitor configuration mode)
counter (port-group-monitor configuration mode)
To configure individual counter in a port group monitor policy to use non-default values, use the counter
command. To reset the counter to its default values in a Port Group Monitor policy, use the no form of
the command.
counter {rx-performance | tx-performance} poll-interval interval {delta} rising-threshold
rising threshold falling-threshold low threshold
no counter{ rx-performance | tx-performance} poll-interval interval {delta} rising-threshold
rising threshold falling-threshold falling-threshold
Syntax Description
rx-performance
Counfigures RX performance counter.
tx-performance
Configures TX performance counter.
poll-interval
Configures poll interval for counter.
interval
Displays poll interval in seconds. The range is from 0 to 2147483647.
delta
Displays the threshold type.
rising-threshold
Configures the upper threshold value which is the percentage of the polling
interval.
rising-threshold
Sets numerical upper threshold limit. The range is from 0 to 100.
falling-threshold
Configures the lower threshold value which is the percentage of the polling
interval.
falling-threshold
Sets numerical falling threshold limit. The range is from 0 to 100.
Defaults
None
Command Modes
Configuration Port Group Monitor mode
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
This command is available in port-group-monitor configuration mode.
Examples
The following example shows how to configure monitoring of a specific counter within a Port Group
Monitor policy:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)#port-group name pgmon
switch(config-port-group-monitor)# counter rx-performance
switch(config-port-group-monitor)# counter tx-performance
switch(config-port-group-monitor)#
Cisco MDS 9000 Family Command Reference
4-138
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
counter (port-group-monitor configuration mode)
The following example shows how to turn off the monitoring of a specific counter in the given policy:
switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# no port-group-monitor name pgmon
switch(config-port-group-monitor)# no counter rx-performance
switch(config-port-group-monitor)# no counter tx-performance
switch(config-port-group-monitor)#show port-group-monitor
-----------------------------------------------------------------------------------------Port Group Monitor : enabled
-----------------------------------------------------------------------------------------Policy Name : pgmon
Admin status : Not Active
Oper status : Not Active
Port type
: All Port Groups
-----------------------------------------------------------------------------------------Counter Threshold Interval %ge Rising Threshold %ge Falling Threshold In Use
------- --------- -------- -------------------- ---------------------- -----RX Performance Delta 60 80 20 Yes
TX Performance Delta 60 80 20 No
------------------------------------------------------------------------
Related Commands
Command
Description
show port-group-monitor Displays Port Group Monitor information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-139
Chapter 4
C Commands
counter tx-slowport-count
counter tx-slowport-count
To configure the tx-slowport-count counter, use the counter tx-slowport-count command. To reset the
counter use the no form of the command.
counter tx-slowport-count poll-interval seconds {absolute | delta} {rising-threshold count1
event event-id [falling-threshold count2 event event-id]}
no counter tx-slowport-count poll-interval seconds {absolute | delta} {rising-threshold count1
event event-id [falling-threshold count2 event event-id]}
Syntax Description
poll-interval
Configures poll interval for the counter.
seconds
Displays the poll-interval in seconds.
absolute
Displays the threshold type.
delta
Displays the threshold type.
rising-threshold
Configures the upper threshold limit for the counter.
count1
Sets a numerical for the rising threshold limit.
event
Configures rising-threshold event.
event-id
Sets a numerical for the rising threshold event.
falling-threshold
Configures the lower threshold value for the counter.
count2
Sets a numerical for the falling threshold limit.
event
Configures falling-threshold event.
event-id
Sets a numerical for the falling-threshold event.
Defaults
Default values of the different parameters for the counter.
Command Modes
Configuration Port Monitor mode.
Command History
Release
Modification
6.2(13)
This command was introduced.
Examples
The following example shows how to configure the tx-slowport-count counter within a Port Monitor
policy:
switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# port-monitor name pmon
switch(config-port-monitor)# counter tx-slowport-count poll-interval 1 delta
rising-threshold 1 event 3 falling-threshold 0 event 4
switch(config-port-monitor)#
Cisco MDS 9000 Family Command Reference
4-140
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
counter tx-slowport-count
The following example shows how to reset to the default values for the tx-slowport-count counter within
a Port Monitor policy:
switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# port-monitor name pmon
switch(config-port-monitor)# no counter tx-slowport-count poll-interval 1 delta
rising-threshold 1 event 3 falling-threshold 0 event 4
Configuration for this counter are reset to use default values.
switch(config-port-monitor)#
Related Commands
Command
Description
show port-monitor
Displays Port Monitor information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-141
Chapter 4
C Commands
counter tx-slowport-oper-delay
counter tx-slowport-oper-delay
To configure the tx-slowport-oper-delay counter, use the counter tx-slowport-oper-delay command. To
reset the counter use the no form of the command.
counter tx-slowport-oper-delay poll-interval seconds absolute rising-threshold value event
event-id [falling-threshold value event event id ]
no counter tx-slowport-oper-delay poll-interval seconds absolute rising-threshold value event
event-id [falling-threshold value event event id ]
Syntax Description
poll-interval
Configures poll interval for counter.
seconds
Displays the poll-interval in seconds.
absolute
Displays the threshold type.
rising-threshold
Configures the upper threshold value for the counter.
value
Sets a numerical value (in milliseconds) for the rising-threshold.
event
Configures rising-threshold event.
event-id
Sets a numerical for the rising threshold event.
falling-threshold
Configures the lower threshold value for the counter.
value
Sets a numerical (in milliseconds) for the falling-threshold.
event
Configures falling-threshold event.
event-id
Sets a numerical for the event.
Defaults
Default values of the different parameters for the counter.
Command Modes
Configuration Port Monitor mode
Command History
Release
Modification
6.2(13)
This command was introduced.
Examples
The following example shows how to configure the tx-slowport-oper-delay counter within a Port
Monitor policy:
switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# port-monitor name pmon
switch(config-port-monitor)# counter tx-slowport-oper-delay poll-interval 1 absolute
rising-threshold 1 event 3 falling-threshold 0 event 4
switch(config-port-monitor)#
The following example shows how to reset to the default values for the tx-slowport-oper-delay counter
within a Port Monitor policy:
switch# configure terminal
Cisco MDS 9000 Family Command Reference
4-142
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
counter tx-slowport-oper-delay
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# port-monitor name pmon
switch(config-port-monitor)# no counter tx-slowport-oper-delay poll-interval 1 absolute
rising-threshold 1 event 3 falling-threshold 0 event 4
Configuration for this counter are reset to use default values.
switch(config-port-monitor)#
Related Commands
Command
Description
show port-monitor
Displays Port Monitor information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-143
Chapter 4
C Commands
counter txwait
counter txwait
To configure the txwait counter, use the counter txwait command. To reset the counter use the no form
of the command.
counter txwait poll-interval seconds {absolute | delta} {rising-threshold percentage1 event
event-id [falling-threshold percentage2 event event-id]}
no counter txwait poll-interval seconds {absolute | delta} {rising-threshold percentage1 event
event-id [falling-threshold percentage2 event event-id]}
Syntax Description
poll-interval
Configures poll interval for counter.
seconds
Displays the poll-interval in seconds.
absolute
Displays the threshold type.
delta
Displays the threshold type.
rising-threshold
Configures the upper threshold value for the counter.
percentage1
Sets a numerical limit (in percentage) for the rising-threshold.
event
Configures a rising-threshold event.
event-id
Sets a numerical limit (in percentage) for the rising-threshold.
falling-threshold
Configures the lower threshold value for the counter.
percentage2
Sets a numerical limit for the falling-threshold.
event
Configures a falling-threshold event.
event-id
Sets a numerical for the event.
Defaults
Default values of the different parameters for the counter..
Command Modes
Configuration Port Monitor mode.
Command History
Release
Modification
6.2(13)
This command was introduced.
Examples
The following example shows how to configure the txwait counter within a Port Monitor policy:
switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# port-monitor name pmon
switch(config-port-monitor)# counter txwait poll-interval 1 delta rising-threshold 1 event
3 falling-threshold 0 event 4
switch(config-port-monitor)#
The following example shows how to reset to the default values for the txwait counter within a Port
Monitor policy:
Cisco MDS 9000 Family Command Reference
4-144
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
counter txwait
switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# port-monitor name pmon
switch(config-port-monitor)# no counter txwait poll-interval 1 delta rising-threshold 1
event 3 falling-threshold 0 event 4
Configuration for this counter are reset to use default values.
switch(config-port-monitor)#
Related Commands
Command
Description
show port-monitor
Displays Port Monitor information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-145
Chapter 4
C Commands
CRLLookup
CRLLookup
To set the CRLLookup, use the CRLLookup command. To disable this feature, use the no form of the
command.
crllookup attribute-name attribute-name search-filter string base-DN string
no crllookup attribute-name attribute-name search-filter string base-DN string
Syntax Description
attribute-name
attribute-name
Specifies LDAP attribute name. The maximum size is 128 characters.
search-filter
Specifies LDAP search filter. The maximum length is 128 characters.
string
Specifies search map search filter . The maximum length is 128 characters.
base-DN
Configure base DN to be used for search operation. The Maximum
length is 63 characters.
string
Specifies search map base DN name. The Maximum length is 63
characters.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
Examples
None
The following example shows how to set the CRLLookup:
switch(config)#ldap search-map s1
switch(config-ldap-search-map)# CRLLookup attribute-name certificate RevocationList”
search-filter"(&(objectClass=CRLDistributionPoint))" base-DN "CN=CDP,CN=Public Key
Services,CN=Services,CN=Configuration,DC=DCBU-ACS"
GROUP_NAME: map1
CRL
ATTR_NAME: map1
SEARCH_FLTR: map1
BASE_DN: DN1
Sending the SET_REQ
switch(config-ldap-search-map)#end
Cisco MDS 9000 Family Command Reference
4-146
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
CRLLookup
Related Commands
Command
Description
show ldap-server
groups
Displays the configured LDAP server groups.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-147
Chapter 4
C Commands
crypto ca authenticate
crypto ca authenticate
To associate and authenticate a certificate of the certificate authority (CA) and configure its CA
certificate (or certificate chain), use the crypto ca authenticate command in configuration mode. The
CA certificate or certificate chain is assumed to already be available in Privacy Enhanced Mail (PEM)
(base-64) encoded format.
crypto ca authenticate trustpoint-label
Syntax Description
trustpoint-label
Defaults
None
Command Modes
Configuration mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Specifies the name of the trust point. The maximum size is 64
characters.
This command authenticates the CA to the switch by obtaining the self-signed certificate of the CA that
contains the public key of the CA. Because the CA signs its own certificate, you should manually
authenticate the public key of the CA by contacting the CA administrator when you execute this
command.
This command is required when you initially configure certificate authority support for the switch.
Before you attempt CA authentication, first create the trust point using the crypto ca trustpoint
command. The CA certificate fingerprint (the MD5 or SHA hash of the certificate) is generally published
by the CA. When authenticating the CA, the certificate fingerprint is displayed. The administrator needs
to compare it with the one published by the CA and accept the CA certificate only if it matches.
If the CA being authenticated is a subordinate CA (meaning that is is not self-signed), then it is certified
by another CA which in turn may be certified by yet another CA and so on until there is a self-signed
CA. In this case, the subordinate CA in question is said to have a CA certificate chain certifying it. The
entire chain must be input during CA authentication. The maximum length that the CA certificate chain
supports is ten.
The trust point CA is the certificate authority configured on the switch as the trusted CA. Any peer
certificate obtained will be accepted if it is signed by a locally trusted CA or its subordinates.
Note
The trust point configuration (created by the crypto ca trustpoint command) is persistent only if saved
explicitly using the copy running-config startup-config command. The certificates and CRL associated
to a trust point are automatically made persistent if the trust point in question was already saved in the
startup configuration. Conversely, if the trust point was not saved in the startup configuration, the
certificates and CRL associated to it are not made persistent automatically because they do not exist
without the corresponding trust point after the switch reboots.
Cisco MDS 9000 Family Command Reference
4-148
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto ca authenticate
To ensure that the configured certificates, CRLs and key pairs are made persistent, always save the
running configuration to the startup configuration.
Examples
The following example authenticates a CA certificate called admin-ca:
switch# config terminal
switch(config)# crypto ca authenticate myCA
input (cut & paste) CA certificate (chain) in PEM format;
end the input with a line containing only END OF INPUT :
-----BEGIN CERTIFICATE----MIIC4jCCAoygAwIBAgIQBWDSiay0GZRPSRIljK0ZejANBgkqhkiG9w0BAQUFADCB
kDEgMB4GCSqGSIb3DQEJARYRYW1hbmRrZUBjaXNjby5jb20xCzAJBgNVBAYTAklO
MRIwEAYDVQQIEwlLYXJuYXRha2ExEjAQBgNVBAcTCUJhbmdhbG9yZTEOMAwGA1UE
ChMFQ2lzY28xEzARBgNVBAsTCm5ldHN0b3JhZ2UxEjAQBgNVBAMTCUFwYXJuYSBD
QTAeFw0wNTA1MDMyMjQ2MzdaFw0wNzA1MDMyMjU1MTdaMIGQMSAwHgYJKoZIhvcN
AQkBFhFhbWFuZGtlQGNpc2NvLmNvbTELMAkGA1UEBhMCSU4xEjAQBgNVBAgTCUth
cm5hdGFrYTESMBAGA1UEBxMJQmFuZ2Fsb3JlMQ4wDAYDVQQKEwVDaXNjbzETMBEG
A1UECxMKbmV0c3RvcmFnZTESMBAGA1UEAxMJQXBhcm5hIENBMFwwDQYJKoZIhvcN
AQEBBQADSwAwSAJBAMW/7b3+DXJPANBsIHHzluNccNM87ypyzwuoSNZXOMpeRXXI
OzyBAgiXT2ASFuUOwQ1iDM8rO/41jf8RxvYKvysCAwEAAaOBvzCBvDALBgNVHQ8E
BAMCAcYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUJyjyRoMbrCNMRU2OyRhQ
GgsWbHEwawYDVR0fBGQwYjAuoCygKoYoaHR0cDovL3NzZS0wOC9DZXJ0RW5yb2xs
L0FwYXJuYSUyMENBLmNybDAwoC6gLIYqZmlsZTovL1xcc3NlLTA4XENlcnRFbnJv
bGxcQXBhcm5hJTIwQ0EuY3JsMBAGCSsGAQQBgjcVAQQDAgEAMA0GCSqGSIb3DQEB
BQUAA0EAHv6UQ+8nE399Tww+KaGr0g0NIJaqNgLh0AFcT0rEyuyt/WYGPzksF9Ea
NBG7E0oN66zex0EOEfG1Vs6mXp1//w==
-----END CERTIFICATE----END OF INPUT
Fingerprint(s): MD5 Fingerprint=65:84:9A:27:D5:71:03:33:9C:12:23:92:38:6F:78:12
Do you accept this certificate? [yes/no]:y
Related Commands
Command
Description
crypto ca trustpoint
Configures the trust point.
show crypto ca
certificates
Displays configured trust point certificates.
show crypto ca
trustpoints
Displays trust point configurations.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-149
Chapter 4
C Commands
crypto ca crl request
crypto ca crl request
To configure a new certificate revocation list (CRL) downloaded from the certificate authority (CA), use
the crypto ca crl request command in configuration mode.
crypto ca crl request trustpoint-label source-file
Syntax Description
trustpoint-label
Specifies the name of the trust point. The maximum size is 64
characters.
source-file
Specifies the location of the CRL in the form bootflash:filename. The
maximum size is 512.
Defaults
None
Command Modes
Configuration mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Cisco MDS NX-OS allows you to pre-download CRLs for the trust points and cache the CRLs in the cert
store using the crypto ca crl request command. During the verification of a peer certificate by
IPsec/IKE or SSH, the issuer CA’s CRL will be consulted only if it had already been configured locally,
and revocation checking is configured to use CRL. Otherwise, CRL checking is not done and a certificate
is considered to be not revoked if no other revocation checking methods are configured. This mode of
CRL checking is called CRL optional.
The other modes of revocation checking are called CRL best-effort and CRL mandatory. In these modes,
if the CRL is not found locally, there is an attempt to fetch it automatically from the CA. These modes
are not supported in MDS SAN-OS release 3.0(1).
The CRL file specified should contain the latest CRL in either Privacy Enhanced Mail (PEM) format or
Distinguished Encoding Rules (DER) format.
Note
The trust point configuration (created by the crypto ca trustpoint command) is persistent only if saved
explicitly using the copy running-config startup-config command. The certificates and CRL associated
to a trust point are automatically made persistent if the trust point in question was already saved in the
startup configuration. Conversely, if the trust point was not saved in the startup configuration, the
certificates and CRL associated to it are not made persistent automatically because they do not exist
without the corresponding trust point after the switch reboots.
To ensure that the configured certificates, CRLs and key pairs are made persistent, always save the
running configuration to the startup configuration.
Cisco MDS 9000 Family Command Reference
4-150
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto ca crl request
Examples
The following example configures a CRL for the trust point or replaces the current CRL:
switch# config t
switch(config)# crypto ca crl request admin-ca bootflash:admin-ca.crl
Related Commands
Command
Description
revocation-check
Configures trust point revocation check methods.
show crypto ca crl
Displays configured certificate revocation lists (CRL).
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-151
Chapter 4
C Commands
crypto ca enroll
crypto ca enroll
To request a certificate for the switch’s RSA key pair created for this trust point CA, use the crypto ca
enroll command in configuration mode.
crypto ca enroll trustpoint-label
Syntax Description
trustpoint-label
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Specifies the name of the trust point. The maximum size is 64
characters.
An MDS switch can enroll with the trust point CA to get an identity in the form of a certificate. You can
enroll your switch with multiple trust points, thereby getting a separate identity certificate from each.
When enrolling with a trust point, you must specify an RSA key pair to be certified. This key pair must
be generated and associated to the trust point before generating the enrollment request. The association
between the trust point, key pair, and identity certificate is valid until it is explicitly removed by deleting
the identity certificate first, followed by disassociating the key pair, and deleting the CA certificates (in
any order), and finally deleting the trust point itself, in that order only.
Use the crypto ca enroll command to generate a request to obtain an identity certificate from each of
your trust points corresponding to authenticated CAs. The certificate signing request (CSR) generated
is per Public-Key Cryptography Standards (PKCS) #10 standard, and is displayed in PEM format. Cut
and paste it and submit it to the corresponding CA through e-mail or the CA website. The CA
administrator issues the certificate and makes it available to you either through the website or by sending
it in e-mail. You need to import the obtained identity certificate to the corresponding trust point using
the crypto ca import trustpoint-label certificate command.
The challenge password is not saved with the configuration. This password is required in the event that
your certificate needs to be revoked, so you must remember this password.
Examples
The following example generates a certificate request for an authenticated CA:
switch# config t
switch(config)# crypto ca enroll myCA
Create the certificate request ..
Create a challenge password. You will need to verbally provide this
password to the CA Administrator in order to revoke your certificate.
For security reasons your password will not be saved in the configuration.
Please make a note of it.
Password:nbv123
Cisco MDS 9000 Family Command Reference
4-152
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto ca enroll
The subject name in the certificate will be: Vegas-1.cisco.com
Include the switch serial number in the subject name? [yes/no]:no
Include an IP address in the subject name [yes/no]:yes
ip address:209.165.200.226
The certificate request will be displayed...
-----BEGIN CERTIFICATE REQUEST----MIIBqzCCARQCAQAwHDEaMBgGA1UEAxMRVmVnYXMtMS5jaXNjby5jb20wgZ8wDQYJ
KoZIhvcNAQEBBQADgY0AMIGJAoGBAL8Y1UAJ2NC7jUJ1DVaSMqNIgJ2kt8rl4lKY
0JC6ManNy4qxk8VeMXZSiLJ4JgTzKWdxbLDkTTysnjuCXGvjb+wj0hEhv/y51T9y
P2NJJ8ornqShrvFZgC7ysN/PyMwKcgzhbVpj+rargZvHtGJ91XTq4WoVkSCzXv8S
VqyH0vEvAgMBAAGgTzAVBgkqhkiG9w0BCQcxCBMGbmJ2MTIzMDYGCSqGSIb3DQEJ
DjEpMCcwJQYDVR0RAQH/BBswGYIRVmVnYXMtMS5jaXNjby5jb22HBKwWH6IwDQYJ
KoZIhvcNAQEEBQADgYEAkT60KER6Qo8nj0sDXZVHSfJZh6K6JtDz3Gkd99GlFWgt
PftrNcWUE/pw6HayfQl2T3ecgNwel2d15133YBF2bktExiI6Ul88nTOjglXMjja8
8a23bNDpNsM8rklwA6hWkrVL8NUZEFJxqbjfngPNTZacJCUS6ZqKCMetbKytUx0=
-----END CERTIFICATE REQUEST-----
Related Commands
Command
Description
crypto ca import
trustpoint-label
certificate
Imports the identity certificate obtained fromthe CA to the trust point.
crypto key generate
rsa
Generates an RSA key pair.
rsakeypair
Configures and associates the RSA key pair details to a trust point.
show crypto key
mypubkey rsa
Displays all RSA public key configurations.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-153
Chapter 4
C Commands
crypto ca export
crypto ca export
To export the RSA key pair and the associated certificates (identity and CA) of a trust point within a
Public-Key Cryptography Standards (PKCS) #12 format file to a specified location, use the crypto ca
export command in configuration mode.
crypto ca exporttrustpoint-label pkcs12 destination-file-url pkcs12-password
Syntax Description
trustpoint-label
Specifies the name of the trust point. The maximum size is 64
characters.
pkcs12 destination-file-url
Specifies a destination file in bootflash:filename format. The maximum
size is 512 characters.
pkcs12-password
Specifies the password to be used to protect the RSA private key inthe
exported file. The maximum size is 64 characters.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
You can export the identity certificate along with the associated RSA key pair and CA certificate (or
certificate chain) to a PKCS #12 format file for backup purposes. You can later import the certificate and
RSA key pair to recover from a system crash on your switch.
Examples
The following example shows how to export a certificate and key pair in PKCS #12 format:
switch# config terminal
switch(config)# crypto ca export admin-ca pkcs12 bootflash:adminid.p12 nbv123
Related Commands
Command
Description
crypto ca import
trustpoint-label
certificate
Imports the identity certificate obtained from the CA to the trust point.
crypto ca import
trustpoint-label
pkcs12
Imports the identity certificate and associated RSA key pair and CA
certificate (chain) to a trust point.
crypto key generate
rsa
Generates an RSA key pair.
Cisco MDS 9000 Family Command Reference
4-154
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto ca export
Command
Description
rsakeypair
Configures and associates the RSA key pair details to a trust point.
show crypto key
mypubkey rsa
Displays any RSA public key configurations.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-155
Chapter 4
C Commands
crypto ca import
crypto ca import
To import the identity certificate alone in PEM format or the identity certificate and associated RSA key
pair and CA certificate (or certificate chain) in Public-Key Cryptography Standards (PKCS) #12 form,
use the crypto ca import command in configuration mode.
crypto ca import trustpoint-label {certificate | pkcs12 source-file-url pkcs12-password}
Syntax Description
trustpoint-label
Specifies the name of the trust point. The maximum size is 64
characters.
pkcs12 source-file-url
Specifies a source file in bootflash:filename format. The maximum size
is 512 characters.
pkcs12-password
Specifies the password that was used to protect the RSA private key in
the imported PKCS#12 file. The maximum size is 64 characters.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
The first form of the command, crypto ca import trustpoint-label certificate, is used to import (by cut
and paste means) the identity certificate obtained from the CA, corresponding to the enrollment request
generated earlier in the trust point and submitted to the CA. The administrator is prompted to cut and
paste the certificate.
The second form of the command, crypto ca import trustpoint-label pkcs12 source-file-url
pkcs12-password, is used to import the complete identity information (that is, the identity certficate and
associated RSA key pair and CA certificate or certficate chain) into an empty trust point. This command
is useful for restoring the configuration after a system goes down.
Note
The trust point configuration (created by the crypto ca trustpoint command) is persistent only if saved
explicitly using the copy running-config startup-config command. The certificates and CRL associated
to a trust point are automatically made persistent if the trust point in question was already saved in the
startup configuration. Conversely, if the trust point was not saved in the startup configuration, the
certificates and CRL associated to it are not made persistent automatically because they do not exist
without the corresponding trust point after the switch reboots.
To ensure that the configured certificates, CRLs and key pairs are made persistent, always save the
running configuration to the startup configuration.
Cisco MDS 9000 Family Command Reference
4-156
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto ca import
Examples
The following example installs an identity certificate obtained from a CA corresponding to an
enrollment request made and submitted earlier:
switch# config t
switch(config)# crypto ca import myCA certificate
input (cut & paste) certificate in PEM format:
-----BEGIN CERTIFICATE----MIIEADCCA6qgAwIBAgIKCjOOoQAAAAAAdDANBgkqhkiG9w0BAQUFADCBkDEgMB4G
CSqGSIb3DQEJARYRYW1hbmRrZUBjaXNjby5jb20xCzAJBgNVBAYTAklOMRIwEAYD
VQQIEwlLYXJuYXRha2ExEjAQBgNVBAcTCUJhbmdhbG9yZTEOMAwGA1UEChMFQ2lz
Y28xEzARBgNVBAsTCm5ldHN0b3JhZ2UxEjAQBgNVBAMTCUFwYXJuYSBDQTAeFw0w
NTExMTIwMzAyNDBaFw0wNjExMTIwMzEyNDBaMBwxGjAYBgNVBAMTEVZlZ2FzLTEu
Y2lzY28uY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC/GNVACdjQu41C
dQ1WkjKjSICdpLfK5eJSmNCQujGpzcuKsZPFXjF2UoiyeCYE8ylncWyw5E08rJ47
glxr42/sI9IRIb/8udU/cj9jSSfKK56koa7xWYAu8rDfz8jMCnIM4W1aY/q2q4Gb
x7RifdV06uFqFZEgs17/Elash9LxLwIDAQABo4ICEzCCAg8wJQYDVR0RAQH/BBsw
GYIRVmVnYXMtMS5jaXNjby5jb22HBKwWH6IwHQYDVR0OBBYEFKCLi+2sspWEfgrR
bhWmlVyo9jngMIHMBgNVHSMEgcQwgcGAFCco8kaDG6wjTEVNjskYUBoLFmxxoYGW
pIGTMIGQMSAwHgYJKoZIhvcNAQkBFhFhbWFuZGtlQGNpc2NvLmNvbTELMAkGA1UE
BhMCSU4xEjAQBgNVBAgTCUthcm5hdGFrYTESMBAGA1UEBxMJQmFuZ2Fsb3JlMQ4w
DAYDVQQKEwVDaXNjbzETMBEGA1UECxMKbmV0c3RvcmFnZTESMBAGA1UEAxMJQXBh
cm5hIENBghAFYNKJrLQZlE9JEiWMrRl6MGsGA1UdHwRkMGIwLqAsoCqGKGh0dHA6
Ly9zc2UtMDgvQ2VydEVucm9sbC9BcGFybmElMjBDQS5jcmwwMKAuoCyGKmZpbGU6
Ly9cXHNzZS0wOFxDZXJ0RW5yb2xsXEFwYXJuYSUyMENBLmNybDCBigYIKwYBBQUH
AQEEfjB8MDsGCCsGAQUFBzAChi9odHRwOi8vc3NlLTA4L0NlcnRFbnJvbGwvc3Nl
LTA4X0FwYXJuYSUyMENBLmNydDA9BggrBgEFBQcwAoYxZmlsZTovL1xcc3NlLTA4
XENlcnRFbnJvbGxcc3NlLTA4X0FwYXJuYSUyMENBLmNydDANBgkqhkiG9w0BAQUF
AANBADbGBGsbe7GNLh9xeOTWBNbm24U69ZSuDDcOcUZUUTgrpnTqVpPyejtsyflw
E36cIZu4WsExREqxbTk8ycx7V5o=
-----END CERTIFICATE-----
The following example shows how to import a certificate and key pair in a Public-Key Cryptography
Standards (PKCS) #12 format file:
switch# config t
witch(config)# crypto ca import admin-ca pkcs12 bootflash:adminid.p12 nbv123
Related Commands
Command
Description
crypto ca enroll
Generates a certificate signing request for a trust point.
crypto ca export
trustpoint-label
pkcs12
Exports the RSA key pair and associated certificates of a trust point.
crypto key generate
rsa
Generates the RSA key pair.
rsakeypair
Configures trust point RSA key pair details.
show crypto ca
certificates
Displays the identity and CA certificate details.
show crypto key
mypubkey rsa
Displays any RSA public key configurations.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-157
Chapter 4
C Commands
crypto ca test verify
crypto ca test verify
To verify a certificate file, use the crypto ca test verify command in configuration mode.
crypto ca test verify certificate-file
Syntax Description
certificate-file
Defaults
None
Command Modes
Configuration mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Specifies the certificate filename in the form bootflash:filename. The
maximum size is 512 characters.
Usage Guidelines
The crypto ca test verify command is only a test command. It verifies the specified certificate in PEM
format by using the trusted CAs configured and by consulting the CRL or OCSP if needed, as per the
revocation checking configuration.
Examples
The following example shows how to verify a certificate file. Verify status code 0 means the verification
is successful.
switch(config)# crypto ca test verify bootflash:id1.pem
verify status oode:0
verify error msg:
Related Commands
Command
Description
show crypto ca
certificates
Displays configured trust point certificates.
Cisco MDS 9000 Family Command Reference
4-158
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto ca lookup
crypto ca lookup
To configure the type of cretstore that PKI will use for authenticatio, use the crypto ca lookup command
in configuration mode. The disable this feature, use the no form of the command.
crypto ca lookup {both | local | remote}
Syntax Description
both
Specifies both local and remote certstore.
local
Specifies local certstore.
remote
Specifies remote certstore.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to configure both local and remote certstore:
switch(config)# crypto ca lookup both
switch(config)#
The following example shows how to configure local certstore:
switch(config)# crypto ca lookup local
switch(config)#
The following example shows how to configure remote certstore:
switch(config)# crypto ca lookup remote
switch(config)#
Related Commands
Command
Description
show crypto
ssh-auth-map
displays mapping filters applied for SSH authentication.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-159
Chapter 4
C Commands
crypto ca remote ldap
crypto ca remote ldap
To configure Ldap certstore, use the crypto ca remote ldap command in configuration mode. The
disable this feature, use the no form of the command.
crypto ca remote ldap {crl-refresh-time hours | server-group group-name}
Syntax Description
crl-refresh-time
Specifies timer to fetch crl from remote certstore.
hours
Specifies timer value in hours. The range will be from 0 - 744. i.e. The
refresh time can be configured at max for one month. So 31 * 24 = 744.
And if refresh-time is 0 then the refresh routine will be executed once at
the time of configuration.
server-group
Specifies LDAP server group.
group-name
Specifies LDAP server group name. The maximum size is 64 characters.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to configure timer to fetch crl from remote certstore:
switch(config)# crypto ca remote ldap crl-refresh-time 124
switch(config)#
The following example shows how to configure LDAP server group:
switch(config)# crypto ca remote ldap server-group admin
switch(config)#
Related Commands
Command
Description
show crypto
ssh-auth-map
displays mapping filters applied for SSH authentication.
Cisco MDS 9000 Family Command Reference
4-160
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto ca trustpoint
crypto ca trustpoint
To create a trust point certificate authority (CA) that the switch should trust, and enter trust point
configuration submode (config-trustpoint), use the crypto ca trustpoint command in configuration
mode. To remove the trust point, use the no form of the command.
crypto ca trustpoint trustpoint-label
no crypto ca trustpoint trustpoint-label
Syntax Description
trustpoint-label
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Specifies the name of the trust point. The maximum size is 64
characters.
Trust points have the following characteristics:
•
A trust point corresponds to a single CA, which an MDS switch trusts for peer certificate verification
for any application.
•
A CA must be explicitly associated to a trust point using the CA authentication process using the
crypto ca authenticate command.
•
An MDS switch can have many trust points and all applications on the switch can trust a peer
certificate issued by any of the trust point CAs.
•
A trust point is not restricted to a specific application.
•
The MDS switch can optionally enroll with a trust point CA to get an indemnity certificate for itself.
You do not need to designate one or more trust points to an application. Any application should be able
to use any certificate issued by any trust point as long as the certificate purpose satisfies application
requirement.
You do not need more than one identity certificate from a trust point or more than one key pair to be
associated to a trust point. A CA certifies a given identity (name) only once and does not issue multiple
certificates with the same subject name. If you need more than one identity certificate for a CA, define
another trust point for the same CA, associate another key pair to it, and have it certified, provided CA
allows multiple certificates with same subject name.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-161
Chapter 4
C Commands
crypto ca trustpoint
Note
Examples
Before using the no crypto ca trustpoint command to remove the trust point, first delete the identity
certificate and CA certificate (or certificate chain) and then disassociate the RSA key pair from the trust
point. The switch enforces this behavior to prevent the accidental removal of the trust point along with
the certificates.
The following example declares a trust point CA that the switch should trust and enters trust point
configuration submode:
switch# config terminal
switch(config)# crypto ca trustpoint admin-ca
switch(config-trustpoint)#
The following example removes the trust point CA:
switch# config terminal
switch(config)# no crypto ca trustpoint admin-ca
Related Commands
Command
Description
crypto ca authenticate Authenticates the certificate of the certificate authority.
crypto ca enroll
Generates a certificate signing request for a trust point.
show crypto ca
certificates
Displays the identity and CA certificate details.
show crypto ca
trustpoints
Displays trust point configurations.
Cisco MDS 9000 Family Command Reference
4-162
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto certificatemap mapname
crypto certificatemap mapname
To configure the certificate map that will be used for filtering the certificate request, use the crypto
certificatemap mapname command in configuration mode. To disable this feature, use the no form of
the command.
crypto certificatemap mapname mapname
Syntax Description
mapname
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Specifies the name of the filter map. The maximum size is 64 characters.
Usage Guidelines
None
Examples
The following example shows how to display mapping filters applied for SSH authentication:
switch(config)# crypto certificatemap mapname map1
switch(config-certmap-filter)#
Related Commands
Command
Description
show crypto
ssh-auth-map
displays mapping filters applied for SSH authentication.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-163
Chapter 4
C Commands
crypto cert ssh-authorize
crypto cert ssh-authorize
To configure mapping filter for SSH, use the crypto cert ssh-authorize command in configuration
mode. To disable this feature, use the no form of the command.
crypto cert ssh-authorize name map map name1 mapname2
Syntax Description
name
Specifies issuer name of the certificate. The maximum size is 64
characters.
map
Specifies mapping filter.
map name
Specifies the name of the mapping filter that is already configured. The
maximum size is 64 characters.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
None
Examples
The following example shows how to configure mapping filter for SSH:
switch(config)# crypto cert ssh-authorize DCBU map map1 map2
switch(config)#
The following example shows how to configure default mapping filter for SSH:
switch(config)# crypto cert ssh-authorize default map map1 map2
switch(config)#
Related Commands
Command
Description
show crypto
ssh-auth-map
displays mapping filters applied for SSH authentication.
Cisco MDS 9000 Family Command Reference
4-164
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto global domain ipsec security-association lifetime
crypto global domain ipsec security-association lifetime
To configure global parameters for IPsec, use the crypto global domain ipsec security-association
lifetime command. To revert to the default, use the no form of the command.
crypto global domain ipsec security-association lifetime {gigabytes number | kilobytes number |
megabytes number | seconds number}
no crypto global domain ipsec security-association lifetime {gigabytes | kilobytes | megabytes
| seconds}
Syntax Description
gigabytes number
Specifies a volume-based key duration in gigabytes. The range is 1 to 4095.
kilobytes number
Specifies a volume-based key duration in kilobytes. The range is 2560 to
2147483647.
megabytes number
Specifies a volume-based key duration in megabytes. The range is 3 to
4193280.
seconds number
Specifies a time-based key duration in seconds. The range is 600 to 86400.
Defaults
450 gigabytes and 3600 seconds
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, IPsec must be enabled using the crypto ipsec enable command.
The global security association lifetime value can be overridden for individual IPsec crypto maps using
the set command in IPsec crypto map configuration submode.
Examples
The following example shows how to configure the system default before the IPsec:
switch# config terminal
switch(config)# crypto global domain ipsec security-association lifetime gigabytes 500
Related Commands
Command
Description
crypto ipsec enable
Enables IPsec.
set (IPsec crypto map
configuration submode)
Configures IPsec crypto map entry parameters.
show crypto global domain ipsec Displays the global attributes for IPsec.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-165
Chapter 4
C Commands
crypto ike domain ipsec
crypto ike domain ipsec
To enter IKE configuration submode, use the crypto ike domain ipsec command.
crypto ike domain ipsec
Syntax Description
This command has no other arguments or keywords.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
Note
To configure IKE protocol attributes, IKE must be enabled using the crypto ike enable command.
•
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP
c-Class BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
•
The crypto ike feature is not supported on the Cisco MDS 9148 and Cisco MDS 9148S Switches.
<<Shashi: The above Note has been profiled for 6.2.13 updates (currently suppressed).>>
Examples
The following example shows how enter IKE configuration mode:
switch# config terminal
switch(config)# crypto ike domain ipsec
switch(config-ike-ipsec)#
Related Commands
Command
Description
crypto ike enable
Enables the IKE protocol.
show crypto ike domain ipsec Displays IKE information for the IPsec domain.
Cisco MDS 9000 Family Command Reference
4-166
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto ike domain ipsec rekey sa
crypto ike domain ipsec rekey sa
To rekey an IKE crypto security association (SA) in the IPsec domain, use the crypto ike domain ipsec
rekey sa command.
crypto ike domain ipsec rekey sa sa-index
Syntax Description
sa-index
Defaults
None
Command Modes
EXEC mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
Note
Examples
Specifies the SA index. The range is 1 to 2147483647.
To use this command, IKE must be enabled using the crypto ike enable command.
•
This command is not supported on the Cisco MDS 9124 switch.
•
The crypto ike feature is not supported on the Cisco MDS 9148 and Cisco MDS 9148S Switches.
The following example rekeys an IKE crypto SA:
switch# crypto ike domain ipsec rekey sa 100
Related Commands
Command
Description
crypto ike enable
Enables the IKE protocol.
show crypto ike domain ipsec Displays IKE information for the IPsec domain.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-167
Chapter 4
C Commands
crypto ike enable
crypto ike enable
To enable IKE, use the crypto ike enable command. To disable IKE, use the no form of the command.
crypto ike enable
no crypto ike enable
Syntax Description
This command has no other arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
NX-OS 4.1(1b)
This command was deprecated.
Usage Guidelines
The IKE protocol cannot be disabled unless IPsec is disabled.
The configuration and verification commands for the IKE protocol are only available when the IKE
protocol is enabled on the switch. When you disable this feature, all related configurations are
automatically discarded.
Note
Examples
•
This command is not supported on the Cisco MDS 9124 switch.
•
The crypto ike feature is not supported on the Cisco MDS 9148 and Cisco MDS 9148S Switches.
The following example shows how to enable the IKE protocol:
switch# config terminal
switch(config)# crypto ike enable
Related Commands
Command
Description
clear crypto ike domain ipsec Clears IKE protocol information clear IKE SAs.
sa
crypto ipsec enable
Enables IPsec.
show crypto ike domain ipsec Displays IKE information for the IPsec domain.
Cisco MDS 9000 Family Command Reference
4-168
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto ipsec enable
crypto ipsec enable
To enable IPsec, use the crypto ipsec enable command. To disable IPsec, use the no form of the
command.
crypto ipsec enable
no crypto ipsec enable
Syntax Description
This command has no other arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To enable the IPsec, the IKE protocol must be enabled using the crypto ike enable command.
The configuration and verification commands for IPsec are only available when IPsec is enabled on the
switch. When you disable this feature, all related configurations are automatically discarded.
Note
Examples
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example shows how to enable IPsec:
switch# config terminal
switch(config)# crypto ipsec enable
Related Commands
Command
Description
show crypto global domain ipsec Displays IPsec crypto global information.
show crypto map domain ipsec
Displays IPsec crypto map information.
show crypto transform-set
domain ipsec
Displays IPsec crypto transform set information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-169
Chapter 4
C Commands
crypto key generate rsa
crypto key generate rsa
To generate an RSA key pair, use the crypto key generate rsa command in configuration mode.
crypto key generate rsa [label key-pair-label] [exportable] [modulus key-pair-size]
Syntax Description
label key-pair-label
(Optional) Specifies the name of the key pair. The maximum size is 64
characters.
exportable
(Optional) Configures the key pair to be exportable.
modulus key-pair-size
(Optional) Specifies the size of the key pair. The size ranges from 512
to 2048.
Defaults
By default, the key is not exportable.
The default label is switch FQDN.
The default modulus is 512.
Command Modes
Configuration mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
You can generate one or more RSA key pairs and associate each RSA key pair with a distinct trust point
CA, where the MDS switch enrolls to obtain identity certificates. The MDS switch needs only one
identity per CA, which consists of one key pair and one identity certificate.
Cisco MDS NX-OS allows you to generate RSA key pairs with a configurable key size (or modulus).
The default key size is 512. Valid modulus values are 512, 768, 1024, 1536, and 2048.
You can also configure an RSA key pair label. The default key pair label is FQDN.
Examples
The following example shows how to configure an RSA key pair called newkeypair:
switch# config terminal
switch(config)# crypto key generate rsa label newkeypair
The following example shows how to configure an RSA key pair called testkey, of size 768, that is
exportable:
switch# config terminal
switch(config)# crypto key generate rsa label testkey exportable modulus 768
The following example shows how to generate an exportable RSA key with the switch name as the
default label and 512 as the default modulus:
switch# config terminal
switch(config)# crypto key generate rsa exportable
Cisco MDS 9000 Family Command Reference
4-170
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto key generate rsa
Related Commands
Command
Description
crypto key zeroize rsa
Deletes RSA key pair configurations.
rsakeypair
Configures trust point RSA key pair details.
show crypto key
mypubkey rsa
Displays information about configured RSA key pairs.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-171
Chapter 4
C Commands
crypto key zeroize rsa
crypto key zeroize rsa
To delete an RSA key pair from the switch, use the crypto key zeroize rsa command in configuration
mode.
crypto key zeroize rsa key-pair-label
Syntax Description
key-pair-label
Specifies the RSA key pair to delete. The maximum size is 64
characters.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
If you believe the RSA key pair on your switch was compromised in some way and should no longer be
used, you should delete it.
After you delete the RSA key pair on the switch, ask the CA administrator to revoke your switch’s
certificates at the CA. You must supply the challenge password you created when you originally
requested the switch’s certificates.
Before deleting a key pair, you should delete the identity certificates corresponding to it in various trust
points if the identity certificates exist, and then disassociate the key pair from those trust points. The
purpose of this is to prevent accidental deletion of a key pair for which there exists an identity certificate
in a trust point.
Note
The trust point configuration, certificates, and key pair configurations are made persistent only after
saving to the startup configuration. To be consistent with this configuration behavior, the delete behavior
is also the same. That is, the deletions are made persistent only after saving to the startup configuration.
Use the copy running-config startup-config command to make the certificate and key pair deletions
persistent.
Examples
The following example shows how to delete an RSA key pair called testkey:
switch# config terminal
switch(config)# crypto key zeroize rsa testkey
Cisco MDS 9000 Family Command Reference
4-172
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto key zeroize rsa
Related Commands
Command
Description
crypto key generate
rsa
Configures an RSA key pair.
rsakeypair
Configures trust point RSA key pair details.
show crypto key
mypubkey rsa
Displays information about configured RSA key pairs.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-173
Chapter 4
C Commands
crypto map domain ipsec (configuration mode)
crypto map domain ipsec (configuration mode)
To specify an IPsec crypto map and enter IPsec crypto map configuration mode, use the crypto map
domain ipsec command. To delete an IPsec crypto map or a specific entry in an IPsec crypto map, use
the no form of the command.
crypto map domain ipsec map-name [seq-number]
no crypto map domain ipsec map-name [seq-number]
Syntax Description
map-name
Specifies the map name. Maximum length is 63 characters.
seq-number
(Optional) Specifies the sequence number for the map entry. The range is 1
to 65535.
Defaults
None
Command Modes
Configuration mode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, IPsec must be enabled using the crypto ipsec enable command.
The sequence number determines the order in which IPsec crypto map entries are applied.
Examples
The following example specifies entry 1 for IPsec crypto map IPsecMap and enters IPsec crypto map
configuration mode:
switch# config terminal
switch(config)# crypto map domain ipsec IPsecMap 1
switch(config-crypto-map-ip)#
The following example deletes an IPsec crypto map entry:
switch# config terminal
switch(config)# no crypto map domain ipsec IPsecMap 1
The following example deletes the entire IPsec crypto map:
switch# config terminal
switch(config)# no crypto map domain ipsec IPsecMap
Cisco MDS 9000 Family Command Reference
4-174
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto map domain ipsec (configuration mode)
Related Commands
Command
Description
crypto ipsec enable
Enables IPsec.
crypto transform-set domain
ipsec
Configures the transform set for an IPsec crypto map.
set (IPsec crypto map
configuration submode)
Configures IPsec crypto map entry parameters.
show crypto map domain ipsec
Displays IPsec crypto map information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-175
Chapter 4
C Commands
crypto map domain ipsec (interface configuration submode)
crypto map domain ipsec (interface configuration submode)
To configure an IPsec crypto map on a Gigabit Ethernet interface, use the crypto map domain ipsec
command in interface configuration submode. To remove the IPsec crypto map, use the no form of the
command.
crypto map domain ipsec map-name
no crypto map domain ipsec
Syntax Description
map-name
Defaults
None
Command Modes
Interface configuration submode
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
Specifies the map name. Maximum length is 63 characters.
To use this command, IPsec must be enabled using the crypto ipsec enable command.
The sequence number determines the order in which crypto maps are applied.
Examples
The following example shows how to specify an IPsec crypto map for a Gigabit Ethernet interface:
switch# config terminal
switch(config)# interface gigabitethernet 1/2
switch(config-if)# crypto map domain ipsec IPsecMap
Related Commands
Command
Description
crypto ipsec enable
Enables IPsec.
show crypto map domain ipsec Displays IPsec crypto map information.
show interface
Displays interface information.
Cisco MDS 9000 Family Command Reference
4-176
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
crypto transform-set domain ipsec
crypto transform-set domain ipsec
To create and configure IPsec transform sets, use the crypto transform-set domain ipsec command. To
delete an IPsec transform set, use the no form of the command.
crypto transform-set domain ipsec set-name {esp-3des | esp-des} [esp-aes-xcbc-mac |
esp-md5-hmac | esp-sha1-hmac]
crypto transform-set domain ipsec set-name esp-aes {128 | 256} [ctr {esp-aes-xcbc-mac |
esp-md5-hmac | esp-sha1-hmac} | esp-aes-xcbc-mac | esp-md5-hmac | esp-sha1-hmac]
no crypto transform-set domain ipsec set-name{esp-3des | esp-des} [esp-aes-xcbc-mac |
esp-md5-hmac | esp-sha1-hmac]
no crypto transform-set domain ipsec set-name esp-aes {128 | 256} [ctr {esp-aes-xcbc-mac |
esp-md5-hmac | esp-sha1-hmac} | esp-aes-xcbc-mac | esp-md5-hmac | esp-sha1-hmac]
Syntax Description
Defaults
set-name
Specifies the transform set name. Maximum length is 63 characters.
esp-3des
Specifies ESP transform using the 3DES cipher (128 bits).
esp-des
Specifies ESP transform using the DES cipher (56 bits).
esp-aes-xcbc-mac
Specifies ESP transform using AES-XCBC-MAC authentication.
esp-md5-hmac
Specifies ESP transform using MD5-HMAC authentication.
esp-sha1-hmac
Specifies ESP transform using SHA1-HMAC authentication
esp-aes
Specifies ESP transform using the AES cipher (128 or 256 bits).
128
Specifies ESP transform using AES 128-bit cipher.
256
Specifies ESP transform using AES 256-bit cipher.
ctr
Specifies AES in counter mode.
None
The default mode of AES is CBC (Cyber Block Chaining).
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, IPsec must be enabled using the crypto ipsec enable command.
You can use this command to modify existing IPsec transform sets. If you change a transform set
definition, the change is only applied to crypto map entries that reference the transform set. The change
is not applied to existing security associations, but used in subsequent negotiations to establish new
security associations. If you want the new settings to take effect sooner, you can clear all or part of the
security association database using the clear crypto sa domain ipsec command.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-177
Chapter 4
C Commands
crypto transform-set domain ipsec
Examples
The following example shows how to configure an IPsec transform set:
switch# config terminal
switch(config)# crypto transform-set domain ipsec Set1 esp-aes 128
Related Commands
Command
Description
clear crypto sa domain ipsec
Clears security associations.
crypto ipsec enable
Enables IPsec.
show crypto transform-set
domain ipsec
Displays IPsec crypto transform set information.
Cisco MDS 9000 Family Command Reference
4-178
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 4
C Commands
customer-id
customer-id
To configure the customer ID with the Call Home function, use the customer-id command in Call Home
configuration submode. To disable this feature, use the no form of the command.
customer-id customer-id
no customer customer-id
Syntax Description
customer-id
Defaults
None
Command Modes
Call Home configuration submode
Command History
Release
Modification
1.0(2)
This command was introduced.
Specifies the customer ID. The maximum length is 64 alphanumeric
characters in free format.
Usage Guidelines
None.
Examples
The following example shows how to configure the customer ID in the Call Home configuration
submode:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# customer-id Customer1234
Related Commands
Command
Description
callhome
Configures the Call Home function.
callhome test
Sends a dummy test message to the configured destination(s).
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
4-179
Chapter 4
C Commands
customer-id
Cisco MDS 9000 Family Command Reference
4-180
OL-29295-04, Cisco MDS NX-OS Release 6.x
CH A P T E R
2
Caching Services Module Commands
The commands in this chapter apply to the SAN Volume Controller (SVC) software and the Caching
Services Module (CSM) in Cisco MDS 9000 Family of multilayer directors and fabric switches. All
commands are shown here in alphabetical order regardless of command mode.
For more information on virtualization using the CSM, see the “Related Documentation” section on
page vi.
Cisco MDS 9000 Family Command Reference
2-1
Chapter 2
Caching Services Module Commands
cluster add
cluster add
To create a cluster with a specified SVC node, use the cluster add command in SVC configuration mode.
cluster add cluster-name ip ip-address node svc slot-number/node-number
Syntax Description
cluster
Provides access to cluster commands
add cluster-name
Specifies a new cluster addition. The cluster name must start with an alphabet
and is restricted to 15 alphanumeric characters, including dash (-) and
underscore (_). The cluster name cannot be ClusterX, where X is a number.
ip ip-address
Specifies the IP address of the specified cluster. The IP address must be in the
same subnet as the switch management IP address.
node svc
Specifies the node’s SVC interface
slot-number
Specifies the slot number of the Caching Service Module (CSM).
node-number
Specifies the node number of the SVC instance running on the CSM. This
number ranges from 1 to 2 nodes per module.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
Enter this command while connected to the switch management IP address of a node at which the cluster
is being created.
Examples
The following example enters the SVC configuration mode, verifies the status of previously-configured
clusters, and adds a cluster called SampleCluster.
switch# svc-config
switch(svc)# show nodes local
------------------------------------------------------------------------------Node
cluster
config
cluster
node
sw
node
status
status
version
------------------------------------------------------------------------------svc2/1
No
unconfigured free
1.3(1)
svc2/2
No
unconfigured free
1.3(1)
switch(svc)# cluster add SampleCluster ip 10.10.0.1 node svc 2/1
cluster creation going on. Please wait....
Cisco MDS 9000 Family Command Reference
2-2
Chapter 2
Caching Services Module Commands
cluster add
The status of the newly-added cluster can be verified using the show nodes local command.
switch(svc)# show nodes local
------------------------------------------------------------------------------Node
cluster
config cluster
node
sw
node
status
status
version
------------------------------------------------------------------------------svc2/1
SampleCluster
Yes
active
active
1.3(1)
svc2/2
No
unconfigured
free
1.3(1)
Related Commands
Command
Description
show nodes local
Displays the cluster name and status for all nodes in the switch.
Cisco MDS 9000 Family Command Reference
2-3
Chapter 2
Caching Services Module Commands
cluster config
cluster config
To manage cluster configurations on a specified cluster, use the cluster config configuration submode.
cluster config cluster-name
Syntax Description
cluster
Provides access to cluster commands
config cluster-name
Places a previously created cluster in the cluster configuration submode
(switch(svc-cluster)#).
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following example enters the SVC configuration mode and adds a cluster called SampleCluster.
switch(svc)# cluster config SampleCluster
switch(svc-cluster)#
Related Commands
Command
Description
show cluster
Displays configured cluster information.
Cisco MDS 9000 Family Command Reference
2-4
Chapter 2
Caching Services Module Commands
cluster name
cluster name
To perform operations on a previously-configured cluster, use the cluster name command in SVC
configuration mode.
cluster name cluster-name flash-copy fc-grp-name [prepare | start | stop]
cluster name cluster-name remote-copy rc-grp-name {failover | start [aux | clean | force] | stop
aux-enable}
cluster name cluster-name shutdown [node node-name]
cluster name cluster-name start discovery
cluster name cluster-name upgrade svc-system [force]}
Syntax Description
cluster
Provides access to cluster commands
name cluster-name
Identifies a previously created cluster to perform an operation.
flash-copy fc-grp-name Specifies a previously-configured FlashCopy relationship.
prepare
Prepares the FlashCopy consistency group.
start
Starts the FlashCopy for the specified cluster.
Starts the background copy for the specified remote copy group
stop
Stops the FlashCopy for the specified cluster.
Stops the remote copy relationships for the specified remote copy group.
remote-copy
rc-grp-name
Specifies the remote copy consistency group name.
failover
Reverses to using the auxiliary VDisks for the specified relationship.
shutdown
Shuts down the entire cluster (gracefully).
node node-name
Specifies a particular node for a graceful shutdown.
start discovery
Starts the background copy for the specified remote copy group.
aux
Makes the auxiliary VDisks as primary.
clean
Marks the intended secondary VDisks as clean.
upgrade svc-system
Upgrades the specified cluster. The new version of the software image is
specified to the FTP:, SCP:, SFTP:, TFTP:, bootflash:, or slot0: directories
force
Permits the remote copy operation to start—even if it leads to the loss of data
consistency between the primary and secondary.
aux-enable
Enables write access o the secondary (or auxiliary) VDisks.
Defaults
None.
Command Modes
SVC configuration mode.
Cisco MDS 9000 Family Command Reference
2-5
Chapter 2
Caching Services Module Commands
cluster name
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following example enters the SVC configuration mode and displays all options under the cluster
name command.
switch# svc-config
switch(svc)# cluster name SampleCluster ?
flash-copy
Flash-copy
remote-copy Remote copy
shutdown
Shutdown
start
Start discovery
upgrade
Upgrade uri
switch(svc)# cluster name SampleCluster flash-copy f1 prepare
switch(svc)# cluster name SampleCluster flash-copy f1 start
switch(svc)# cluster name SampleCluster flash-copy f1 stop
switch(svc)# cluster name SampleCluster remote-copy f1 failover
switch(svc)# cluster name SampleCluster remote-copy f1 start
switch(svc)# cluster name SampleCluster remote-copy f1 stop
switch(svc)# cluster name SampleCluster shutdownn
switch(svc)# cluster name SampleCluster shutdown node svc2/1
switch(svc)# cluster name SampleCluster start discovery
switch(svc)# cluster name SampleCluster upgrade svc-system
bootflash:m9000-ek9-csm-svc_mz.1.3.1.bin
Cisco MDS 9000 Family Command Reference
2-6
Chapter 2
Caching Services Module Commands
dir modflash:
dir modflash:
To display the contents of the modflash: file system, use the dir modflash: command in EXEC mode.
dir modflash://module-number-node-number-path
Syntax Description
modflash:
Flash image that resides on the Caching Services Module (CSM).
module-number
Specifies the slot number in which the CSM resides.
node-number
Specifies one of the two nodes in the CSM (SVC node). The options are 1 or
2.
path
Specifies the volatile or the cores paths.
volatile
Displays the /var and /tmp of the SVC node on the supervisor module and
can be used to move files from/to the SVC node.
cores
Displays process, kernel crash dumps, and other trace information used to
debug software issues.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following example shows how to list the files on the bootflash directory.
switch# dir modflash://2-2-cores
switch# dir modflash://2-2-volatile
Related Commands
Command
Description
delete
Deletes a file on a Flash memory device.
Cisco MDS 9000 Family Command Reference
2-7
Chapter 2
Caching Services Module Commands
feature enable
feature enable
To enable a specified feature in a cluster, use the feature enable command in the cluster configuration
submode.
cluster config cluster-name
feature enable {capacity number | flash-copy | remote-copy}
Syntax Description
cluster
Provides access to cluster commands
config cluster-name
Places a previously created cluster in the cluster configuration submode.
feature enable
Enables a specified feature on this cluster. Three features can be enabled:
capacity, flash-copy, or remote-copy
capacity
Configures the virtualization capacity of this cluster.
number
Provides a range from 1- 1677215 Gigabytes.
flash-copy
Enables the flash-copy feature for this cluster.
remote-copy
Enables the remote-copy feature for this cluster.
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
The cluster configuration submode prompt is (switch(svc-cluster)#).
By default, flash-copy and remote-copy are disabled and 0 (zero) GB of virtualization capacity is
enabled.
Examples
The following example enters the cluster configuration submode for the SampleCluster cluster and
assigns a size of 4000 Gigabytes. The next two commands enables the flash-copy and remote-copy
features for this cluster.
switch(svc)# cluster config SampleCluster
switch(svc-cluster)# feature enable ?
capacity
Cluster enable feature capacity
flash-copy
Cluster enable feature flash-copy
remote-copy Cluster enable feature remote-copy
switch(svc-cluster)# feature enable capacity ?
<0-2147483647> Enter the capacity
switch(svc-cluster)# feature enable capacity 4000
Cisco MDS 9000 Family Command Reference
2-8
Chapter 2
Caching Services Module Commands
feature enable
switch(svc-cluster)# feature enable flash-copy
switch(svc-cluster)# feature enable remote-copy
Related Commands
Command
Description
show cluster name
flash-copy
Displays configured flash-copy information for a specified cluster.
show cluster name
remote-copy
Displays configured remote copy information for a specified cluster.
Cisco MDS 9000 Family Command Reference
2-9
Chapter 2
Caching Services Module Commands
flash-copy
flash-copy
To create a snapshot (or point-in-time copy) of a specified VDisk or group of VDisks, use the flash-copy
command in the cluster configuration submode.
cluster config cluster-name
flash-copy add fcopy-name
flash-copy name fcopy-name
map src-vdisk vdisk-name dst-vdisk vdisk-name |
[mode copy-on-write | full rate rate]
flash-copy rename old-name newname new-name
Syntax Description
cluster
Provides access to cluster commands
config cluster-name
Places a previously created cluster in the cluster configuration submode.
flash-copy add fcopy-name Creates a FlashCopy instance.
flash-copy fcopy-name
Enters the FlashCopy submode for an existing copy name.
map
Creating a mapping between the source and destination VDisks.
src-vdisk vdisk-name
Specifies the source VDisk for the flash copy.
dst-vdisk vdisk-name
Specifies the destination VDisk for the flash copy.
mode
Controls the FlashCopy mode.
copy-on-write
Copies to the source VDisk only if new information in written to it after
FlashCopy is initiated (default).
full rate rate
Specifies the background copy rate (ranges from 1 to 100) at which the
source VDisk is copied to the destination VDisk even if no new
information is written to the source.
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
The cluster configuration submode prompt is (switch(svc-cluster)#.
The flash-copy submode prompt is switch(svc-cluster-flash-copy)#.
Examples
The following example enters the enters the cluster configuration mode for the SampleCluster 1 cluster.
switch(svc)# cluster config SampleCluster
Cisco MDS 9000 Family Command Reference
2-10
Chapter 2
Caching Services Module Commands
flash-copy
switch(svc-cluster)# flash-copy f2
switch(svc-cluster-flash-copy)# ?
Submode Commands:
exit Exit from this mode
map
Flash-copy map
mode Flash-copy mode
no
Negate a command or set its defaults
switch(svc-cluster-flash-copy)# map src-vdisk VDISK1 dst-vdisk DDISK1
switch(svc-cluster-flash-copy)# mode copy-on-write
switch(svc-cluster-flash-copy)# exit
switch(svc-cluster)# flash-copy add FlashC2
switch(svc-cluster)# exit
switch(svc)# show SampleCluster flash-copy
------------------------------------------------------------------------------name
status
------------------------------------------------------------------------------fccstgrp0
idle_or_copied
f2
idle_or_copied
switch(svc)# show SampleCluster flash-copy f2
Flash-copy mapping 1:
src vdisk is v2
dest vdisk is v3
state is idle_or_copied
copy rate is 50
progress 0% done
Related Commands
Command
Description
show SampleCluster name
flash-copy
Displays configured flash-copy information for a specified
SampleCluster.
Cisco MDS 9000 Family Command Reference
2-11
Chapter 2
Caching Services Module Commands
host
host
To create or configure hosts, use the host command in the cluster configuration submode.
cluster config cluster-name
host add host-name hostport port-wwn
host name host-name
hostport port-wwn |
map vdisk vdisk-name [SCSI-lun lun-number]
Syntax Description
cluster
Provides access to cluster commands
config cluster-name
Places a previously created cluster in the cluster configuration submode.
host add host-name
Creates a host with one port and assigns the host name.
hostport port-wwn
Specifies a port using the port WWN
host name host-name
Enters the host submode for an existing host name.
map
Maps a previously configured disk to this host.
vdisk vdisk-name
Specifies the VDisk to be mapped to the host.
SCSI-lun lun-number
Specifies a LUN to map the host port. If the LUN number is not specified,
the next available number is assigned automatically.
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
The cluster configuration submode prompt is (switch(svc-cluster)#).
The host submode prompt is switch (svc-cluster-host)#
Examples
The following example enters the cluster configuration mode for SampleCluster and creates a host called
Host 1with one port, adds a second port, and maps the VDisk for Host1, and verifies the configured
information for Host1.
switch(svc)# cluster config SampleCluster
switch(svc-cluster)# host add Host1 hostport 11:22:33:44:aa:bb:cc:dd
switch(svc-cluster)# host Host1
switch(svc-cluster-host)# ?
Submode Commands:
exit
Exit from this mode
Cisco MDS 9000 Family Command Reference
2-12
Chapter 2
Caching Services Module Commands
host
hostport
map
no
Add pWWN to host
Map vdisk to host
Negate a command or set its defaults
switch(svc-cluster-host)# hostport 22:11:33:55:11:aa:bb:cc
switch(svc-cluster)# host add Host1 hostport 35:66:11:22:aa:bb:22:cc
switch(svc-cluster)# host Host1
switch(svc-cluster-host)# hostport 35:66:11:22:aa:bb:22:11
switch(svc-cluster-host)# map vdisk Vdisk1
switch(svc-cluster-host)# map vdisk Vdisk1 ssci-lun 10
Related Commands
Command
Description
show cluster name host Displays configured host information for a specified cluster.
Cisco MDS 9000 Family Command Reference
2-13
Chapter 2
Caching Services Module Commands
install module node
install module node
To install the SVC node image, use the install module node command.
install module module-number node node-number image svc-system [bootflash: | slot0: | ftp: |
sftp: | scp: | svc-image]
Syntax Description
install module
Installs the specified image for the CSM.
module-number
Switching modules:
From slot 1 to 4 and 7 to 9 in a Cisco MDS 9500 Series switch.
For slot 2 in a Cisco MDS 9200 Series switch.
Supervisor modules:
Slot 5 or 6—only on the active supervisor module in a Cisco MDS 9500
Series switch.
Slot 1—upgrades both the supervisor and switching parts of the module in a
Cisco MDS 9200 Series switch.
node
Selects the SVC node to install the image.
node-number
Specifies the node number.
image svc-system
Specifies the file name of an SVC image.
bootflash:
Source location for internal bootflash memory
ftp
URI containing SVC Image.
scp
URI containing SVC Image.
sftp
URI containing SVC Image.
tftp
URI containing SVC Image.
slot0:
Source location for the CompactFlash memory or PCMCIA card.
svc-image
The name of the SAN Volume Controller (SVC) image.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(3).
Usage Guidelines
The install module module-number node command installs the new image in the specified node on the
CSM module. All previous data in that node is lost.
Examples
The following example shows how to install a new image on an SVC node.
switch# install module 2 node 1 image svc-system
scp://[email protected]/auto/isan-src/MAIN_1_3_0_17t/VegasSW/build/gdb.sb-svc/isan/target
fs/sb-svc.bin
Cisco MDS 9000 Family Command Reference
2-14
Chapter 2
Caching Services Module Commands
install module node
SVC reimage going on. Please wait
[email protected]'s password:
sb-svc.bin
100% |*****************************| 45408 KB
svc 2/1 software reimage succeeded
Related Commands
00:53
Command
Description
show version
compatibility
Shows the system software that is currently running on the switch
Cisco MDS 9000 Family Command Reference
2-15
Chapter 2
Caching Services Module Commands
interface svc
interface svc
To configure a SAN Volume Controller (SVC) interface on the Cisco MDS 9000 Family of switches, use
the interface svc command.
interface svc slot_number/node-number
interface svc slot_number/node-number initiator | mgmt | nwwn nwwn-id target vsan vsan-id
interface svc slot_number/node-number switchport description | shutdown]
Syntax Description
interface
Configures a new interface.
svc
Specifies the new interface to be a SVC interface.
slot-number
Specifies the slot number of the Caching Service Module (CSM).
node-number
Specifies the node number of the SVC instance running on the CSM. This
number ranges from 1 to 2 nodes per module.
initiator
Configures the initiator or port in the specified VSAN.
mgmt
Configures the management or port in the specified VSAN.
target
Configures the target or port in the specified VSAN.
vsan vsan-id
Specifies the VSAN ID ranging from 1 to 4093.
shutdown
Enables or disables an interface.
nwwn nwwn-id
Configured a non-system allocated nWWN for SVC Node.
switchport description Assigns a description to the switchport. Restricted to 80 alphanumeric
characters.
Defaults
None.
Command Modes
Configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
By default, all three N-port types (initiator, mgmt, and target) are in VSAN 1. Explicitly remove it from
VSAN 1 if this is not required by your network.
The VSAN number can be any number from 1 to 4096. Only 64 VSANs for all initiator/mgmt/target are
allowed (meaning, you can have initiator in VSANs 1-30, target in VSANs 31-60, and mgmt in VSANs
61-64). If the target, initiator, and mgmt overlap in VSANs, each overlap is also included in the total
VSAN count.
A mgmt N-port can only exist in 4 of these 64 VSANs.
You can specify a range of interfaces by issuing a command with the following example format:
interface svc 1/1 space , space svc 2/1-2
Cisco MDS 9000 Family Command Reference
2-16
Chapter 2
Caching Services Module Commands
interface svc
This command configures Slot 1 Node 1 as an SVC interface and simultaneously configures Slot 2,
Nodes 1and 2 as SVC interfaces.
Place the disk, host, and other SVC nodes in the appropriate VSAN for any configuration to be
completely established
Examples
The following example configures the initiator N-port on VSAN 1, the target N-port on VSAN 2, and
the management N-port on VSAN 3.
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# interface svc 2/1
switch(config-if)# ?
Interface configuration commands:
do
EXEC command
exit
Exit from this submode
initiator
Configure Initiator traffic for SVC Node
mgmt
Configure traffic for communication with other SVC Nodes
no
Negate a command or set its defaults
nwwn
Configured a non-system allocated nWWN for SVC Node
shutdown
Enable/disable an interface
switchport Configure switchport parameters
target
Configure Target traffic for SVC Node
switch(config-if)# initiator vsan 1
switch(config-if)# target vsan 2
switch(config-if)# mgmt vsan 3
Related Commands
Command
Description
show interface
Displays an interface configuration for a specified interface.
Cisco MDS 9000 Family Command Reference
2-17
Chapter 2
Caching Services Module Commands
iogroup
iogroup
To assign a name to I/O groups, use the iogroup command in the cluster configuration submode. Use the
no form of this command to delete the configured I/O group alias.
cluster config cluster-name
iogroup group-id alias alias-name
Syntax Description
cluster
Provides access to cluster commands
config cluster-name
Places a previously created cluster in the cluster configuration submode.
iogroup group-id
Identifies one of four I/O groups in the specified cluster. The ID ranges from
1 to 4.
alias alias-name
Assigns a name to the selected I/O group. The name is restricted to 15
alphanumeric characters.
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
The no iogroup command deletes the alias name, not the I/O group itself.
The cluster configuration submode prompt is (switch(svc-cluster)#).
Examples
The following example enters the cluster configuration mode for SampleCluster and configures a new
I/O group. The created group is verified using the show cluster name iogroup command
switch(svc)# cluster config SampleCluster
switch(svc-cluster)# iogroup 1 alias SampleIOgroup
switch(svc-cluster)# exit
Related Commands
Command
Description
show cluster name iogroup Displays configured I/O group information for a specified cluster.
Cisco MDS 9000 Family Command Reference
2-18
Chapter 2
Caching Services Module Commands
ip
ip
To modify the IP address for a cluster, use the ip command in the cluster configuration submode.
cluster config cluster-name
ip ip-address
Syntax Description
cluster
Provides access to cluster commands
config cluster-name
Places a previously created cluster in the cluster configuration submodes.
ip ip-address
Specifies the IP address of the cluster.
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
The IP address of the cluster can be changed, but not deleted. If you connect using the current cluster IP
address, that session is lost when the command completes. You must then reconnect using the new IP
address.
The no form of this command is not allowed.
The cluster configuration submode prompt is (switch(svc-cluster)#).
Examples
The following example enters the cluster configuration mode for SampleCluster, configures the IP
address, and verifies by displaying this information
switch(svc)# cluster config SampleCluster
switch(svc-cluster)# ip 209.165.200.226
switch(svc)# show cluster SampleCluster ip
cluster ip address is 209.165.200.226
Related Commands
Command
Description
show cluster name ip
Displays configured -- information for a specified cluster.
Cisco MDS 9000 Family Command Reference
2-19
Chapter 2
Caching Services Module Commands
mdisk-grp
mdisk-grp
To create and configure a mdsik group, use the mdisk-grp command in the cluster configuration
submode.
cluster config cluster-name
mdisk-grp add grp-name extent size
mdisk-grp name grp-name -> mdisk id mdisk-id
Syntax Description
cluster
Provides access to cluster commands
config cluster-name
Places a previously created cluster in the cluster configuration submode.
mdisk-grp add grp-name Adds a mdisk group.
extent size
Assigns the extent size of the storage allocation for MDisks in this cluster.
The extent size can be 16, 32, 64, 128, 256, or 512 MB.
mdisk-grp name
grp-name
Enters the mdisk submode of an existing MDisk group.
mdisk id mdisk-id
Assigns the disk ID ranging from 1 to 4096 to the mdisk in the MDisk
group submode.
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
The cluster configuration submode prompt is (switch(svc-cluster)#).
The submode prompt for the MDisk group is switch (svc-cluster-mdisk-grp)#
Examples
The following example enters the cluster configuration mode for SampleCluster, creates an MDisk
group, and adds an MDisk to the group.
switch(svc)# cluster config SampleCluster
switch(svc-cluster)# mdisk-grp add Mdisk1 extent 512
switch(svc-cluster)# mdisk-grp name Mdisk1
switch(svc-cluster-mdisk-grp)# mdisk id 3
switch(svc)# show cluster SampleCluster mdisk-grp
------------------------------------------------------------------------------name
Capacity
free
extent
number
number
status
Cisco MDS 9000 Family Command Reference
2-20
Chapter 2
Caching Services Module Commands
mdisk-grp
size(MB) of mdisks of vdisks
------------------------------------------------------------------------------finance
7.56 GB
7.56 GB 16
5
0
online
marketing
6.48 GB
6.48 GB 16
5
0
online
Related Commands
Command
Description
show cluster name mdisk
Displays configured MDisk group information for a specified
cluster.
Cisco MDS 9000 Family Command Reference
2-21
Chapter 2
Caching Services Module Commands
migrate vdisk
migrate vdisk
To configure data migration from a VDisk, use the migrate vdisk command in the cluster configuration
submode.
cluster config cluster-name
migrate vdisk vdisk-name new-mdisk-grp grp-name
migrate vdisk vdisk-name src-mdisk id mdisk-id num-extents number tgt-mdisk id mdisk-id
Syntax Description
cluster
Provides access to cluster commands
config cluster-name
Places a previously created cluster in the cluster configuration submode.
migrate vdisk vdisk-name Migrates data from the specified VDisk to a MDisk or MDisk group.
new-mdisk-grp grp-name
Migrates data to a newly specified MDisk group.
src-mdisk id mdisk-id
Specifies the source MDisk for data migration.
num-extents number
Specifies the extents of a VDisk for data migration.
tgt-mdisk id mdisk-id
Specifies the target MDisk for data migration.
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
The cluster configuration submode prompt is (switch(svc-cluster)#).
Examples
The following example enters the cluster configuration mode for SampleCluster, migrates a VDisk to a
new MDisk group.
switch(svc)# cluster config SampleCluster
switch(svc-cluster)# migrate vdisk Vdisk2 new-mdisk-grp Group5
switch(svc-cluster)# migrate vdisk Vdisk2 src-mdisk id 3 num-extents 2 tgt-mdisk id 4
Related Commands
Command
Description
show cluster name status
migrate
Displays configured MDisk migration status information for a
specified cluster.
Cisco MDS 9000 Family Command Reference
2-22
Chapter 2
Caching Services Module Commands
node
node
To add a node to a cluster or to assign a name to a preconfigured node, use the node command in the
cluster configuration submode.
cluster config cluster-name
node name node-name
node nwwn node-wwn
node iogroup group-id [alias alias-name]
Syntax Description
cluster config
Provides access to cluster commands
node
Adds a specified node to the cluster being configured.
name node-name
Specifies the node using a 15 alphanumeric characters.
nwwn node-wwn
Specifies the node using the nWWN with the format
hh:hh:hh:hh:hh:hh:hh:hh.
iogroup group-id
Identifies one of four I/O groups in the specified cluster. The ID ranges from
1 to 4.
alias alias-name
Assigns a name to the selected node. The name is restricted to 156
alphanumeric characters.
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
The cluster configuration submode prompt is (switch(svc-cluster)#).
The node must first be added before assigning an alias name.
The no form of the command deletes the node from the cluster.
Examples
The following example enters the cluster configuration mode for SampleCluster, adds a node by
assigning the nWWN, and associates the node with an alias.
switch(svc)# cluster config SampleCluster
switch(svc-cluster)# node nwwn 20:00:00:04:cf:e6:e4:df iogroup 1
switch(svc-cluster)# node nwwn 20:00:00:04:cf:e6:e4:df alias NodeAlias
Cisco MDS 9000 Family Command Reference
2-23
Chapter 2
Caching Services Module Commands
node
Related Commands
Command
Description
show cluster name nodes
Displays configured node information for a specified cluster.
Cisco MDS 9000 Family Command Reference
2-24
Chapter 2
Caching Services Module Commands
node svc delete
node svc delete
To delete all cluster configurations from a specific node, use the node svc delete command in SVC
configuration mode.
node svc slot-number/node-number delete
Syntax Description
node svc
Specifies the node’s SVC interface
slot-number
Specifies the slot number of the Caching Service Module (CSM).
node-number
Specifies the node number of the SVC instance running on the CSM. This
number ranges from 1 to 2 nodes per module.
delete
Deletes a cluster information from the specified node.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
Use this command if the node has lost communication with a configured cluster.
Examples
The following example enters the SVC configuration mode and adds a cluster called SampleCluster.
switch# svc-config
switch(svc)# node svc 2/1 delete
Related Commands
Command
Description
show nodes local
Displays configured node information.
Cisco MDS 9000 Family Command Reference
2-25
Chapter 2
Caching Services Module Commands
node svc recover
node svc recover
To initiate cluster recovery on a specified SVC node, use the recover cluster command in SVC
configuration mode.
node svc slot-number/node-number recover
Syntax Description
node svc
Specifies the node’s SVC interface
slot-number
Specifies the slot number of the Caching Service Module (CSM).
node-number
Specifies the node number of the SVC instance running on the CSM. This
number ranges from 1 to 2 nodes per module.
recover
Initiates recovery for a specified node.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
Use this command to initiate cluster recovery after a failure. If the output of the show nodes local
command displays recovery pause in the node status column.
Examples
The following example initiates recovery for the SVC node 1 in slot 2.
switch# svc-config
switch(svc)# node svc 2/1 recover
Related Commands
Command
Description
show nodes local
Displays configured node information.
Cisco MDS 9000 Family Command Reference
2-26
Chapter 2
Caching Services Module Commands
node svc servicemode
node svc servicemode
To place a node in service mode, use the servicemode node svc command in SVC configuration mode.
Use the no form of the command to remove a node from service mode.
node svc slot-number/node-number servicemode
Syntax Description
node svc
Specifies the node’s SVC interface
slot-number
Specifies the slot number of the Caching Service Module (CSM).
node-number
Specifies the node number of the SVC instance running on the CSM. This
number ranges from 1 to 2 nodes per module.
servicemode
Places a node in service mode.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following example enters the SVC configuration mode and places the specified node in service
mode.
switch# svc-config
switch(svc)# node svc 2/2 servicemode
Related Commands
Command
Description
show nodes local
Displays configured node information.
Cisco MDS 9000 Family Command Reference
2-27
Chapter 2
Caching Services Module Commands
node svc upgrade
node svc upgrade
To upgrade the software on a specified SVC node, use the upgrade node svc command in SVC
configuration mode.
node svc slot-number/node-number url upgrade svc-system url
Syntax Description
node svc
Specifies the node’s SVC interface
slot-number
Specifies the slot number of the Caching Service Module (CSM).
node-number
Specifies the node number of the SVC instance running on the CSM. This
number ranges from 1 to 2 nodes per module.
upgrade
Upgrades the image on the specified node.
svc-system url
Specifies the SVC image to be used. The new version of the software image
is specified to the FTP:, SCP:, SFTP:, TFTP:, bootflash:, or slot0: directories
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
This command is valid only if the node is in service mode or the node has been shutdown.
Examples
The following example enters the SVC configuration mode and displays all options in this mode.
switch# svc-config
switch(svc)# node svc 2/1 upgrade svc-system ?
bootflash: URI containing the system image for
ftp:
URI containing the system image for
scp:
URI containing the system image for
sftp:
URI containing the system image for
slot0:
URI containing the system image for
tftp:
URI containing the system image for
Cisco MDS 9000 Family Command Reference
2-28
SVC
SVC
SVC
SVC
SVC
SVC
Chapter 2
Caching Services Module Commands
quorum
quorum
To set the quorum disk for a cluster, use the quorum command in the cluster configuration submode.
cluster config cluster-name
quorum disk [1 | 2 | 3] mdisk disk-id
Syntax Description
cluster
Provides access to cluster commands
config cluster-name
Places a previously created cluster in the cluster configuration submode.
quorum disk id
Configures one of three quorum disks for the specified cluster. The quorum
ID ranges from 1 to 3.
mdisk mdisk-id
Specifies the MDisk ID (ranges form 1 to 4096).
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
The cluster configuration submode prompt is (switch(svc-cluster)#).
You can assign one of 3 possible quorum IDs in any desired order.
Examples
The following example enters the cluster configuration mode for SampleCluster and sets the quorum
disk ID.
switch(svc)# cluster config SampleCluster
switch(svc-cluster)# quorum disk 2 mdisk 1
Cisco MDS 9000 Family Command Reference
2-29
Chapter 2
Caching Services Module Commands
remote-copy
remote-copy
To create a synchronous copy of a specified VDisk or group of VDisks, use the remote-copy command
in the cluster configuration submode.
cluster config cluster-name
remote-copy add rcopy-name [cluster rcluster-name]
remote-copy rcopy-name
map src-vdisk vdisk-name aux-vdisk vdisk-name
Syntax Description
cluster
Provides access to cluster commands
config cluster-name
Places a previously created cluster in the cluster configuration submode.
remote-copy add
rcopy-name
Creates a remote copy instance and assigns a name.
remote-copy cluster
rcluster-name
Specifies the remote cluster name for the consistency group.
remote-copy rcopy-name
Enters the remote-copy submode for an existing copy object.
map
Establishes a relationship between the source and destination VDisks.
src-vdisk vdisk-name
Specifies the source VDisk for the copy creation.
aux-vdisk vdisk-name
Specifies a VDisk in the remote copy cluster.
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
The cluster configuration submode prompt is (switch(svc-cluster)#).
The remote-copy submode prompt is switch(svc-cluster-remote-copy)#
Examples
The following example enters the cluster configuration mode for SampleCluster and creates a
synchronous copy of a specified disk.
switch(svc)# cluster config SampleCluster
switch(svc-cluster)# remote-copy add Rcopy1
switch(svc-cluster)# remote-copy r1
switch(svc-cluster-remote-copy)# ?
Submode Commands:
exit Exit from this mode
Cisco MDS 9000 Family Command Reference
2-30
Chapter 2
Caching Services Module Commands
remote-copy
map
no
Remote-copy map
Negate a command or set its defaults
switch(svc-cluster-remote-copy)# map src-vdisk SrcVdisk1 aux-vdisk AuxVdisk1
switch(svc-cluster)# remote-copy add Rcopy1 cluster remote-cluster
switch(svc-cluster)# remote-copy name Rcopy1
Related Commands
Command
Description
show cluster name remote-copy Displays configured remote-copy information for a specified
cluster.
Cisco MDS 9000 Family Command Reference
2-31
Chapter 2
Caching Services Module Commands
show cluster flash-copy
show cluster flash-copy
To display configured FlashCopy information for a specified cluster, use the show cluster cluster-name
flash-copy command.
show cluster cluster-name flash-copy [fcopy-name]
Syntax Description
show cluster cluster-name
Specifies a previously created cluster name.
flash-copy fcopy-name
Displays FlashCopy relationships configured for the specified
FlashCopy object.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following examples display configured cluster information.
switch(svc)# show cluster SampleCluster flash-copy
------------------------------------------------------------------------------name
status
------------------------------------------------------------------------------fccstgrp0
idle_or_copied
f2
idle_or_copied
switch(svc)# show cluster SampleCluster flash-copy f2
Flash-copy mapping 1:
src vdisk is v2
dest vdisk is v3
state is idle_or_copied
copy rate is 50
progress 0% done
Cisco MDS 9000 Family Command Reference
2-32
Chapter 2
Caching Services Module Commands
show cluster host
show cluster host
To display configured host information for a specific cluster, use the show cluster cluster-name host
command.
show cluster cluster-name host [host-name | candidate]
Syntax Description
show cluster cluster-name
Specifies a previously created cluster name.
host
Displays information about hosts and host ports.
candidate
Lists all candidates that are not part of this entity but are visible to the
cluster.
host-name
Displays information about the specified host.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following examples display configured cluster host information.
switch(svc)# show SampleCluster host
------------------------------------------------------------------------------name
number of ports
------------------------------------------------------------------------------oasis15
1
Host1
2
switch(svc)# show SampleCluster host Host1
host Host1:
Number of port is 2
Port WWN is 11:22:33:44:aa:bb:cc:dd
Port WWN is 22:11:33:55:11:aa:bb:cc
LUN 0: vdisk V1
LUN 10: vdisk V2
switch(svc)# show cluster SampleCluster host candidate
------------------------------------------------------------------------------id
pwwn
------------------------------------------------------------------------------1
21:00:00:e0:8b:09:e7:04
Cisco MDS 9000 Family Command Reference
2-33
Chapter 2
Caching Services Module Commands
show cluster iogroup
show cluster iogroup
To display configured I/O group information for a specified cluster, use the show cluster cluster-name
iogroup command.
show cluster cluster-name iogroup [group-id]
Syntax Description
show cluster cluster-name
Specifies a previously created cluster name.
iogroup
Identifies one of four I/O groups in the specified cluster.
group-id
Specifies the iogroup ID (ranges from 1 to 4).
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following examples display configured cluster iogroup information.
switch(svc)# show SampleCluster iogroup
----------------------------------------------------------------------------ID
NAME
NODE-COUNT
VLUN_COUNT
----------------------------------------------------------------------------1
Sampleio1
2
3
2
io_grp1
0
0
3
io_grp2
0
0
4
io_grp3
0
0
5
recovery_io_grp
0
0
Note
Only four IDs can be used, the fifth I/O group is internally created and is only used for cluster recovery.
switch(svc)# show SampleCluster iogroup id 2
Io group id 2:
Node count is 0
Host LUN count is 0
Contains no nodes
Cisco MDS 9000 Family Command Reference
2-34
Chapter 2
Caching Services Module Commands
show cluster ip
show cluster ip
To displays configured ip information for a specified cluster, use the show cluster-name ip command.
show cluster cluster-name ip
Syntax Description
show cluster cluster-name
Specifies a previously created cluster name.
ip
Displays the IP address of the specified cluster.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following example displays configured cluster ip information.
switch(svc)# show SampleCluster ip
cluster ip address is 209.165.200.226
Cisco MDS 9000 Family Command Reference
2-35
Chapter 2
Caching Services Module Commands
show cluster mdisk
show cluster mdisk
To display configured MDisk information for a specified cluster, use the show cluster cluster-name
mdisk command.
show cluster cluster-name mdisk {candidate | id mdisk-id [extent]}
Syntax Description
show cluster cluster-name
Specifies a previously created cluster name.
mdisk
Displays MDisk specific information.
candidate
Displays all MDisks that are not assigned to a group.
id mdisk-id
Displays details of the specified MDisk ID.
extent
Displays information about the specified MDisk’s extent.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following examples display configured cluster MDisk information.
switch(svc)# show SampleCluster mdisk
------------------------------------------------------------------------------id
nwwn
mdisk-grp
capacity
status
------------------------------------------------------------------------------1
20:00:00:04:cf:e6:1b:5b mg1
68.37 GB
online
2
20:00:00:04:cf:e6:e5:32 mg1
68.37 GB
online
3
20:00:00:04:cf:e6:21:a2 mg1
68.37 GB
online
4
20:00:00:04:cf:e6:e1:81 mg1
68.37 GB
online
5
20:00:00:04:cf:e6:e4:df
68.37 GB
online
6
20:00:00:04:cf:e6:1c:fb
68.37 GB
online
7
20:00:00:04:cf:e6:1a:4c
68.37 GB
online
8
20:00:00:04:cf:e6:e4:6b
68.37 GB
online
switch(svc)# show SampleCluster mdisk candidate
------------------------------------------------------------------------------id
nwwn
capacity
------------------------------------------------------------------------------5
20:00:00:04:cf:e6:e4:df 68.37 GB
6
20:00:00:04:cf:e6:1c:fb 68.37 GB
7
20:00:00:04:cf:e6:1a:4c 68.37 GB
8
20:00:00:04:cf:e6:e4:6b 68.37 GB
switch(svc)# show cluster SampleCluster mdisk id 1
mdisk id 1 is online
Cisco MDS 9000 Family Command Reference
2-36
Chapter 2
Caching Services Module Commands
show cluster mdisk
Is member of mdisk-grp mg1
Controller node WWN is 20:00:00:04:cf:e6:e4:6b
Controller port WWN is 22:00:00:04:cf:e6:e4:6b, LUN 00:00:00:00:00:00:00:00
Controller serial number is 3HZ0KZ8W
Capacity is 68.37 GB
Number of free extents is 2231
switch(svc)# show cluster SampleCluster mdisk id 1 extent
------------------------------------------------------------------------------vdisk
number of extents
------------------------------------------------------------------------------v1
2144
Cisco MDS 9000 Family Command Reference
2-37
Chapter 2
Caching Services Module Commands
show cluster mdsik-grp
show cluster mdsik-grp
To display configured MDisk group information for a specified cluster, use the show cluster
cluster-name mdisk-grp command.
show cluster cluster-name mdisk-grp [grp-name]
Syntax Description
show cluster cluster-name
Specifies a previously created cluster name.
mdisk-grp grp-name
Displays information about a specified MDisk group.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following examples display configured cluster information for a MDisk group.
switch(svc)# show cluster SampleCluster mdisk-grp
-------------------------------------------------------------------------------------name
Capacity
free
extent
number
number
status
size(MB)
of mdisks of vdisks
-------------------------------------------------------------------------------------mg1
410.16 GB
309.16 GB 16
6
1
online
switch(svc)# show cluster SampleCluster mdisk-grp mg1
mdisk-grp mg1 is online
Total capacity is 410.16 GB
Free capacity is 309.16 GB
Extent size is 16 MB
Number of mdisks is 6
Number of vdisks using this group is 1
Cisco MDS 9000 Family Command Reference
2-38
Chapter 2
Caching Services Module Commands
show cluster nodes
show cluster nodes
To display configured node information for a specified cluster, use the show cluster cluster-name nodes
command.
show cluster cluster-name nodes [candidate]
Syntax Description
show cluster cluster-name
Specifies a previously created cluster name.
nodes
Displays information about nodes in this cluster.
candidate
Lists all candidates that are not part of this entity but are visible to the
cluster.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following example displays configured cluster information for a specified node.
switch(svc)# show cluster SampleCluster nodes
Node node1 is online(3)
Node WWN is 20:06:00:0b:be:57:73:42
Serial number is JAB072705JH
Unique id is 01:00:07:27:30:35:4a:48
Node is in config mode
Node is part of iogroup id 1 name io_grp0
Node node2 is online(3)
Node WWN is 20:08:00:0b:be:57:73:42
Serial number is JAB076605JH
Unique id is 01:00:07:66:30:35:4a:48
Node is in non config mode
Node is part of iogroup id 1 name io_grp0
switch1(svc)# show cluster SampleCluster nodes candidate
----------------------------------------------------------------------------NODE
NWWN
----------------------------------------------------------------------------switch1.2.1
20:06:00:05:30:00:8d:e0
Cisco MDS 9000 Family Command Reference
2-39
Chapter 2
Caching Services Module Commands
show cluster remote-copy
show cluster remote-copy
To display configured remote-copy information for a specified cluster, use the show cluster
cluster-name remote-copy command.
show cluster cluster-name remote-copy [rcopy-name]
Syntax Description
show cluster cluster-name
Specifies a previously created cluster name.
remote-copy
Displays remote copy relationships configured for a specified cluster.
rcopy-name
Displays the specified remote copy object.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following example displays configured cluster information for the specified copy instance.
switch(svc)# show cluster SampleCluster remote-copy r1
Remote-copy mapping 1:
master cluster is SampleCluster
master vdisk is v6
aux cluster is c1
aux vdisk is v7
status is inconsistent_stopped
progress 0% done
Remote-copy mapping 2:
master cluster is SampleCluster
master vdisk is v8
aux cluster is c1
aux vdisk is v9
status is inconsistent_stopped
progress 0% done
Cisco MDS 9000 Family Command Reference
2-40
Chapter 2
Caching Services Module Commands
show cluster remote-copy-cluster
show cluster remote-copy-cluster
To display configured remote-copy partnership information for a specified cluster, use the show cluster
cluster-name remote-copy-cluster command.
show cluster cluster-name remote-copy-cluster [rcopy-name]
Syntax Description
show cluster cluster-name Specifies a previously created cluster name.
remote-copy-cluster
Displays remote copy relationships configured for a specified cluster.
rcopy-name
Displays the specified remote copy object.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following example displays configured cluster information for the specified copy instance.
switch(svc)# show cluster SampleCluster remote-copy-cluster
----------------------------------------------Cluster
Local/remote
Bandwidth
----------------------------------------------local-cluster
local
10
remote-cluster
remote
50
Cisco MDS 9000 Family Command Reference
2-41
Chapter 2
Caching Services Module Commands
show cluster status
show cluster status
To displays progress information for a specified cluster, use the show cluster cluster-name status
command.
show cluster cluster-name status [flash-copy fcopy-name | remote-copy rcopy-name]
Syntax Description
show cluster cluster-name
Specifies a previously created cluster name.
status
Displays the status of a upgrade or copy process.
flash-copy
Displays FlashCopy relationships configured for the specified cluster.
fcopy-name
Displays the specified FlashCopy object.
remote-copy
Displays remote copy relationships configured for a specified cluster.
rcopy-name
Displays the specified remote copy object.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following examples display configured cluster information.
switch(svc)# show cluster SampleCluster status flash-copy fc1
------------------------------------------------------------------------------src vdisk
dest vdisk
progress
------------------------------------------------------------------------------v1
v2
100% done
v3
v4
100% done
switch(svc)# show cluster SampleCluster status remote-copy rc1
------------------------------------------------------------------------------src vdisk
aux vdisk
progress
------------------------------------------------------------------------------v5
v6
100% done
v7
v8
100% done
Cisco MDS 9000 Family Command Reference
2-42
Chapter 2
Caching Services Module Commands
show cluster vdisk
show cluster vdisk
To display configured VDisk information for a specified cluster, use the show cluster cluster-name
vdisk command.
show cluster cluster-name vdisk {vdisk-id [extent | mapped_hosts]}
Syntax Description
show cluster cluster-name
Specifies a previously created cluster name.
vdisk
Displays configured VDisks in the cluster
vdisk-id
Displays details of the specified VDisk ID.
extent
Displays information about the specified MDisk’s extent.
mapped_hosts
Displays information about which hosts are mapped to the specified
VDisk.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following examples display configured cluster information for VDisks.
switch(svc)# show cluster SampleCluster vdisk v1 extent
------------------------------------------------------------------------------mdisk id number of extents
------------------------------------------------------------------------------1
2144
2
2144
3
2144
5
11
6
11
7
10
switch(svc)# show cluster SampleCluster vdisk v1 mapped_hosts
------------------------------------------------------------------------------host
LUN
------------------------------------------------------------------------------oasis15
0
Cisco MDS 9000 Family Command Reference
2-43
Chapter 2
Caching Services Module Commands
show environment battery
show environment battery
To display status of a battery module for the Caching Services Module (CSM), use the show
environment battery command.
show environment battery module slot-number [detail]
Syntax Description
show environment
Displays the hardware environment in any Cisco MDS 9000 Family switch.
battery
Displays the status of the battery in a CSM.
module slot-number
Specifies the slot number of the CSM.
detail
Provides detailed information about the CSM battery status.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was modified in Release 1.3(1).
Usage Guidelines
None.
Examples
The following example displays the current contents of the boot variable.
switch# show environment battery module 2
Battery 1:
---------Voltage
: 10.343 V
Current
: 0.000 A
Temperature
: 23.7 C
Current Capacity
: 1571 mAHr
Full Capacity
: 2057 mAHr
CySampleClustere Count
: 3
Last conditioned in : Week 22 2003
Serial Num
: AMB0722009C
Battery 2:
---------Voltage
: 10.596 V
Current
: 0.000 A
Temperature
: 26.6 C
Current Capacity
: 1701 mAHr
Full Capacity
: 2032 mAHr
CySampleClustere Count
: 6
Last conditioned in : Week 22 2003
Serial Num
: AMB0722009R
switch## show environment battery module 2 detail
Battery 1:
Cisco MDS 9000 Family Command Reference
2-44
Chapter 2
Caching Services Module Commands
show environment battery
---------Voltage
: 10.338 V
Current
: 0.000 A
Temperature
: 23.7 C
Current Capacity
: 1571 mAHr
Full Capacity
: 2057 mAHr
Caching Capacity
: 6463 MB
CySampleClustere Count
: 3
Last conditioned in : Week 22 2003
Serial Num
: AMB0722009C
EEPROM version
: 1
Manufacturer Access
Remaining Capacity Alarm
Remaining Time Alarm
Battery Mode
AtRate
AtRate Time To Full
AtRate Time To Empty
AtRate OK
Temperature
Voltage
Current
Average Current
Max Error
Relative State of Charge
Absolute State of Charge
Remaining Capacity
Full Charge Capacity
Run Time To Empty
Average Time To Empty
Average Time To Full
Charging Current
Charging Voltage
Battery Status
CySampleClustere Count
Design Capacity
Design Voltage
Specification Info
Manufacture Date
Serial Number
Manufacturer Name
Device Name
Device Chemistry
Manufacturer Data
Pack Status & Configuration
VCELL4
VCELL3
VCELL2
VCELL1
...
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
0x0
0xc8
0xa
0x6000
0x0
0xffff
0xffff
0x1
0xb97
0x2862
0xd
0x6
0x2
0x4c
0x4f
0x623
0x809
0xffff
0xffff
0x13f2
0x44c
0x3840
0xc0
:
:
:
:
:
:
:
:
:
:
:
:
:
:
0x7d0
0x2580
0x21
0x3037
0x0
0x430a
0x4207
0x4e04
0x7507
0x2020
0x0
0x0
0x0
0x0
: 0x3
Cisco MDS 9000 Family Command Reference
2-45
Chapter 2
Caching Services Module Commands
show interface svc
show interface svc
You can check the status of a SVC interface at any time by using the show interface svc command.
show interface svc slot-number/node-number [brief | counters | description]
Syntax Description
interface range
Displays the interfaces in the specified range.
brief
Displays brief info of interface.
counters
Displays the interface counter information.
description
Displays a description of interface.
svc
Displays the SAN Volume Controller (SVC) interface.
slot-number
Specifies the slot number of the Caching Service Module (CSM).
node-number
Specifies the node number of the SVC instance running on the CSM.
This number ranges from 1 to 2 nodes per module.
Defaults
None
Command Modes
EXEC
Command History
This command was modified in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following examples display configured SVC interface information.
switch# show interface svc 2/1
svc2/1 is up
Node WWN is 10:00:00:00:00:00:00:00
Fabric WWN is 20:41:00:05:30:00:33:1e
Target N-port WWN is 27:39:00:05:30:00:33:2a, vsan is 1, FCID is 0x010006
Initiator N-port WWN is 27:3a:00:05:30:00:33:2a, vsan is 1, FCID is 0x010007
Mgmt N-port WWN is 27:3b:00:05:30:00:33:2a, vsan is 1, FCID is 0x010008
5 minutes input rate 16 bits/sec, 2 bytes/sec, 0 frames/sec
5 minutes output rate 0 bits/sec, 0 bytes/sec, 0 frames/sec
7 frames input, 736 bytes
0 discards, 0 errors
3 frames output, 276 bytes
0 discards, 0 errors
switch# show interface svc 8/1-2
svc8/1 is down (Administratively down)
Node WWN is 23:34:00:05:30:00:00:02
Fabric WWN is 21:c1:00:05:30:00:00:00
Target N-port WWN is 23:2e:00:05:30:00:00:02, vsan is 1, FCID is 0x000000
Initiator N-port WWN is 23:2f:00:05:30:00:00:02, vsan is 1, FCID is 0x000000
Mgmt N-port WWN is 23:30:00:05:30:00:00:02, vsan is 1, FCID is 0x000000
Cisco MDS 9000 Family Command Reference
2-46
Chapter 2
Caching Services Module Commands
show interface svc
5 minutes input rate 0 bits/sec, 0 bytes/sec, 0 frames/sec
5 minutes output rate 0 bits/sec, 0 bytes/sec, 0 frames/sec
0 frames input, 0 bytes
0 discards, 0 errors
0 frames output, 0 bytes
0 discards, 0 errors
svc8/2 is up
Node WWN is 23:35:00:05:30:00:00:02
Fabric WWN is 21:c2:00:05:30:00:00:00
Target N-port WWN is 23:31:00:05:30:00:00:02, vsan is 1, FCID is 0x650003
Initiator N-port WWN is 23:32:00:05:30:00:00:02, vsan is 1, FCID is 0x650004
Mgmt N-port WWN is 23:33:00:05:30:00:00:02, vsan is 1, FCID is 0x650005
5 minutes input rate 0 bits/sec, 0 bytes/sec, 0 frames/sec
5 minutes output rate 0 bits/sec, 0 bytes/sec, 0 frames/sec
3268061 frames input, 6602103068 bytes
0 discards, 2 errors
3208131 frames output, 6598470800 bytes
0 discards, 0 errors
switch# show interface brief
------------------------------------------------------------------------------Interface Vsan
Admin Admin
Status
FCOT
Oper Oper
Port
Mode
Trunk
Mode Speed Channel
Mode
(Gbps)
------------------------------------------------------------------------------fc8/1
1
FX
-fcotAbsent
---...
fc8/32
1
FX
-fcotAbsent
---------------------------------------------------------------------------------Interface
Status
Speed
(Gbps)
------------------------------------------------------------------------------sup-fc0
up
1
------------------------------------------------------------------------------Interface
Status
IP Address
Speed
MTU
------------------------------------------------------------------------------mgmt0
up
172.22.90.21/24
100 Mbps
1500
------------------------------------------------------------------------------Interface
Status
------------------------------------------------------------------------------svc2/1
down
svc2/2
up
svc4/1
up
svc4/2
up
switch# show interface svc 2/1 counters
svc2/1
5 minutes input rate 0 bits/sec, 0 bytes/sec, 0 frames/sec 0 ios/sec
5 minutes output rate 0 bits/sec, 0 bytes/sec, 0 frames/sec 0 ios/sec
272 frames input, 89764 bytes
39 input session management frames
19 plogi, 1 plogi_acc, 13 prli, 1 prli_acc
2 logo, 0 logo_acc, 0 prlo, 0 prlo_acc
3 abts, 0 ba_acc, 0 ls_rjt
28 input I/Os, 28 cmd complete, 0 cmd fail
24 reads, 4 writes
0 input errors
0 input discards
FCP cmd errors
0 sess not up, 0 no resources, 0 bad frames
0 up layer rjt, 0 out of order, 0 proc unexp exch st
0 drop unexp exch st, 0 no exch match
FCP Xrdy errors
Cisco MDS 9000 Family Command Reference
2-47
Chapter 2
Caching Services Module Commands
show interface svc
0 sess not up, 0 no resources, 0 bad frames
0 up layer rjt, 0 out of order, 0 proc unexp exch st
0 drop unexp exch st, 0 no exch match
FCP status errors
0 sess not up, 0 no resources, 0 bad frames
0 up layer rjt, 0 out of order, 0 proc unexp exch st
0 drop unexp exch st, 0 no exch match
FCP Data errors
0 sess not up, 0 no resources, 0 bad frames
0 up layer rjt, 0 out of order, 0 proc unexp exch st
0 drop unexp exch st, 0 no exch match
0 Incoming Aborts
232 frames output, 84176 bytes
35 output session management frames
6 plogi, 13 plogi_acc, 1 prli, 12 prli_acc
0 logo, 0 logo_acc, 0 prlo, 0 prlo_acc
1 abts, 2 ba_acc, 0 ls_rjt
103 out I/Os, 103 cmd complete, 0 cmd fail
63 reads, 4 writes
0 output errors
0 output discards
0 out ls aborts
LS requests while sess not up
0 cmds 0 data xfers 0 status xfers 0 ds xfers
switch# show interface svc 4/2 description
------------------------------------------------------------------------------Interface
Description
------------------------------------------------------------------------------svc4/2
SampleInt1
Cisco MDS 9000 Family Command Reference
2-48
Chapter 2
Caching Services Module Commands
show nodes
show nodes
To displays configured information for the CSM, use the show svc command.
show nodes {local [detail] | svc slot_number/node-number | version}
Syntax Description
show nodes
Displays information about the specified nodes.
local
Displays SVC nodes in the switch.
detail
Displays detailed node information.
svc
Displays node information specific to the SVC interface.
slot-number
Specifies the slot number of the Caching Service Module (CSM).
node-number
Specifies the node number of the SVC instance running on the CSM. This
number ranges from 1 to 2 nodes per module.
version
Displays software version information for each node.
Defaults
None.
Command Modes
SVC configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following example display configured SVC information and statistics.
switch(svc)# show nodes local detail
svc2/1:
Is a config node for cluster SampleCluster
cluster Status is active
Node Status is active
svc2/2:
Is member of cluster SampleCluster
cluster Status is active
Node Status is active
switch(svc)# show nodes ?
local
Show nodes in the switch
svc
SVC Interface
version Show node sw versions in the switch
<cr>
Carriage Return
switch(svc)# show nodes svc 2/2
svc2/2:
Is not a member of any cluster
Cluster Status is unconfigured
Cisco MDS 9000 Family Command Reference
2-49
Chapter 2
show nodes
Node Status is free
switch(svc)# show nodes version
-----------------------------------------------------Node
sw version
state
-----------------------------------------------------svc2/1
1.3(1)
Runtime code
(5)
svc2/2
1.3(1)
Runtime code
(5)
Related Commands
Command
Description
svc config
Configures SVC nodes.
Cisco MDS 9000 Family Command Reference
2-50
Caching Services Module Commands
Chapter 2
Caching Services Module Commands
show svc
show svc
To displays configured information for the CSM, use the show svc command.
show svc
port svc slot_number/node-number [detail | initiator | mgmt | target [detail | vsan vsan-id]] |
session [detail | initiator | mgmt | peer-wwn pwwn-id | target [detail | vsan vsan-id]] |
stats xipc [interface svc slot_number/node-number] | [module slot-number]
Syntax Description
show svc
Displays configured SVC information.
port
Displays N-port specific SVC information.
svc
Specifies the new interface to be a SVC interface.
slot-number
Specifies the slot number of the Caching Service Module (CSM).
node-number
Specifies the node number of the SVC instance running on the CSM. This
number ranges from 1 to 2 nodes per module.
detail
Displays detailed information for all N ports
initiator
Displays a SVC node as an initiator in the specified VSAN.
mgmt
Displays a SVC node as a management node in the specified VSAN.
target
Displays a SVC node as a target in the specified VSAN.
vsan vsan-id
Specifies the VSAN ID ranging from 1 to 4093.
session
Displays information specific to the SVC session.
peer-pwwn pwwn-id
Specifies the port WWN of the target or host, with the format
hh:hh:hh:hh:hh:hh:hh:hh.
stats
Displays SVC statistical information generally used for debugging.
module slot-number
Specifies the slot number containing the CSM.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following examples display configured SVC information and statistics.
switch# show svc session svc 2/1
svc2/1:
Target N-port WWN is 21:00:00:05:30:00:8d:e0, vsan is 2, FCID is 0x610100
pWWN 21:00:00:e0:8b:09:f0:04, nWWN 20:00:00:e0:8b:09:f0:04, FCID 0x610000
Initiator N-port WWN is 20:01:00:05:30:00:8d:e0, vsan is 1, FCID is 0xec0100
Cisco MDS 9000 Family Command Reference
2-51
Chapter 2
Caching Services Module Commands
show svc
pWWN 22:00:00:04:cf:e6:e4:6b, nWWN 20:00:00:04:cf:e6:e4:6b, FCID 0xec00d4
pWWN 22:00:00:04:cf:e6:1a:4c, nWWN 20:00:00:04:cf:e6:1a:4c, FCID 0xec00d5
pWWN 22:00:00:04:cf:e6:1c:fb, nWWN 20:00:00:04:cf:e6:1c:fb, FCID 0xec00d6
pWWN 22:00:00:04:cf:e6:e1:81, nWWN 20:00:00:04:cf:e6:e1:81, FCID 0xec00d9
pWWN 22:00:00:04:cf:e6:e4:df, nWWN 20:00:00:04:cf:e6:e4:df, FCID 0xec00da
pWWN 22:00:00:04:cf:e6:21:a2, nWWN 20:00:00:04:cf:e6:21:a2, FCID 0xec00dc
pWWN 22:00:00:04:cf:e6:e5:32, nWWN 20:00:00:04:cf:e6:e5:32, FCID 0xec00e0
pWWN 22:00:00:04:cf:e6:1b:5b, nWWN 20:00:00:04:cf:e6:1b:5b, FCID 0xec00e1
Mgmt N-port WWN is 21:02:00:05:30:00:8d:e0, vsan is 3, FCID is 0x7a0000
pWWN 21:03:00:05:30:00:8d:e0, nWWN 20:07:00:05:30:00:8d:e0, FCID 0x7a0001
switch# show svc session svc 2/1 peer-pwwn 22:00:00:04:cf:e6:e4:6b detail
svc2/1:
Initiator N-port WWN is 20:01:00:05:30:00:8d:e0, vsan is 1, FCID is 0xec0102
pWWN 22:00:00:04:cf:e6:e4:6b, nWWN 20:00:00:04:cf:e6:e4:6b, FCID 0xec00d4
47 frames input, 920 data bytes
2 ELS pkts, 0 BLS pkts
0 FCP commands, 0 FCP xfer ready
20 FCP data frames, 25 FCP status
0 FCP overrun, 15 FCP underrun
0 aborts, 0 bad FC2 drops
0 data excess
27 frames output, 0 data bytes
2 ELS pkts, 0 BLS pkts
25 FCP commands, 0 FCP xfer ready
0 FCP data frames, 0 FCP status
0 aborts
0 open exchanges
switch# show svc port svc 2/1
svc2/1:
Target N-port in vsan 2 is up
Port WWN is 21:00:00:05:30:00:8d:e0, FCID is 0x610101
Initiator N-port in vsan 1 is up
Port WWN is 20:01:00:05:30:00:8d:e0, FCID is 0xec0102
Mgmt N-port in vsan 1 is up
Port WWN is 20:02:00:05:30:00:8d:e0, FCID is 0xec0103
switch# show svc port svc 2/1 target detail
svc2/1:
Target N-port in vsan 1 is up
Port WWN is 27:39:00:05:30:00:33:2a, FCID is 0x010006
0 sessions, 0 closed, 0 in transition
5 minutes input rate 0 bits/sec, 0 bytes/sec, 0 frames/sec 0 ios/sec
5 minutes output rate 0 bits/sec, 0 bytes/sec, 0 frames/sec 0 ios/sec
9 frames input, 1064 bytes
0 input session management frames
0 plogi, 0 prli
0 logo, 0 logo_acc
0 prlo, 0 prlo_acc
0 abts, 0 ls_rjt
0 input I/Os, 0 cmd complete, 0 cmd fail
0 reads, 0 writes
0 input errors
0 input discards
5 frames output, 388 bytes
0 output session management frames
0 plogi_acc, 0 prli_acc
0 logo, 0 logo_acc
0 prlo, 0 prlo_acc
0 ba_acc, 0 ls_rjt
0 output I/Os, 0 cmd complete, 0 cmd fail
0 output errors
0 output discards
Cisco MDS 9000 Family Command Reference
2-52
Chapter 2
Caching Services Module Commands
show svc
switch# show svc session svc 2/1 peer-pwwn 27:46:00:05:30:00:33:2a detail
svc2/1:
Mgmt N-port WWN is 27:3b:00:05:30:00:33:2a, vsan is 1, FCID is 0x010008
pWWN 27:46:00:05:30:00:33:2a, nWWN 27:48:00:05:30:00:33:2a, FCID 0x010011
19 frames input, 16517 data bytes
2 ELS pkts, 0 BLS pkts
3 FCP commands, 1 FCP xfer ready
10 FCP data frames, 3 FCP status
0 FCP overrun, 2 FCP underrun
0 aborts, 0 bad FC2 drops
0 data excess
19 frames output, 16520 data bytes
2 ELS pkts, 0 BLS pkts
3 FCP commands, 1 FCP xfer ready
10 FCP data frames, 3 FCP status
0 aborts
0 open exchanges
FCP Error Stats
FCP cmd errors
0 sess not up, 0 no resources, 0 bad frames
0 up layer rjt, 0 out of order, 0 proc unexp exch st
0 drop unexp exch st, 0 no exch match
FCP Xfer Rdy errors
0 sess not up, 0 no resources, 0 bad frames
0 up layer rjt, 0 out of order, 0 proc unexp exch st
0 drop unexp exch st, 0 no exch match
FCP Status errors
0 sess not up, 0 no resources, 0 bad frames
0 up layer rjt, 0 out of order, 0 proc unexp exch st
0 drop unexp exch st, 0 no exch match
FCP Data errors
0 sess not up, 0 no resources, 0 bad frames
0 up layer rjt, 0 out of order, 0 proc unexp exch st
0 drop unexp exch st, 0 no exch match
Cisco MDS 9000 Family Command Reference
2-53
Chapter 2
Caching Services Module Commands
svc-config
svc-config
To perform SAN Volume Controller (SVC) configurations, use the svc-config command.
svc-config
Syntax Description
svc-config
Enters the SVC configuration mode.
cluster
Provides access to cluster commands.
node
Provides access to node commands.
show
Displays configured SVC information for the specified node.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
None.
Examples
The following example enters the SVC configuration mode and displays all options in this mode.
switch# svc-config
switch-sw6(svc)# ?
Submode Commands:
cluster Cluster commands
exit
Exit from this mode
no
Negate a command or set its defaults
node
Node commands
show
Show
Cisco MDS 9000 Family Command Reference
2-54
Chapter 2
Caching Services Module Commands
svc-ibmcli
svc-ibmcli
To perform SAN Volume Controller (SVC) configurations by using IBM’s CLI, use the svc-ibmcli
command.
svc-ibmcli {cluster-name cluster-name [IBM-CLI-command] | node svc slot-number/node-number
[IBM-CLI-command]}
Syntax Description
svc-ibmcli
Enters the IBM CLI configuration mode.
cluster-name
Specifies a new cluster.
cluster-name
Specifies a cluster name.
node svc
Specifies a node in the SVC interface.
slot-number
Specifies the slot number of the Caching Service Module (CSM).
node-number
Specifies the node number of the SVC instance running on the CSM. This
number ranges from 1 to 2 nodes per module.
IBM-CLI-command
Specifies the IBM TotalStorage command to be executed
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
When you enter the IBM TotalStorage shell, all future commands are interpreted directly by this shell.
Type exit to return to the Cisco MDS switch prompt.
Examples
The following example enters the SVC configuration mode and displays all options in this mode.
switch# svc-ibmcli cluster-name SampleCluster
Attaching to config node for cluster SampleCluster
To exit type 'exit', to abort type '$.'
IBM_svc:admin>
switch# svc-ibmcli node svc 2/1
Attaching to node 2/1
To exit type 'exit', to abort type '$.'
IBM_svc:admin>
Cisco MDS 9000 Family Command Reference
2-55
Chapter 2
Caching Services Module Commands
svc-purge-wwn module
svc-purge-wwn module
To remove all configured WWNs for the CSM from the running configuration, use the svc-purge-wwn
module command.
svc-purge-wwn module module-number
Syntax Description
svc-purge-wwn
Purges the WWN for the CSM.
module module-number Specifies the slot number for the CSM.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
This command also purges all system allocated pWWNs and nWWNs from the system and will never be
used again (by the system or by SVC interfaces). New system values will be allocated for all
pWWN/nWWNs for the module.
Examples
The following example enters the SVC configuration mode and displays all options in this mode.
switch# svc purge-wwn module 2
!!!WARNING! This command will purge all SVC system allocated
WWNs for the specified module. These WWNs will be lost.
All user configured WWNs will be removed from the
running-config, but not from the startup-config.
This operation can take a long time. Other CLI commands
on the system may be stopped while this operation is
in progress.
Are you sure you want to do this? [Y/N] [N] y
switch#
Cisco MDS 9000 Family Command Reference
2-56
Chapter 2
Caching Services Module Commands
vdisk
vdisk
To create a new VDisk or access a new VDisk, use the vdisk command in the cluster configuration
submode.
cluster config cluster-name
vdisk add vdisk-name iogroup group-id mdisk-grp grp-name capacity number | import [clean |
mdisk-list | preferred-node | sequential]
vdisk name vdisk-name -> expand [capacity | extent mdisk disk-id offset number] | io-throttle
number [MB] | iogroup | shrink
Syntax Description
cluster
Provides access to cluster commands
config cluster-name
Places a previously created cluster in the cluster configuration submode.
vdisk add vdisk-name
Creates a VDisk of the specified name.
iogroup group-id
Identifies one of four I/O groups in the specified cluster. The ID ranges from
1 to 4. The I/O for the VDisk is serviced by node belonging to that I/O group.
mdisk-grp grp-name
Specifies an existing MDisk group from which the VDisk storage originates.
capacity
Configures the size of this VDisk.
number
Provides a range from 0- 1677215 Gigabytes.
import
Imports a previously unmanaged disk that contains SVC virtualization data.
clean
Clears all data in the VDisk.
mdisk-list
Specifies a list of MDisks. All disks in this list must be part of the MDisk
group
preferred-node
specifies the preferred node within the two nodes in this group to send I/Os
for this VDisk
sequential
Specifies a sequential virtualization policy. If this option is not specified, the
striped (default) virtualization policy is used.
vdisk vdisk-name
Enters the VDisk submode of an existing VDisk.
expand capacity
Expands the MDisk capacity.
extent
Expands the MDisk by a single extent.
offset number
Offsets the extent.
io-throttle
Limits the amount of I/Os allowed for this VDisk. If MB is not specified, the
unit is calculated in I/Os per second.
MB
Specifies the I/O throttling in Megabytes.
shrink
Shrinks the capacity of the VDisk as specified.
Defaults
None.
Command Modes
SVC configuration mode—cluster configuration submode.
Cisco MDS 9000 Family Command Reference
2-57
Chapter 2
Caching Services Module Commands
vdisk
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
Usage Guidelines
The cluster configuration submode prompt is (switch(svc-cluster)#).
The VDisk submode prompt is switch (svc-cluster-vdisk)#
Extents are allowed from all MDisks in the list
Examples
The following example enters the cluster configuration mode for SampleCluster and --switch(svc)# cluster config SampleCluster
switch(svc-cluster)# vdisk add Vdisk1 iogroup 1 mdisk-grp Mdisk1 ?
capacity Vdisk add name iogroup mdisk-grp
import
Vdisk add import
switch(svc-cluster)# vdisk add Vdisk1 iogroup 1 mdisk-grp Mdisk1 capacity ?
<0-2147483647> Enter the capacity
switch(svc-cluster)# vdisk add Vdisk1 iogroup 1 mdisk-grp Mdisk1 capacity 5000 ?
gb Vdisk add name iogroup mdisk-grp capacity
mb Vdisk add name iogroup mdisk-grp capacity
pb Vdisk add name iogroup mdisk-grp capacity
tb Vdisk add name iogroup mdisk-grp capacity
switch(svc-cluster)# vdisk add Vdisk1 iogroup 1 mdisk-grp Mdisk1 capacity 5000 gb ?
clean
Vdisk add clean
mdisk-list
Vdisk add mdisk-list
preferred-node Vdisk add sequential mdisk
sequential
Vdisk add sequential
<cr>
Carriage Return
switch(svc-cluster)# vdisk add VDISK1 iogroup 1 mdisk-grp Mdisk1 capacity 0 gb
switch(svc-cluster)# vdisk VDISK1
switch(svc-cluster-vdisk)# ?
Submode Commands:
exit
Exit from this mode
expand
Expand
io-throttle Io throttle
iogroup
Move vdisk to iogroup
no
Negate a command or set its defaults
shrink
Shrink capacity
switch(svc-cluster-vdisk)# expand ?
capacity Expand capacity
extent
Expand extent
switch(svc-cluster-vdisk)# io-throttle 0
switch(svc-cluster-vdisk)# shrink capacity 1 ?
gb Expand capacity
mb Expand capacity
pb Expand capacity
tb Expand capacity
switch(svc-cluster-vdisk)# exit
switch(svc)# show cluster SampleCluster vdisk
------------------------------------------------------------------------------name
capacity
iogroup mdisk-grp name
policy
status
-------------------------------------------------------------------------------
Cisco MDS 9000 Family Command Reference
2-58
Chapter 2
Caching Services Module Commands
vdisk
Vdisk1
Vdisk2
100.00 GB
50.00 GB
1
1
Group1
Group2
striped
striped
online
online
switch(svc)# show cluster SampleCluster vdisk Vdisk1
vdisk Vdisk1 is online
Capacity is 100.00 GB
Using storage from mdisk-grp Group1
Processed by io group 1
Virtualization policy is striped
Preferred node is 2
switch(svc)# show cluster SampleCluster vdisk Vdisk1 extent
------------------------------------------------------------------------------mdisk id number of extents
------------------------------------------------------------------------------1
2134
2
2133
3
2133
switch(svc)# show cluster SampleCluster vdisk Vdisk1 mapped_hosts
------------------------------------------------------------------------------host
LUN
------------------------------------------------------------------------------Host1
0
Related Commands
Command
Description
show cluster name vdisk
Displays configured vdisk information for a specified cluster.
Cisco MDS 9000 Family Command Reference
2-59
Chapter 2
vdisk
Cisco MDS 9000 Family Command Reference
2-60
Caching Services Module Commands
CH A P T E R
1
CLI Overview
This chapter prepares you to configure switches from the CLI (command-line interface) and it describes
the CLI command modes.
This chapter includes the following sections:
•
About the Switch Prompt, page 1-2
•
About the CLI Command Modes, page 1-3
•
Understanding CLI Command Hierarchy, page 1-4
•
Navigating Through CLI Commands, page 1-13
•
Searching and Filtering CLI Output, page 1-19
•
Using CLI Variables, page 1-27
•
Using Command Aliases, page 1-29
•
About Flash Devices, page 1-30
•
Formatting Flash Disks and File Systems, page 1-31
•
Using the File System, page 1-32
•
Role-Based CLI, page 1-38
•
Using Valid Formats and Ranges, page 1-39
•
Using Debug Commands, page 1-40
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-1
Chapter 1
CLI Overview
About the Switch Prompt
About the Switch Prompt
If you are connected to the console port when the switch boots up, you see the output shown in
Example 1-1.
Note
Refer to the Cisco MDS 9100 Series Hardware Installation Guide, the Cisco MDS 9200 Series Hardware
Installation Guide, the Cisco MDS 9216 Hardware Installation Guide, or the Cisco MDS 9500 Series
Hardware Installation Guide for installation and connection instructions.
After the switch is powered on successfully, you see the default switch prompt (switch#). You can
perform embedded CLI operations, access command history, and use command parsing functions at this
prompt. The switch obtains the command string upon detecting an Enter (CR) and accepts commands
from a terminal.
Example 1-1
Displays the Output When a Switch Boots Up
Auto booting bootflash:/boot-279 bootflash:/system_image;...
Booting kickstart image:bootflash:/boot-279....
............................................Image verification OK
Starting kernel...
INIT: version 2.78 booting
Checking all filesystems..... done.
Loading system software
Uncompressing system image: bootflash:/system_image
CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
INIT: Entering runlevel: 3
<<<<<<SAN OS bootup log messages>>>>>>
---- Basic System Configuration Dialog ---This setup utility will guide you through the basic configuration of
the system. Use ctrl-c to abort configuration dialog at any prompt.
Basic management setup configures only enough connectivity for
management of the system.
Would you like to enter the basic configuration dialog (yes/no): yes
<<<<<<after configuration>>>>>>
switch login:
Cisco MDS 9000 Family Command Reference
1-2
OL-29295-04
Chapter 1
CLI Overview
About the CLI Command Modes
About the CLI Command Modes
Switches in the Cisco MDS 9000 Family have two main command modes: user EXEC mode and
configuration mode. The commands available to you depend on the mode you are in. To obtain a list of
available commands in either mode, type a question mark (?) at the system prompt.
Table 1-1 lists and describes the two commonly used modes, how to enter the modes, and the resulting
system prompts. The system prompt helps you identify which mode you are in and which indicates the
commands that are available to you.
Table 1-1
Frequently Used Switch Command Modes
Mode
Description of Use
EXEC
Enables you to temporarily change
At the switch prompt, enter the required
terminal settings, perform basic tests, and EXEC mode command.
display system information.
Note
Configuration
mode
Prompt
switch#
Changes made in this mode are
generally not saved across system
resets.
Enables you to configure features that
affect the system as a whole.
Note
How to Access
From EXEC mode, enter the config
terminal command.
switch(config)#
Changes made in this mode are
saved across system resets if you
save your configuration. Refer to
the Cisco NX-OS 9000 Family
Fundementals Configuration
Guide for further information.
You can abbreviate commands and keywords by entering just enough characters to make the command
unique from other commands. For example, you can abbreviate the config terminal command to conf t.
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-3
Chapter 1
CLI Overview
Understanding CLI Command Hierarchy
Understanding CLI Command Hierarchy
The CLI commands are organized hierarchically, with commands that perform similar functions grouped
under the same level. For example, all commands that display information about the system,
configuration, or hardware are grouped under the show command, and all commands that allow you to
configure the switch are grouped under the config terminal command. Figure 1-1 illustrates a portion
of the config terminal command hierarchy.
Figure 1-1
CLI Command Hierarchy Example
switch prompt (switch#)
EXEC mode
configure
cd
write erase
exit
clock
Configuration
interface
zoneset
end
mode
exit
fspf
switchport
Configuration
79525
submode
To execute a command, you enter the command by starting at the top level of the hierarchy. For example,
to configure a Fibre Channel interface, use the config terminal command. Once you are in configuration
mode, entres the interface command. When you are in the interface submode, you can query the
available commands there.
The following example shows how to query the available commands in the interface submode:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# interface fc1/1
switch(config-if)# ?
Interface configuration commands:
channel-group Add to/remove from a port-channel
exit
Exit from this submode
fcdomain
Enter the interface submode
fspf
To configure FSPF related parameters
no
Negate a command or set its defaults
shutdown
Enable/disable an interface
switchport
Configure switchport parameters
Cisco MDS 9000 Family Command Reference
1-4
OL-29295-04
Chapter 1
CLI Overview
Understanding CLI Command Hierarchy
EXEC Mode Options
When you start a session on the switch, you begin in EXEC mode. Based on the role or group to which
you belong, you have access to limited commands or to all commands (see the “Role-Based CLI” section
on page 1-38). From the EXEC mode, you can enter configuration mode. Most of the EXEC commands
are one-time commands, such as show commands, which display the current configuration status.
The next two sections list the EXEC mode commands for the Cisco MDS 9000 Family, the Cisco Fabric
Switch for HP c-Class BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter. Not all EXEC
mode commands that are supported on the Cisco MDS 9000 Family switches are available on the Cisco
Fabric Switch for HP c-Class BladeSystem and the Cisco Fabric Switch for IBM BladeCenter.
EXEC Mode Commands for the Cisco MDS 9000 Family
switch# ?
Exec commands:
attach
callhome
cd
clear
cli
clock
config
copy
debug
delete
dir
discover
exit
fcping
fctrace
find
format
gunzip
gzip
install
license
mkdir
modem
move
no
ntp
out-of-service
ping
port-channel
purge
pwd
reload
rmdir
run-script
sdv
send
setup
show
sleep
ssh
system
tac-pac
tail
telnet
Connect to a specific linecard
Callhome commands
Change current directory
Reset functions
CLI commands
Manage the system clock
Enter configuration mode
Copy from one file to another
Debugging functions
Delete a file
List files in a directory
Discover information
Exit from the EXEC
Ping an N-Port
Trace the route for an N-Port.
Find a file below the current directory
Format disks
Uncompresses LZ77 coded files
Compresses file using LZ77 coding
Upgrade software
Enter the license configuration mode
Create new directory
Modem commands
Move files
Disable debugging functions
Execute NTP commands
Make the current module out-of-service
Send echo messages
Port-Channel related commands
Deletes unused data
View current directory
Reboot the entire box
Delete a directory
Run shell scripts
SDV test commands
Send message to open sessions
Run the basic SETUP command facility
Show running system information
Sleep for the specified number of seconds
SSH to another system
System management commands
Save tac information to a specific location
Display the last part of a file
Telnet to another system
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-5
Chapter 1
CLI Overview
Understanding CLI Command Hierarchy
terminal
test
traceroute
undebug
update
write
zone
zoneset
Set terminal line parameters
Test command
Trace route to destination
Disable Debugging functions (See also debug)
Update license
Write current configuration
Execute Zone Server commands
Execute zoneset commands
EXEC Mode Commands for the Cisco Fabric Switch for HP c-Class BladeSystem and the Cisco Fabric
Switch for IBM BladeCenter
switch# ?
Exec commands:
attach
callhome
cd
clear
cli
clock
config
copy
debug
delete
dir
discover
exit
fcping
fctrace
find
format
gunzip
gzip
install
license
mkdir
modem
move
no
ntp
out-of-service
ping
port-channel
purge
pwd
reload
rmdir
run-script
send
setup
show
sleep
ssh
system
tac-pac
tail
telnet
terminal
test
traceroute
undebug
update
Connect to a specific linecard
Callhome commands
Change current directory
Reset functions
CLI commands
Manage the system clock
Enter configuration mode
Copy from one file to another
Debugging functions
Delete a file
List files in a directory
Discover information
Exit from the EXEC
Ping an N-Port
Trace the route for an N-Port.
Find a file below the current directory
Format disks
Uncompresses LZ77 coded files
Compresses file using LZ77 coding
Upgrade software
Enter the license configuration mode
Create new directory
Modem commands
Move files
Disable debugging functions
Execute NTP commands
Make the current module out-of-service
Send echo messages
Port-Channel related commands
Deletes unused data
View current directory
Reboot the entire box
Delete a directory
Run shell scripts
Send message to open sessions
Run the basic SETUP command facility
Show running system information
Sleep for the specified number of seconds
SSH to another system
System management commands
Save tac information to a specific location
Display the last part of a file
Telnet to another system
Set terminal line parameters
Test command
Trace route to destination
Disable Debugging functions (See also debug)
Update license
Cisco MDS 9000 Family Command Reference
1-6
OL-29295-04
Chapter 1
CLI Overview
Understanding CLI Command Hierarchy
write
zone
zoneset
Write current configuration
Execute Zone Server commands
Execute zoneset commands
Configuration Mode Options
Configuration mode allows you to make changes to the existing configuration. When you save the
configuration, these commands are preserved across switch reboots. Once you are in configuration
mode, you can enter interface configuration mode, zone configuration mode, and a variety of
protocol-specific modes. Configuration mode is the starting point for all configuration commands. When
you are in configuration mode, the switch expects configuration commands from the user.
The following example shows output from the config terminal command:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)#
Not all configuration mode commands that are available on the Cisco MDS 9000 Family are available
on the Cisco Fabric Switch for HP c-Class BladeSystem and the Cisco Fabric Switch for IBM
BladeCenter.
The following two sections list the configuration mode commands for the Cisco MDS 9000 Family, the
Cisco Fabric Switch for HP c-Class BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
Not all configuration mode commands that are supported on the Cisco MDS 9000 Family switches are
available on the Cisco Fabric Switch for HP c-Class BladeSystem and the Cisco Fabric Switch for IBM
BladeCenter.
Configuration Mode Commands for the Cisco MDS 9000 Family
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# ?
Configure commands:
aaa
Configure aaa functions
arp
[no] remove an entry from the ARP cache
banner
Configure banner message
boot
Configure boot variables
callhome
Enter the callhome configuration mode
cdp
CDP Configuration parameters
cfs
CFS configuration commands
cimserver
Modify cimserver configuration
cli
CLI configuration commands
clock
Configure time-of-day clock
cloud
Configure Cloud Discovery
cloud-discovery
Configure Cloud Discovery
crypto
Set crypto settings
device-alias
Device-alias configuration commands
do
EXEC command
dpvm
Configure Dynamic Port Vsan Membership
end
Exit from configure mode
exit
Exit from configure mode
fabric-binding
Fabric Binding configuration
fc-tunnel
Configure fc-tunnel
fcalias
Fcalias configuration commands
fcanalyzer
Configure cisco fabric analyzer
fcc
Configure FC Congestion Control
fcdomain
Enter the fcdomain configuration mode
fcdroplatency
Configure switch or network latency
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-7
Chapter 1
CLI Overview
Understanding CLI Command Hierarchy
fcflow
fcid-allocation
fcinterop
fcip
fcns
fcroute
fcrxbbcredit
fcs
fcsp
fctimer
fdmi
ficon
fspf
hw-module
in-order-guarantee
interface
ip
ips
ipv6
iscsi
islb
isns
isns-server
ivr
kernel
line
logging
mcast
no
npiv
ntp
port-security
port-track
power
poweroff
qos
radius
radius-server
rib
rmon
role
rscn
san-ext-tuner
scheduler
scsi-target
snmp-server
span
ssh
switchname
system
tacacs+
telnet
tlport
trunk
username
vsan
wwn
zone
zone-attribute-group
zoneset
Configure fcflow
Add/remove company id(or OUIs) from auto area list
Interop commands
Enable/Disable FCIP
Name server configuration
Configure FC routes
Enable extended rx b2b credit configuration
Configure Fabric Config Server
Config commands for FC-SP
Configure fibre channel timers
Config commands for FDMI
Configure ficon information
Configure fspf
Enable/Disable OBFL information
Set in-order delivery guarantee
Select an interface to configure
Configure IP features
Various sibyte module related commands
Configure IPv6 features
Enable/Disable iSCSI
ISCSI server load-balancing
Configure iSNS
ISNS server
Config commands for IVR
Kernel options
Configure a terminal line
Modify message logging facilities
Configure multicast
Negate a command or set its defaults
Nx port Id Virtualization (NPIV) feature enable
NTP Configuration
Configure Port Security
Configure Switch port track config
Configure power supply
Poweroff a module in the switch
QoS Configuration commands
Configure RADIUS configuration
Configure RADIUS related parameters
Configure RIB parameters
Remote Monitoring
Configure roles
Config commands for RSCN
Enable/Disable San Extension Tuner tool
Config commands for scheduler
Scsi-target configuration
Configure snmp server
Enter SPAN configuration mode
Configure SSH parameters
Configure system's network name
System config command
Enable tacacs+
Enable telnet
Configure TL Port information
Configure Switch wide trunk protocol
Configure user information.
Enter the vsan configuration mode
Set secondary base MAC addr and range for additional WWNs
Zone configuration commands
Zone attribute group commands
Zoneset configuration commands
Cisco MDS 9000 Family Command Reference
1-8
OL-29295-04
Chapter 1
CLI Overview
Understanding CLI Command Hierarchy
Configuration Mode Commands for the Cisco Fabric Switch for HP c-Class BladeSystem and the
Cisco Fabric Switch for IBM BladeCenter
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# ?
Configure commands:
aaa
Configure aaa functions
arp
[no] remove an entry from the ARP cache
banner
Configure banner message
boot
Configure boot variables
callhome
Enter the callhome configuration mode
cdp
CDP Configuration parameters
cfs
CFS configuration commands
cimserver
Modify cimserver configuration
cli
CLI configuration commands
clock
Configure time-of-day clock
device-alias
Device-alias configuration commands
do
EXEC command
dpvm
Configure Dynamic Port Vsan Membership
end
Exit from configure mode
exit
Exit from configure mode
fabric-binding
Fabric Binding configuration
fcalias
Fcalias configuration commands
fcanalyzer
Configure cisco fabric analyzer
fcdomain
Enter the fcdomain configuration mode
fcdroplatency
Configure switch or network latency
fcflow
Configure fcflow
fcid-allocation
Add/remove company id(or OUIs) from auto area list
fcinterop
Interop commands
fcns
Name server configuration
fcroute
Configure FC routes
fcrxbbcredit
Enable extended rx b2b credit configuration
fcs
Configure Fabric Config Server
fcsp
Config commands for FC-SP
fctimer
Configure fibre channel timers
fdmi
Config commands for FDMI
fips
Enable/Disable FIPS mode
fspf
Configure fspf
hw-module
Enable/Disable OBFL information
in-order-guarantee
Set in-order delivery guarantee
interface
Select an interface to configure
ip
Configure IP features
ipv6
Configure IPv6 features
kernel
Kernel options
line
Configure a terminal line
logging
Modify message logging facilities
mcast
Configure multicast
no
Negate a command or set its defaults
npiv
Nx port Id Virtualization (NPIV) feature enable
ntp
NTP Configuration
port-security
Configure Port Security
port-track
Configure Switch port track config
power
Configure power supply
poweroff
Poweroff a module in the switch
qos
QoS Configuration commands
radius
Configure RADIUS configuration
radius-server
Configure RADIUS related parameters
rate-mode
Configure rate mode oversubscription limit
rib
Configure RIB parameters
rlir
Config commands for RLIR
rmon
Remote Monitoring
role
Configure roles
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-9
Chapter 1
CLI Overview
Understanding CLI Command Hierarchy
rscn
scheduler
scsi-target
sdv
snmp-server
span
ssh
switchname
system
tacacs+
tacacs-server
telnet
trunk
username
vsan
wwn
zone
zone-attribute-group
zoneset
Config commands for RSCN
Config commands for scheduler
Scsi-target configuration
Config commands for SAN Device Virtualization
Configure snmp server
Enter SPAN configuration mode
Configure SSH parameters
Configure system's network name
System config command
Enable tacacs+
Configure TACACS+ server related parameters
Enable telnet
Configure Switch wide trunk protocol
Configure user information.
Enter the vsan configuration mode
Set secondary base MAC addr and range for additional WWNs
Zone configuration commands
Zone attribute group commands
Zoneset configuration commands
Configuration mode, also known as terminal configuration mode, has several submodes. Each of these
submodes places you deeper in the prompt hierarchy. When you type exit, the switch backs out one level
and returns you to the previous level. When you type end, the switch backs out to the user EXEC level.
You can also type Ctrl-Z in configuration mode as an alternative to typing end.
Note
When in configuration mode, you can alternatively enter:
•
Ctrl-Z instead of the end command
•
Ctrl-G instead of the exit command
You can execute an EXEC mode command from a configuration mode or submode prompt. You can issue
this command from any submode within the configuration mode. When in configuration mode (or in any
submode), enter the do command along with the required EXEC mode command. The entered command
is executed at the EXEC level and the prompt resumes its current mode level.
switch(config)# do terminal session-timeout 0
switch(config)#
In this example, terminal session-timeout is an EXEC mode command—you are entering an EXEC
mode command using the configuration mode do command.
The do command applies to all EXEC mode commands other than the end and exit commands. You can
also use the help (?) and command completion (tab) features for EXEC commands when entering a do
command along with the EXEC command.
Table 1-2 lists some useful command keys that can be used in both EXEC and configuration modes.
Table 1-2
Useful Command Key Description
Command
Description
Ctrl-P
Up history
Ctrl-N
Down history
Ctrl-X-H
List history
Cisco MDS 9000 Family Command Reference
1-10
OL-29295-04
Chapter 1
CLI Overview
Understanding CLI Command Hierarchy
Table 1-2
Useful Command Key Description (continued)
Command
Description
Alt-P
History search backwards
Note
The difference between Tab completion and Alt- P or Alt-N is that TAB
completes the current word while Alt- P and Alt-N completes a
previously entered command.
Alt-N
History search forwards
Ctrl-G
Exit
Ctrl-Z
End
Ctrl-L
Clear screen
Table 1-3 displays the commonly used configuration submodes for the Cisco MDS 9000 Family
switches.
Table 1-3
Submodes Within the Configuration Mode for the Cisco MDS 9000 Family
Submode Name
From Configuration Mode Enter
Submode Prompt
Configured Information
Call Home
callhome
switch(config-callhome)#
Contact, destination, and e-mail
FCS Registration
fcs register
switch(config-fcs-register)#
FCS attribute registration
From FCS registration submode:
switch(config-fcs-register-att
rib)#
Platform name and VSAN ID
association
platform name name vsan
vsan-id
Fibre Channel alias fcalias name name vsan vsan-id switch(config-fcalias)#
Alias member
FSPF
fspf config vsan vsan-id
switch(config-(fspf-config))#
Static SPF computation, hold
time, and autonomous region
Interface
configuration
interface type slot/port
switch(config-if)#
Channel groups, Fibre Channel
domains, FSPF parameters,
switch port trunk and beacon
information, and IP address
From the VSAN or mgmt0
(management) interface
configuration submode:
switch(config-if-vrrp)#
Virtual router
vrrp number
iSCSI target
iscsi virtual-target name
switch(config-iscsi-tgt)
iSCSI virtual target
iSLB initiator
islb initiator
switch(config-islb-init)#
iSCSI server load balancing
(iSLB) initiator
iSLB target
islb virtual-target name
switch(config-islb-tgt)
iSCSI server load balancing
(iSLB) virtual target
Line console
line console
switch(config-console)#
Primary terminal console
VTY
line vty
switch(config-line)#
Virtual terminal line
Role
role name
switch(config-role)#
Rule
SPAN
span session number
switch(config-span)#
SPAN source, destination, and
suspend session information
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-11
Chapter 1
CLI Overview
Understanding CLI Command Hierarchy
Table 1-3
Submodes Within the Configuration Mode for the Cisco MDS 9000 Family (continued)
Submode Name
From Configuration Mode Enter
Submode Prompt
Configured Information
VSAN database
vsan database
switch(config-vsan-db)#
VSAN database
Zone
zone name string vsan vsan-id
switch(config-zone)#
Zone member
Zone set
zoneset name name vsan
vsan-id
switch(config-zoneset)#
Zone set member
SDV virtual device
sdv virtual-device name
device-name vsan vsan-id
switch(config-sdv-virt-dev)#
SAN Device Virtualization
information
Table 1-4 displays the commonly used configuration submodes for the Cisco Fabric Switch for HP
c-Class BladeSystem and the Cisco Fabric Switch for IBM BladeCenter.
Table 1-4
Submodes Within the Configuration Mode for the Cisco Fabric Switch for HP c-Class BladeSystem and the
Cisco Fabric Switch for IBM BladeCenter
Submode Name
From Configuration Mode Enter
Submode Prompt
Configured Information
Call Home
callhome
switch(config-callhome)#
Contact, destination, and e-mail
FCS Registration
fcs register
switch(config-fcs-register)#
FCS attribute registration
From FCS registration submode:
switch(config-fcs-register-att
rib)#
Platform name and VSAN ID
association
platform name name vsan
vsan-id
Fibre Channel alias fcalias name name vsan vsan-id switch(config-fcalias)#
Alias member
FSPF
fspf config vsan vsan-id
switch(config-(fspf-config))#
Static SPF computation, hold
time, and autonomous region
Interface
configuration
interface type slot/port
switch(config-if)#
Channel groups, Fibre Channel
domains, FSPF parameters,
switch port trunk and beacon
information, and IP address
From the VSAN or mgmt0
(management) interface
configuration submode:
switch(config-if-vrrp)#
Virtual router
vrrp number
Line console
line console
switch(config-console)#
Primary terminal console
VTY
line vty
switch(config-line)#
Virtual terminal line
Role
role name
switch(config-role)#
Rule
SPAN
span session number
switch(config-span)#
SPAN source, destination, and
suspend session information
VSAN database
vsan database
switch(config-vsan-db)#
VSAN database
Zone
zone name string vsan vsan-id
switch(config-zone)#
Zone member
Zone set
zoneset name name vsan
vsan-id
switch(config-zoneset)#
Zone set member
SDV virtual device
sdv virtual-device name
device-name vsan vsan-id
switch(config-sdv-virt-dev)#
SAN device virtualization
information
Cisco MDS 9000 Family Command Reference
1-12
OL-29295-04
Chapter 1
CLI Overview
Navigating Through CLI Commands
Note
SPAN is only supported on external ports.
Navigating Through CLI Commands
To redisplay a command you previously entered, press the Up Arrow key. You can continue to press the
Up Arrow key to see more previously entered commands. Similarly, you can press the Down Arrow,
Right Arrow, Left Arrow, and Delete keys to navigate through the command history and to modify an
existing command string.
Getting Help
In any command mode, you can get a list of available commands by entering a question mark (?).
switch# ?
To obtain a list of commands that begin with a particular character sequence, type in those characters
followed immediately by the question mark (?). Do not include a space.
switch# co?
configure copy
To list keywords or arguments, enter a question mark in place of a keyword or argument. Include a space
before the question mark. This form of help is called command syntax help, because it reminds you
which keywords or arguments are applicable based on the commands, keywords, and arguments you
have already entered.
switch# config ?
terminal Configure the system from the terminal
Tip
If you are having trouble entering a command, check the system prompt and enter the question mark (?)
for a list of available commands. You might be in the wrong command mode or using incorrect syntax.
Command Completion
In any command mode, you can begin a particular command sequence and immediately press the Tab
key to complete the rest of the command.
switch (config)# ro<Tab>
switch (config)# role <Tab>
switch (config)# role name
This form of help is called command completion, because it completes a word for you. If several options
are available for the typed letters, all options that match those letters are presented:
switch(config)# fc<Tab>
fcalias
fcdomain
fcanalyzer
fcdroplatency
fcc
fcinterop
switch(config)# fcd<Tab>
fcdomain
fcdroplatency
switch(config)# fcdo<Tab>
switch(config)# fcdomain
fcs
fcns
fcroute
fctimer
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-13
Chapter 1
CLI Overview
Navigating Through CLI Commands
Using the no and Default Forms of Commands
You can enter the no form of any command to perform the following actions:
•
Undo an incorectly entered command.
If you issue the zone member command, you can undo the results:
switch(config)# zone name test vsan 1
switch(config-zone)# member pwwn 12:12:12:12:12:12:12:12
switch(config-zone)# no member pwwn 12:12:12:12:12:12:12:12
WARNING: Zone is empty. Deleting zone test. Exit the submode.
switch(config-zone)#
•
Delete a created facility:
If you want to delete a zone that you created:
switch(config)# zone name test vsan 1
switch(config-zone)# exit
switch(config)# no zone name test vsan 1
switch(config)#
You cannot delete a zone facility called test while residing in it. You must first exit the zone submode
and return to configuration mode.
Port Names and Port Mapping
The Cisco Fabric Switch for HP c-Class BladeSystem has a different port-naming convention from the
Cisco MDS 9000 Family switch. It has eight external ports and they are labeled ext1 through ext8. It has
16 internal ports and they are labeled bay1 through bay16.
Table 1-5 shows the port mapping between the Cisco MDS 9000 Family and the Cisco Fabric Switch for
HP c-Class BladeSystem.
Table 1-5
Port Mapping Between the Cisco MDS 9000 Family and the Cisco Fabric Switch for HP
c-Class BladeSystem
Cisco MDS 9000 Family Port
Cisco Fabric Switch for HP
c-Class BladeSystem Port
Port Group
fc1/1
ext8
PortGroup 1
fc1/2
bay6
fc1/3
bay13
fc1/4
bay5
fc1/5
ext7
fc1/6
bay14
fc1/7
bay15
fc1/8
bay7
fc1/9
bay4
fc1/10
ext1
fc1/11
bay3
fc1/12
bay11
fc1/13
bay12
PortGroup 2
PortGroup 3
PortGroup 4
Cisco MDS 9000 Family Command Reference
1-14
OL-29295-04
Chapter 1
CLI Overview
Navigating Through CLI Commands
Table 1-5
Port Mapping Between the Cisco MDS 9000 Family and the Cisco Fabric Switch for HP
c-Class BladeSystem (continued)
Cisco MDS 9000 Family Port
Cisco Fabric Switch for HP
c-Class BladeSystem Port
Port Group
fc1/1
ext8
PortGroup 1
fc1/14
ext2
fc1/15
bay2
fc1/16
bay1
fc1/17
bay10
fc1/18
ext3
fc1/19
bay9
fc1/20
ext 4
fc1/21
bay16
fc1/22
bay8
fc1/23
ext6
fc1/24
ext5
PortGroup 5
PortGroup 6
The Cisco Fabric Switch for IBM BladeCenter has a different port naming convention from the Cisco
MDS 9000 Family switch. There are six external ports and they are labeled ext0 and ext15 through ext19.
There are 14 internal ports and they are labeled bay1 through bay14. Table 1-6 shows the port mapping
between the Cisco MDS 9000 Family switches and the Cisco Fabric Switch for IBM BladeCenter
switches.
Table 1-6
Port Mapping Between the Cisco MDS 9000 Family switch and the Cisco Fabric
Switch for IBM BladeCenter
Cisco MDS 9000 Family Port
Cisco Fabric Switch for IBM
BladeCenter Port
Port Group
fc1/1
ext19
PortGroup 1
fc1/2
bay10
fc1/3
bay11
fc1/4
bay12
fc1/5
ext18
fc1/6
bay9
fc1/7
bay13
fc1/8
bay14
fc1/9
bay8
fc1/10
ext17
fc1/11
bay6
fc1/12
bay5
fc1/13
bay7
fc1/14
ext16
PortGroup 2
PortGroup 3
PortGroup 4
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-15
Chapter 1
CLI Overview
Navigating Through CLI Commands
Table 1-6
Port Mapping Between the Cisco MDS 9000 Family switch and the Cisco Fabric
Switch for IBM BladeCenter (continued)
Cisco MDS 9000 Family Port
Cisco Fabric Switch for IBM
BladeCenter Port
Port Group
fc1/1
ext19
PortGroup 1
fc1/15
bay4
fc1/16
bay2
fc1/17
bay3
fc1/18
ext0
fc1/19
bay1
fc1/20
ext15
PortGroup 5
When you enter commands that require port names for the Cisco Fabric Switch for HP c-Class
BladeSystem or the Cisco Fabric Switch for IBM BladeCenter, use the appropriate naming convention
from either Table 1-5 or Table 1-6. See Example 1-2 and Example 1-3 for typical commands that require
port names.
Example 1-2
interface Command
switch# config t
Enter configuration commands, one per line.
chester-1(config)# interface ext2
chester-1(config-if)#
Example 1-3
End with CNTL/Z.
show interface Command
switch# show interface bay 5
Entering CLI Commands
You can configure the software in one of two ways:
•
You can create the configuration for the switch interactively by entering commands at the CLI
prompt.
•
You can create an ASCII file containing a switch configuration and then load this file on the required
system. You can then use the CLI to edit and activate the file.
Viewing Switch Configurations
You can view the ASCII form of the configuration file when required. To view the current configuration
tree from the EXEC prompt, enter the show running-config command. If the running configuration is
different from the startup configuration, enter the show startup-config command to view the ASCII
version of the current startup configuration that was used to boot the switch.
You can also obtain specific information on the entire switch configuration by entering the relevant show
commands. Configurations are displayed based on specified feature, interface, module, or VSAN.
Available show commands for each feature are briefly described in this section and listed at the end of
each chapter.
Cisco MDS 9000 Family Command Reference
1-16
OL-29295-04
Chapter 1
CLI Overview
Navigating Through CLI Commands
Examples 1-4 to 1-10 display a few show command examples.
Example 1-4
Displays Details on the Specified Interface
switch# show interface fc1/1
fc1/1 is up
Hardware is Fibre Channel, 20:01:ac:16:5e:4a:00:00
vsan is 1
Port mode is E
Speed is 1 Gbps
Beacon is turned off
FCID is 0x0b0100
0 frames input, 0 bytes, 0 discards
0 runts, 0 jabber, 0 too long, 0 too short
0 input errors, 0 CRC, 0 invalid transmission words
0 address id, 0 delimiter
0 EOF abort, 0 fragmented, 0 unknown class
0 frames output, 0 bytes, 0 discards
Received 0 OLS, 0 LRR, 0 NOS, 0 loop inits
Transmitted 0 OLS, 0 LRR, 0 NOS, 0 loop inits
Example 1-5
Displays the Software and Hardware Version
switch# show version
Cisco Storage Area Networking Operating System (SAN-OS) Software
TAC support: http://www.cisco.com/tac
Copyright (c) 2002-2006, Cisco Systems, Inc. All rights reserved.
The copyrights to certain works contained herein are owned by
other third parties and are used and distributed under license.
Some parts of this software may be covered under the GNU Public
License or the GNU Lesser General Public License. A copy of
each such license is available at
http://www.gnu.org/licenses/gpl.html and
http://www.gnu.org/licenses/lgpl.html
Software
BIOS:
loader:
kickstart:
system:
version
version
version
version
1.1.0
1.2(2)
3.0(3) [gdb]
3.0(3) [gdb]
BIOS compile time:
kickstart image file is:
kickstart compile time:
system image file is:
system compile time:
10/24/03
bootflash:///boot-3.0.3
9/15/2006 10:00:00 [10/02/2006 06:26:25]
bootflash:///isan-3.0.3
9/15/2006 10:00:00 [10/02/2006 06:45:25]
Hardware
cisco MDS 9509 ("Supervisor/Fabric-1")
Intel(R) Pentium(R) III CPU with 1028604 kB of memory.
bootflash:
slot0:
172.22.31.238
251904 kB
251904 kB
kernel uptime is 0 days 0 hour 2 minute(s) 2 second(s)
Last reset at 744021 usecs after Tue Oct 21 14:55:11 1980
Reason: Reset Requested by CLI command reload
System version: 4.0(0.432)
Service:
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-17
Chapter 1
CLI Overview
Navigating Through CLI Commands
Example 1-6
Displays the Running Configuration
switch# show running
Building Configuration ...
interface fc1/1
interface fc1/2
interface fc1/3
interface fc1/4
interface mgmt0
ip address 172.22.95.112 255.255.255.0
no shutdown
vsan database
boot system bootflash:system-237; sup-1
boot kickstart bootflash:boot-237 sup-1
callhome
ip default-gateway 172.22.95.1
switchname switch
trunk protocol enable
username admin password 5 /AFDAMD4B2xK2
Example 1-7
role network-admin
Displays the Difference between the Running and Startup Configuration
switch# show running diff
Building Configuration ...
*** Startup-config
--- Running-config
****************** 1,16 ****
fcip enable
ip default-gateway 172.22.91.1
iscsi authentication none
iscsi enable
! iscsi import target fc
iscsi virtual-target name vt
pWWN 21:00:00:04:cf:4c:52:c1
all-initiator-permit
--- 1,20 ---fcip enable
+ aaa accounting logsize 500
+
+
+
ip default-gateway 172.22.91.1
iscsi authentication none
iscsi enable
! iscsi initiator name junk
iscsi virtual-target name vt
pWWN 21:00:00:04:cf:4c:52:c1
all-initiator-permit
Example 1-8
Displays the Configuration for a Specified Interface
switch# show running interface fc2/9
interface fc2/9
switchport mode E
no shutdown
Note
The show running interface command is different from the show interface command.
Cisco MDS 9000 Family Command Reference
1-18
OL-29295-04
Chapter 1
CLI Overview
Searching and Filtering CLI Output
Example 1-9
Displays the Configuration for All Interfaces in a 16-Port Module
switch# show running interface fc2/10 - 12
interface fc2/10
switchport mode E
no shutdown
interface fc2/11
switchport mode E
no shutdown
interface fc2/12
switchport mode FL
no shutdown
Example 1-10 Displays the Configuration Per VSAN
switch# show runnning vsan 1
Building Configuration ...
zone name m vsan 1
member pwwn 21:00:00:20:37:60:42:5c
member pwwn 21:00:00:20:37:4b:00:a2
zoneset name m vsan 1
member m
zoneset activate name m vsan 1
Saving a Configuration
To save the configuration, enter the copy running-config startup-config command from the EXEC
mode prompt to save the new configuration into nonvolatile storage. Once this command is issued, the
running and the startup copies of the configuration are identical.
Clearing a Configuration
To clear a startup configuration, enter the write erase command from the EXEC mode prompt. After this
command is entered, the switch’s startup configuration reverts to factory defaults. The running
configuration is not affected. The write erase command erases the entire startup configuration with the
exception of any configuration that affects the loader functionality.
The write erase boot command only erases the configuration that affects the loader functionality. The
loader functionality configuration includes the boot variables and the mgmt0 IP configuration
information (IP address, netmask and default gateway).
switch# write erase boot
This command will erase the boot variables and the ip configuration of interface mgmt 0
Searching and Filtering CLI Output
The Cisco MDS NX-OS CLI provides ways of searching through large amounts of command output and
filtering output to exclude information that you do not need. These features are enabled for the show
command, which generally displays large amounts of data.
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-19
Chapter 1
CLI Overview
Searching and Filtering CLI Output
Note
The show command is always entered in EXEC mode.
When output continues beyond what is displayed on your screen, the Cisco MDS NX-OS CLI displays
a --More-- prompt. Pressing Return displays the next line; pressing the Spacebar displays the next
screen of output.
To search the show command output, use the following command in EXEC mode:
Command
Purpose
switch# show any-command | begin pattern
Begins unfiltered output of the show command with
the first line that contains the pattern.
Note
Cisco MDS NX-OS documentation generally uses the vertical bar to indicate a choice of syntax.
However, to search the output of the show command, you need to enter the pipe character (the vertical
bar). In this section the pipe appears in bold (|) to indicate that you should enter this character.
To filter show command output, use one of the following commands in EXEC mode:
Command
Purpose
switch# show any-command | exclude pattern
Displays output lines that do not contain the pattern.
switch# show any-command | include pattern
Displays output lines that contain the pattern.
switch# show any-command | include “pattern1|pattern2”
Displays output lines that contain either pattern1 or
pattern2.
Note
The alternation patterns, “pattern1|pattern2”,
must appear within double quotes.
switch# show any-command | include pattern [next
number] [prev number]
Displays output lines that contain the pattern. Optionally,
using the next or prev parameter followed by a number also
displays the designated number of lines.
switch# show any-command | count number
Displays the number lines of output in the display.
You can enter the Ctrl-Z key combination at any time to interrupt the output and return to EXEC mode.
For example, you can enter the show running-config | begin hostname command to start the display of
the running configuration file at the line containing the hostname setting, then use Ctrl-Z when you get
to the end of the information you are interested in capturing. See the “Searching and Filtering CLI
Output Examples” section on page 1-21.
Multiple Filter Commands
Cisco MDS SAN-OS Release 2.1(1a) supports using multiple filters in the same show command output.
This means you can use a combination of the available filters to format the output of any show command.
Cisco MDS 9000 Family Command Reference
1-20
OL-29295-04
Chapter 1
CLI Overview
Searching and Filtering CLI Output
Note
The maximum number of commands allowed is four. For example, you can enter a maximum of three
filter commands or two filter commands and a redirection.
Cisco MDS SAN-OS Release 2.1(1a) also supports both filters and redirection in the same command.
Now you can apply the required filters to the output of any command, and save the output using the file
redirection. See the next section, “Searching and Filtering CLI Output Examples” section on page 1-21.
Searching and Filtering CLI Output Examples
The following is partial sample output of the show running-config | begin EXEC command. It begins
displaying unfiltered output with the first line that contains the pattern vsan.
switch# show running-config | begin vsan
fcdomain fcid persistent vsan 1
fcdomain fcid persistent vsan 2
fcdomain fcid persistent vsan 3
fcdomain fcid persistent vsan 101
fcdomain fcid persistent vsan 102
fcdomain fcid database
vsan 1 wwn 29:00:00:05:30:00:06:ea fcid
vsan 1 wwn 28:0f:00:05:30:00:06:ea fcid
vsan 1 wwn 28:10:00:05:30:00:06:ea fcid
vsan 1 wwn 28:11:00:05:30:00:06:ea fcid
vsan 1 wwn 28:12:00:05:30:00:06:ea fcid
vsan 1 wwn 28:13:00:05:30:00:06:ea fcid
vsan 1 wwn 28:14:00:05:30:00:06:ea fcid
vsan 1 wwn 28:1f:00:05:30:00:06:ea fcid
vsan 1 wwn 28:20:00:05:30:00:06:ea fcid
vsan 1 wwn 21:00:00:e0:8b:05:76:28 fcid
vsan 1 wwn 20:c5:00:05:30:00:06:de fcid
vsan 1 wwn 28:2b:00:05:30:00:06:ea fcid
vsan 1 wwn 28:2d:00:05:30:00:06:ea fcid
vsan 1 wwn 28:2e:00:05:30:00:06:ea fcid
vsan 1 wwn 28:2f:00:05:30:00:06:ea fcid
vsan 1 wwn 28:30:00:05:30:00:06:ea fcid
--More--
0x680000
0x680001
0x680002
0x680003
0x680004
0x680005
0x680006
0x680007
0x680008
0x680100
0x680200
0x680012
0x680013
0x680014
0x680015
0x680016
dynamic
dynamic
dynamic
dynamic
dynamic
dynamic
dynamic
dynamic
dynamic
area dynamic
area dynamic
dynamic
dynamic
dynamic
dynamic
dynamic
The following is partial sample output of the show tech-support EXEC command. It begins displaying
unfiltered output with the first line that contains the string show interface brief.
switch# show tech-support | begin "show interface brief"
-------------------- show interface brief -----------------------------------------------------------------------------------------------Interface Vsan
Admin Admin
Status
FCOT
Oper Oper
Port
Mode
Trunk
Mode Speed Channel
Mode
(Gbps)
------------------------------------------------------------------------------fc4/1
1
FX
-sfpAbsent
---fc4/2
1
FX
-sfpAbsent
---fc4/3
1
FX
-sfpAbsent
---fc4/4
1
FX
-sfpAbsent
---fc4/5
1
FX
-up
swl
F
1
-fc4/6
1
FX
-sfpAbsent
---fc4/7
1
FX
-sfpAbsent
---fc4/8
1
FX
-sfpAbsent
---fc4/9
1
E
on
notConnected
swl
--fc4/10
1
FX
-sfpAbsent
---fc4/11
1
FX
-sfpAbsent
----
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-21
Chapter 1
CLI Overview
Searching and Filtering CLI Output
fc4/12
fc4/13
fc4/14
fc4/15
--More--
1
1
1
1
FX
FX
FX
FX
-----
sfpAbsent
sfpAbsent
sfpAbsent
sfpAbsent
-----
-----
-----
The following is partial sample output of the show running-config | exclude EXEC command. It
excludes any output line that contains the pattern vsan.
switch# show running-config | exclude vsan
version 2.1(1a)
poweroff module 9
fcdomain fcid database
ssm enable feature nasb interface fc4/1-4
ssm enable feature santap module 4
ssm enable feature nasb interface fc9/1-4
ssm enable feature santap interface fc9/5-8
ssm enable feature santap interface fc9/21-28
switchname switch
boot kickstart bootflash:/b2193 sup-1
boot system bootflash:/r2193 sup-1
boot kickstart bootflash:/b2193 sup-2
boot system bootflash:/r2193 sup-2
boot ssi bootflash:/laslc1.bin module 1
boot ssi bootflash:/laslc1.bin module 2
boot ssi bootflash:/laslc1.bin module 3
boot ssi bootflash:/laslc1.bin module 4
boot ssi bootflash:/laslc1.bin module 7
boot ssi bootflash:/laslc1.bin module 8
boot ssi bootflash:/laslc1.bin module 9
line console
speed 38400
--More--
The following is partial sample output of the show interface EXEC command. It includes all output with
the pattern vsan.
switch# show interface | include vsan
Port vsan is 1
Port vsan is 1
Port vsan is 1
Port vsan is 1
Port vsan is 1
Port vsan is 1
[information deleted]
The following is partial sample output of the show interface EXEC command. It includes all output with
the pattern FX plus the next and previous five lines of output.
switch# show interface | include FX next 5 prev 5
fc4/1 is down (SFP not present)
Hardware is Fibre Channel
Port WWN is 20:c1:00:05:30:00:06:de
Admin port mode is FX
Port vsan is 1
Receive data field Size is 2112
Beacon is turned off
5 minutes input rate 0 bits/sec, 0 bytes/sec, 0 frames/sec
5 minutes output rate 0 bits/sec, 0 bytes/sec, 0 frames/sec
-0 transmit B2B credit remaining
fc4/2 is down (SFP not present)
Hardware is Fibre Channel
Cisco MDS 9000 Family Command Reference
1-22
OL-29295-04
Chapter 1
CLI Overview
Searching and Filtering CLI Output
Port WWN is 20:c2:00:05:30:00:06:de
Admin port mode is FX
Port vsan is 1
Receive data field Size is 2112
Beacon is turned off
5 minutes input rate 0 bits/sec, 0 bytes/sec, 0 frames/sec
5 minutes output rate 0 bits/sec, 0 bytes/sec, 0 frames/sec
---More--
The following output of the show running-config EXEC command. It displays the number lines, or
count, of the output.
switch# show running-config | count
214
switch#
The following output of the show interface brief EXEC command. It displays the interfaces where the
administration mode is FX.
switch# show interface brief | include FX
fc4/1
1
FX
-sfpAbsent
fc4/2
1
FX
-sfpAbsent
fc4/3
1
FX
-sfpAbsent
fc4/4
1
FX
-sfpAbsent
fc4/5
1
FX
-up
fc4/6
1
FX
-sfpAbsent
fc4/7
1
FX
-sfpAbsent
fc4/8
1
FX
-sfpAbsent
fc4/10
1
FX
-sfpAbsent
fc4/11
1
FX
-sfpAbsent
fc4/12
1
FX
-sfpAbsent
fc4/13
1
FX
-sfpAbsent
fc4/14
1
FX
-sfpAbsent
fc4/15
1
FX
-sfpAbsent
fc4/16
1
FX
-sfpAbsent
fc4/17
1
FX
-sfpAbsent
fc4/18
1
FX
-sfpAbsent
fc4/19
1
FX
-sfpAbsent
fc4/20
1
FX
-sfpAbsent
fc4/21
1
FX
-sfpAbsent
fc4/22
1
FX
-sfpAbsent
fc4/23
1
FX
-sfpAbsent
fc4/24
1
FX
-sfpAbsent
fc4/25
1
FX
-sfpAbsent
fc4/26
1
FX
-sfpAbsent
fc4/27
1
FX
-sfpAbsent
fc4/28
1
FX
-down
fc4/29
1
FX
-sfpAbsent
fc4/30
1
FX
-sfpAbsent
fc4/31
1
FX
-sfpAbsent
fc4/32
1
FX
-sfpAbsent
switch#
----swl
---------------------swl
-----
----F
---------------------------
1
--------------------------------
The following output of the show interface brief EXEC command uses multiple filter commands. It
display the number of interfaces, or count, where the administration mode is FX.
switch# show interface brief | include FX | count
31
switch#
The following show interface brief EXEC command uses multiple filter commands to redirect the
output where the administration mode is FX to the file named test.txt in the directory SavedData.
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-23
Chapter 1
CLI Overview
Searching and Filtering CLI Output
switch# show interface brief | include FX > SavedData\test.txt
switch# cd SavedData
switch# dir
2263
Jan 12 18:53:41 2005 SavedData\test.txt
Usage for volatile://
8192 bytes used
20963328 bytes free
20971520 bytes total
switch#
Displaying Users
The show users command displays all users currently accessing the switch.
switch# show users
admin
pts/7
admin
pts/9
admin
pts/11
Jan 12 20:56 (10.77.202.149)
Jan 12 23:29 (modena.cisco.com)
Jan 13 01:53 (dhcp-171-71-49-49.cisco.com)
Sending Messages to Users
The send command sends a message to all active CLI users currently using the switch. This message is
restricted to 80 alphanumeric characters with spaces.
This example sends a warning message to all active users about the switch being shut down.
switch# send Shutting down the system in 2 minutes. Please log off.
Broadcast Message from admin@excal-112
(/dev/pts/3) at 16:50 ...
Shutting down the system in 2 minutes. Please log off.
Using the ping Command
The ping command verifies the connectivity of a remote host or server by sending echo messages.
The syntax for this command is ping <host or ip address>
switch# ping 171.71.181.19
PING 171.71.181.19 (171.71.181.19): 56 data bytes
64 bytes from 171.71.181.19: icmp_seq=0 ttl=121 time=0.8 ms
64 bytes from 171.71.181.19: icmp_seq=1 ttl=121 time=0.8 ms
--- 171.71.181.19 ping statistics --2 packets transmitted, 2 packets received, 0% packet loss
round-trip min/avg/max = 0.8/0.8/0.8 ms
To abnormally terminate a ping session, type the Ctrl-C escape sequence.
Using traceroute
The traceroute command prints the routes taken by a specified host or IP address.
The syntax for this command is traceroute <host or ip address>
Cisco MDS 9000 Family Command Reference
1-24
OL-29295-04
Chapter 1
CLI Overview
Searching and Filtering CLI Output
switch# traceroute www.cisco.com
traceroute to www.cisco.com (171.71.181.19), 30 hops max, 38 byte packets
1 kingfisher1-92.cisco.com (172.22.92.2) 0.598 ms 0.470 ms 0.484 ms
2 nubulab-gw1-bldg6.cisco.com (171.71.20.130) 0.698 ms 0.452 ms 0.481 ms
3 172.24.109.185 (172.24.109.185) 0.478 ms 0.459 ms 0.484 ms
4 sjc12-lab4-gw2.cisco.com (172.24.111.213) 0.529 ms 0.577 ms 0.480 ms
5 sjc5-sbb4-gw1.cisco.com (171.71.241.174) 0.521 ms 0.495 ms 0.604 ms
6 sjc12-dc2-gw2.cisco.com (171.71.241.230) 0.521 ms 0.614 ms 0.479 ms
7 sjc12-dc2-cec-css1.cisco.com (171.71.181.5) 2.612 ms 2.093 ms 2.118 ms
8 www.cisco.com (171.71.181.19) 2.496 ms * 2.135 ms
To abnormally terminate a traceroute session, enter Ctrl-C.
Setting the Switch Shell Timeout
Use the exec-timeout command in configuration mode to configure the lifetime of all terminal sessions
on that switch. When the time limit configured by this command is exceeded, the shell exits and closes
that session. The syntax for this command form is exec-timeout minutes
The default is 30 minutes. You can configure different timeout values for a console or a virtual terminal
line (VTY) session. You can set the exec-timeout value to 0 to disable this feature so that the session
remains active until you exit the switch. This change is saved in the configuration file.
•
From the console:
switch(config)# line console
switch(config-console)# exec-timeout 60
Specifies the current console shell timeout to be 60 minutes.
•
From a VTY session (Telnet or SSH):
switch(config)# line vty
switch(config-line)# exec-timeout 60
Specifies the current console shell timeout to be 60 minutes.
Displaying VTY Sessions
Use the show line command to display all configured VTY sessions:
switch# show line
line Console:
Speed:
9600 bauds
Databits:
8 bits per byte
Stopbits:
1 bit(s)
Parity:
none
Modem In: Disable
Modem Init-String default : ATE0Q1&D2&C1S0=1\015
Statistics: tx:5558511
rx:5033958
Register Bits:RTS|CTS|DTR|DSR|CD|RI
line Aux:
Speed:
9600 bauds
Databits:
8 bits per byte
Stopbits:
1 bit(s)
Parity:
none
Modem In: Disable
Modem Init-String default : ATE0Q1&D2&C1S0=1\015
Hardware Flowcontrol: ON
Statistics: tx:35
rx:0
Register Bits:RTS|DTR
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-25
Chapter 1
CLI Overview
Searching and Filtering CLI Output
Clearing VTY Sessions
Use the clear line command to close a specified VTY session:
switch# clear line Aux
Setting the Switch Terminal Timeout
Use the terminal session-timeout command in EXEC mode to configure the automatic logout time for
the current terminal session on that switch. When the time limit configured by this command is
exceeded, the switch closes that session and exits.
The syntax for this command form is terminal session-timeout minutes.
The default is 30 minutes. You can set the terminal session-timeout value to 0 to disable this feature so
the terminal remains active until you choose to exit the switch. This change is not saved in the
configuration file.
switch# terminal session-timeout 600
Specifies the terminal timeout to be 600 minutes for the current session.
Setting the Switch Terminal Type
Use the terminal terminal-type command in EXEC mode to specify the terminal type for a switch.
The syntax for this command is terminal terminal-type terminal-type.
switch# terminal terminal-type vt100
Specifies the terminal type. The terminal-type string is restricted to 80 characters and must be a valid
type (for example vt100 or xterm). If a Telnet or SSH session specifies an unknown terminal type, the
switch uses the vt100 terminal by default.
Setting the Switch Terminal Length
To set the terminal screen length for the current session, use the terminal length command in EXEC
mode. This command is specific to only the console port. Telnet and SSH sessions set the length
automatically.
The syntax for this command is terminal length lines.
switch# terminal length 20
Sets the screen length for the current session to 20 lines for the current terminal session. The default is
24 lines.
Setting the Switch Terminal Width
To set the terminal screen width for the current session, use the terminal width command in EXEC
mode. This command is specific to only the console port. Telnet and SSH sessions set the width
automatically.
The syntax for this command is terminal width columns.
Cisco MDS 9000 Family Command Reference
1-26
OL-29295-04
Chapter 1
CLI Overview
Using CLI Variables
switch# terminal width 86
Sets the screen length for the current session to 86 columns for the current terminal session. The default
is 80 columns.
Displaying Terminal Settings
The show terminal command displays the terminal settings for the current session:
switch# show terminal
TTY: Type: “vt100”
Length: 24 lines, Width: 80 columns
Session Timeout: 525600 minutes
Using CLI Variables
The NX-OS CLI parser supports definition and use of variables in CLI commands. CLI variables can be
used as follows:
•
Entered directly on the command line.
•
Passed to the child script initiated using the run-script command. The variables defined in the
parent shell are available for use in the child run-script command process.
•
Passed as command line arguments to the run-script command.
CLI variables have the following characteristics:
•
You cannot reference a variables through another variable using nested references.
•
You can define persistent variables that are available across switch reloads.
•
You can reference only one predefined system variable, the TIMESTAMP variable.
User-Defined CLI Session Variables
You can define CLI variables that persist only for the duration of your CLI session using the cli var name
command in EXEC mode. These CLI variables are useful for scripts that you execute periodically.
The following example shows how to create a user-defined CLI session variables.
switch# cli var name testinterface fc 1/1
You can reference a variable using the syntax $(variable).
The following example shows how to reference a user-defined CLI session variables.
switch# show interface $(testinterface)
fc1/1 is up
Hardware is Fibre Channel, SFP is short wave laser w/o OFC (SN)
Port WWN is 20:01:00:0d:ec:0e:1d:00
Admin port mode is auto, trunk mode is on
snmp traps are enabled
Port mode is F, FCID is 0x01000b
Port vsan is 1
Speed is 2 Gbps
Transmit B2B Credit is 7
Receive B2B Credit is 16
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-27
Chapter 1
CLI Overview
Using CLI Variables
Receive data field Size is 2112
Beacon is turned off
5 minutes input rate 256 bits/sec, 32 bytes/sec, 1 frames/sec
5 minutes output rate 256 bits/sec, 32 bytes/sec, 1 frames/sec
232692 frames input, 7447280 bytes
0 discards, 0 errors
0 CRC, 0 unknown class
0 too long, 0 too short
232691 frames output, 7448692 bytes
0 discards, 0 errors
0 input OLS, 0 LRR, 0 NOS, 0 loop inits
1 output OLS, 1 LRR, 0 NOS, 1 loop inits
16 receive B2B credit remaining
7 transmit B2B credit remaining
Use the show cli var command to display user-defined CLI session variables.
The following example displays user-defined CLI session variables:
switch# show cli variables
VSH Variable List
----------------TIMESTAMP="2005-10-24-21.29.33"
testinterface="fc 1/1"
Use the cli no var name command to remove user-defined CLI session variables.
The following example removes a user-defined CLI session variable:
switch# cli no var name testinterface
User-Defined CLI Persistent Variables
You can define CLI variables that persist across CLI sessions and switch reloads using the cli var name
command in configuration mode. These CLI variables are configured in the configuration mode and are
saved in the running configuration file.
The following example shows how to create a user-defined CLI persistent variables.
switch# config t
switch(config)# cli var name mgmtport mgmt 0
switch(config)# exit
switch#
You can reference a variable using the syntax $(variable).
The following example shows how to reference a user-defined CLI persistent variables.
switch# show interface $(mgmtport)
mgmt0 is up
Hardware is FastEthernet
Address is 000e.38c6.2c6c
Internet address is 10.10.10.1/24
MTU 1500 bytes, BW 100 Mbps full Duplex
288996 packets input, 97746406 bytes
0 multicast frames, 0 compressed
0 input errors, 0 frame, 0 overrun 0 fifo
9089 packets output, 1234786 bytes, 0 underruns
0 output errors, 0 collisions, 0 fifo
0 carrier errors
Use the show cli var command to display user-defined CLI persistent variable.
Cisco MDS 9000 Family Command Reference
1-28
OL-29295-04
Chapter 1
CLI Overview
Using Command Aliases
The following example displays user-defined CLI persistent variables.
switch# show cli variables
VSH Variable List
----------------TIMESTAMP="2005-10-24-21.37.13"
mgmtport="mgmt 0"
Use the no cli var name command in configuration mode to remove user-defined CLI persistent
variables.
The following example removes a user-defined CLI persistent variables.
switch# config t
switch(config)# no cli var name mgmtport
System Defined Variables
Cisco MDS SAN-OS supports one predefined variable: TIMESTAMP. This variable refers to the time of
execution of the command in the format YYYY-MM-DD-HH.MM.SS.
Note
The TIMESTAMP variable name is case sensitive. All letters must be uppercase.
The following example uses $(TIMESTAMP) when periodically gathering statistics into files using the
command scheduler:
switch# config t l
switch(config)# scheduler enable
switch(config)# scheduler logfile size 16
switch(config)# scheduler job name j1
switch(config-job)# show interface mgmt0 | include mgmt > file
switch(config-job)# copy volatile:file bootflash:file.$(TIMESTAMP)
switch(config-job)# end
switch(config)#
The following example uses $(TIMESTAMP) when redirecting show command output to a file:
switch# show running-config > rcfg.$(TIMESTAMP)
Preparing to copy....done
switch# dir volatile:
7231
Oct 03 20:20:42 2005 rcfg.2005-10-03-20.20.42
Usage for volatile://sup-local
8192 bytes used
20963328 bytes free
20971520 bytes total
Using Command Aliases
Command alias support has the following characteristics:
•
Command aliases are global for all user sessions.
•
Command aliases are persist across reboots.
•
Commands being aliased must be typed in full without abbreviation.
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-29
Chapter 1
CLI Overview
About Flash Devices
•
Command alias translation always takes precedence over any keyword in any configuration mode or
submode.
•
Command alias support is only available on the supervisor module, not the switching modules.
•
Command alias configuration takes effect for other user sessions immediately.
•
You cannot override the default command alias alias, which aliases the show cli alias.
•
Nesting of command aliases is permitted to a maximum depth of 1. One command alias can refer to
another command alias that must refer to a valid command, not to another command alias.
•
A command alias always replaces the first command keyword on the command line.
•
You can define command aliases for commands in any configuration submode or the EXEC mode.
Defining Command Aliases
You can define command aliases using the cli alias name command in configuration mode.
This following example shows how to define command aliases:
switch# config t
switch(config)# cli alias name gigint interface gigabitethernet
switch(config)# cli alias name shintbr show interface brief
switch(config)# cli alias name shfcintup "shintbr| include up | include fc"
You can display the command aliases defined on the switch using the alias default command alias.
The following example shows how to display the command aliases defined on the switch:
switch# alias
CLI alias commands
==================
alias
:show cli alias
gigint
:interface gigabitethernet
shintbr
:show interface brief
shfcintup :shintbr | include up | include fc
About Flash Devices
Every switch in the Cisco MDS 9000 Family contains one internal bootflash (see Figure 1-2). The Cisco
MDS 9500 Series switch additionally contains one external CompactFlash called slot0 (see Figure 1-2
and Figure 1-3).
Cisco MDS 9000 Family Command Reference
1-30
OL-29295-04
Chapter 1
CLI Overview
Formatting Flash Disks and File Systems
Figure 1-2
Flash Devices in the Cisco MDS 9000 Supervisor Module
Internal
bootflash
Cisco MDS 9216 Switch
Figure 1-3
External
CompactFlash
Slot 0
Cisco MDS 9500 Series Director
79527
Internal
bootflash
External CompactFlash in the Cisco MDS 9000 Supervisor Module
Internal bootflash:
All switches in the Cisco MDS 9000 Family have one internal bootflash: that resides in the supervisor
or switching module.You have access to two directories within the internal bootflash: file system.
•
The volatile: directory which provides temporary storage, and is also the default. Files in temporary
storage (volatile:) are erased when the switch reboots.
•
The bootflash (nonvolatile storage): directory which provides permanent storage. The files in
bootflash are preserved through reboots and power outages.
External CompactFlash (Slot0)
Cisco MDS 9500 Series directors contain an additional external CompactFlash called slot0:
The external CompactFlash, an optional device for MDS 9500 Series directors, can be used for storing
software images, logs, and core dumps.
Formatting Flash Disks and File Systems
By formatting a flash disk or a file system, you are essentially clearing out the contents of the disk or
the file system and restoring it to its factory-shipped state (see the “About Flash Devices” section on
page 1-30 and “Using the File System” section on page 1-32 for additional information).
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-31
Chapter 1
CLI Overview
Using the File System
Initializing bootflash:
When a switch is shipped, the init system command is already performed and you do not need to enter
it again. Initializing the switch resets the entire internal disk and erases all data in the bootflash:
partition. The internal disk is composed of several file systems with bootflash: being one of them. All
files in bootflash: are erased and you must download the system and kickstart images again. After
entering an init system command, you do not have to format the bootflash: again since bootflash: is
automatically formatted.
Note
The init system command also installs a new loader from the existing (running) kickstart image. You
can access this command from the switch(boot)# prompt.
If bootflash: is found corrupted during a boot sequence, you will see the following message:
ERROR:bootflash: has unrecoverable error; please do “format bootflash:”
Use the format bootflash: command to only format the bootflash: file system. You can enter the format
bootflash: command from either the switch# or the switch(boot)# prompts.
If you enter the format bootflash: command, you must download the kickstart and system images again.
Formatting Slot0:
Be sure to format an external CompactFlash device before using it to save files or images.
You can verify if the external CompactFlash device is formatted by inserting it into slot0: and entering
the dir slot0: command.
•
If the external CompactFlash device is already formatted, you can see file system usage information
(along with any existing files).
•
If the external CompactFlash device is unformatted (corrupted), you will see the following message:
Device unavailable
In this case, you need to format the CompactFlash device using the format slot0: command.
Note
Caution
The slot0: file system cannot be accessed from the standby the loader> prompt or the switch(boot)#
prompt, if the disk is inserted after booting the switch.
The Cisco MDS NX-OS software only supports Cisco-certified CompactFlash devices that are formatted
using Cisco MDS switches. Using uncertified CompactFlash devices may result in unpredictable
consequences; formatting CompactFlash devices using other platforms may result in errors.
Using the File System
The switch provides the following useful functions to help you manage software image files and
configuration files:
•
Setting the Current Directory, page 1-33
Cisco MDS 9000 Family Command Reference
1-32
OL-29295-04
Chapter 1
CLI Overview
Using the File System
•
Displaying the Current Directory, page 1-33
•
Listing the Files in a Directory, page 1-33
•
Creating a New Directory, page 1-34
•
Deleting an Existing Directory, page 1-34
•
Moving Files, page 1-34
•
Copying Files, page 1-35
•
Deleting Files, page 1-35
•
Displaying File Contents, page 1-35
•
Saving Command Output to a File, page 1-36
•
Compressing and Uncompressing Files, page 1-36
•
Displaying the Last Line in a File, page 1-37
•
Executing Commands Specified in a Script, page 1-37
•
Setting the Delay Time, page 1-38
Setting the Current Directory
The cd command changes the current directory level to a specified directory level. CLI defaults to the
volatile: files system. This command expects a directory name input.
Tip
Any file saved in the volatile: file system will be erased when the switch reboots.
The syntax for this command is cd directory name
This example changes the current directory to the mystorage directory that resides in the slot0 directory:
switch# cd slot0:mystorage
This example changes the current directory to the mystorage directory that is in the current directory.
switch# cd mystorage
If the current directory is slot0:mydir, this command changes the current directory to
slot0:mydir/mystorage.
Displaying the Current Directory
The pwd command displays the current directory location. This example changes the directory and
displays the current directory.
switch# cd bootflash:
switch# pwd
bootflash:
Listing the Files in a Directory
The dir command displays the contents of the current directory or the specified directory. The syntax
for this command is dir directory or file name.
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-33
Chapter 1
CLI Overview
Using the File System
This example shows how to list the files on the default volatile: file system:
switch# dir
Usage for volatile: filesystem
0 bytes total used
20971520 bytes free
20971520 bytes available
Creating a New Directory
The mkdir command creates a directory at the current directory level or at a specified directory level.
The syntax for this command is mkdir directory name.
This example creates a directory called test in the slot0 directory:
switch# mkdir slot0:test
This example creates a directory called test at the current directory level.
switch# mkdir test
If the current directory is slot0:mydir, this command creates a directory called
slot0:mydir/test.
Deleting an Existing Directory
The rmdir command deletes an existing directory at the current directory level or at a specified directory
level. The directory must be empty to be deleted.
The syntax for this command is rmdir directory name.
This example deletes the directory called test in the slot0 directory:
switch# rmdir slot0:test
This example deletes the directory called test at the current directory level:
switch# rmdir delete
If the current directory is slot0:mydir, this command deletes the slot0:mydir/test
directory.
Moving Files
The move command removes a file from the source directory and places it in the destination directory.
If a file with the same name already exists in the destination directory, that file is overwritten by the
moved file.
This example moves the file called samplefile from the slot0 directory to the mystorage directory:
switch# move slot0:samplefile slot0:mystorage/samplefile
This example moves a file from the current directory level:
switch# move samplefile mystorage/samplefile
If the current directory is slot0:mydir, this command moves slot0:mydir/samplefile to
slot0:mydir/mystorage/samplefile.
Cisco MDS 9000 Family Command Reference
1-34
OL-29295-04
Chapter 1
CLI Overview
Using the File System
Copying Files
The copy command copies a file.
This example copies the file called samplefile from the external CompactFlash (slot0) directory to the
mystorage directory:
switch# copy slot0:samplefile slot0:mystorage/samplefile
This example copies a file from the current directory level:
switch# copy samplefile mystorage/samplefile
If the current directory is slot0:mydir, this command copies slot0:mydir/samplefile to
slot0:mydir/mystorage/samplefile.
You can also use the copy command to upload and download files from the slot0: or
bootflash: file system to or from a FTP, TFTP, SFTP, or SCP server.
Deleting Files
The delete command deletes a specified file or the specified directory and all its contents.
This example shows how to delete a file from the bootflash: directory (assuming you are already in the
bootflash: directory):
switch# delete dns_config.cfg
This example shows how to delete a file from an external CompactFlash (slot0):
switch# delete slot0:dns_config.cfg
This example deletes the entire my-dir directory and all its contents:
switch# delete bootflash:my-dir
Caution
If you specify a directory, the delete command deletes the entire directory and all its contents.
Displaying File Contents
The show file command displays the contents of a specified file in the file system.
The syntax for this command is show file file_name.
This example displays the contents of the test file that resides in the slot0 directory:
switch# show file slot0:test
config t
Int fc1/1
no shut
end
show int
This example displays the contents of a file residing in the current directory:
switch# show file myfile
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-35
Chapter 1
CLI Overview
Using the File System
Saving Command Output to a File
You can force all screen output to go to a file by appending > filename to any command. For example,
enter show interface > samplefile at the EXEC mode switch prompt to save the interface configuration
to samplefile—a file created at the same directory level. At the EXEC mode switch prompt, enter a dir
command to view all files in this directory, including the recently saved samplefile.
Note
Redirection is allowed only if the current directory is on the volatile: (default) or slot0: file systems.
Redirection is not allowed if the current directory is on the bootflash: file system. The current directory
can be viewed using the pwd command and changed using the cd command.
Directing show Command Output to a File
You can direct show command output to a file, either on the volatile file system, on slot0 CompactFlash
memory, or on a remote server.
The following example shows how to direct the show running-config output to a file on the volatile file
system:
switch1# show running-config > volatile:switch1-run.cfg
The following example shows how to direct the show running-config output to a file on slot0
CompactFlash memory:
switch2# show running-config > slot0:switch2-run.cfg
The following example shows how to direct the show running-config output to a file on a TFTP server:
switch3# show running-config > tftp://10.10.1.1/home/suser/switch3-run.cfg
Preparing to copy...done
Compressing and Uncompressing Files
The gzip command compresses (zips) the specified file using LZ77 coding.
This example directs the output of the show tech-support command to a file (Samplefile) and then zips
the file and displays the difference in the space used up in the volatile: directory:
switch# show tech-support > Samplefile
Building Configuration ...
switch# dir
1525859
Jul 04 00:51:03 2003 Samplefile
Usage for volatile://
1527808 bytes used
19443712 bytes free
20971520 bytes total
switch# gzip volatile:Samplefile
switch# dir
266069
Jul 04 00:51:03 2003 Samplefile.gz
Usage for volatile://
266240 bytes used
20705280 bytes free
20971520 bytes total
The gunzip command uncompresses (unzips) LZ77 coded files.
Cisco MDS 9000 Family Command Reference
1-36
OL-29295-04
Chapter 1
CLI Overview
Using the File System
This example unzips the file that was compressed in the previous example:
switch# gunzip samplefile
/volatile/samplefile.gz: No such file or directory
switch# gunzip Samplefile
switch# dir
1525859
Jul 04 00:51:03 2003 Samplefile
Usage for volatile://
1527808 bytes used
19443712 bytes free
20971520 bytes total
Displaying the Last Line in a File
The tail command displays the last lines (tail end) of a specified file.
The syntax for this command is tail file name [number of lines]
switch# tail mylog 10
You see the last 10 lines of the mylog file.
Executing Commands Specified in a Script
The run-script command executes the commands specified in a file. To use this command, be sure to
create the file and specify commands in the required order.
Note
You cannot create the script files at the switch prompt. You can create the script file on an external
machine and copy it the bootflash: directory. This section assumes that the script file resides in the
bootflash: directory.
The syntax for this command is run-script file_name.
This example displays the CLI commands specified in the test file that resides in the slot0 directory:
switch# show file slot0:testfile
conf t
interface fc 1/1
no shutdown
end
sh interface fc1/1
This file output is in response to the run-script command executing the contents in the test file file:
switch# run-script slot0:testfile
'conf t'
Enter configuration commands, one per line. End with CNTL/Z.
'interface fc1/1'
'no shutdown'
'end'
'sh interface fc1/1'
fc1/1 is down (Fcot not present)
Hardware is Fibre Channel
Port WWN is 20:01:00:05:30:00:48:9e
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-37
Chapter 1
CLI Overview
Role-Based CLI
Admin port mode is auto, trunk mode is on
vsan is 1
Beacon is turned off
Counter Values (current):
0 frames input, 0 bytes, 0 discards
0 runts, 0 jabber, 0 too long, 0 too short
0 input errors, 0 CRC, 0 invalid transmission words
0 address id, 0 delimiter
0 EOF abort, 0 fragmented, 0 unknown class
0 frames output, 0 bytes, 0 discards
Received 0 OLS, 0 LRR, 0 NOS, 0 loop inits
Transmitted 0 OLS, 0 LRR, 0 NOS, 0 loop inits
Counter Values (5 minute averages):
0 frames input, 0 bytes, 0 discards
0 runts, 0 jabber, 0 too long, 0 too short
0 input errors, 0 CRC, 0 invalid transmission words
0 address id, 0 delimiter
0 EOF abort, 0 fragmented, 0 unknown class
0 frames output, 0 bytes, 0 discards
Received 0 OLS, 0 LRR, 0 NOS, 0 loop inits
Transmitted 0 OLS, 0 LRR, 0 NOS, 0 loop inits
Setting the Delay Time
The sleep command delays an action by a specified number of seconds.
The syntax for this command is sleep seconds
switch# sleep 30
You will see the switch prompt return after 30 seconds.
This command is useful within scripts. For example, you can create a script called test-script:
switch# show file slot0:test-script
discover scsi-target remote
sleep 10
show scsi-target disk
switch# run-script slot0:test-script
When you execute the slot0:test-script, the switch software executes the discover scsi-target remote
command, and then waits for 10 seconds before executing the show scsi-target disk command.
Role-Based CLI
By default, two roles exist in all switches:
•
Network operator—Has permission to view the configuration.
•
Network administrator—Has permission to execute all commands and to set up to 64 permission
levels based on user roles and groups.
When you execute a command, perform command completion, or obtain contex-sensitive help, the
switch software allows the operation to progress if you have the correct permission as specified in the
description of the command.
Cisco MDS 9000 Family Command Reference
1-38
OL-29295-04
Chapter 1
CLI Overview
Using Valid Formats and Ranges
Using Valid Formats and Ranges
Note
Do not enter ellipsis ( ... ), vertical bar ( | ), less or great ( < > ), bracket ( [ ] ), or braces ( { } ) in
command lines. These characters have special meaning in Cisco MDS SAN-OS text strings.
Some commands require a MAC address, IP address, or IDs that must be designated in a standard format
or given a range. See Table 1-7.
Table 1-7
Valid Formats and Ranges
Address
Description
Valid Format Example
Range
MAC address
6 bytes in hexadecimal format separated by colons
(not case-sensitive) .
00:00:0c:24:d2:Fe
—
IP address
126.2.54.1
32 bytes, written as 4 octets separated by periods
(dotted decimal format) that are made up of a network
section, an optional netmask section, and a host
section.
—
VSAN
Integer that specifies the VSAN.
7
1 to 4093
VLAN
Integer that specifies the VLAN.
11
1 to 4093
Port WWN
(pWWN)
Eight hexadecimal numbers separated by colons (not 12:34:56:78:9A:BC:dE:F1
case-sensitive).
—
Node WWN
(nWWN)
Eight hexadecimal numbers separated by colons (not 12:34:56:78:9A:BC:dE:F1
case-sensitive).
—
LUN
8 bytes in hexadecimal format separated by colons. A 64
minimum of two hex characters are acceptable. The
(100d = 64h)
valid format is hhhh[:hhhh[:hhhh[:hhhh]]].
—
FCID
Six character hexadecimal value prepended by 0x.
0xabc123
—
Domain ID
Integer that specifies the domain.
7
1 to 239
Timers
Integer that specifies timers in milliseconds for
latency, FC time out values (TOV).
100
0 to 2147483647
Switching module
Slot in which the applicable switching module
resides.
1
1 to 15
Switch priority
Integer specifying switch priority.
5
1 to 254
Channel group
Integer that specifies a PortChannel group addition.
1
1 to 100
Fabric Shortest Path Integer that specifies the hold time (in milliseconds)
First (FSPF)
before making FSPF computations.
1000
0 to 65535
Fabric Analyzer
The allowed range for the frame size limit in bytes.
64
64 to 65536
Fabric Analyzer
captures
An example of 10 frames, limits the number of frames 10
captured to 10.
0 to 2147483647
FCIP profile
Integer that specifies the FCIP profile.
1 to 255
101
TCP retransmit time Integer that specifies the minimum retransmit time for 300
the TCP connection in milliseconds
250 to 5000
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-39
Chapter 1
CLI Overview
Using Debug Commands
Table 1-7
Valid Formats and Ranges (continued)
Address
Description
Valid Format Example
Keepalive timeout
Integer that specifies the TCP connection’s keepalive 60
timeout in seconds.
Range
1 to 7200
TCP retransmissions Integer that specifies the maximum number of TCP
transmissions.
6
1 to 8
PMTU
Integer that specifies the path MTU reset time in
seconds.
90
60 to 3600
TCP buffer size
Integer that specifies the advertised TCP buffer size in 5000
KB.
0 to 8192
Traffic burst size
Integer that specifies the maximum burst size in KB. 30
10 to 100
Peer TCP port
Integer that specifies the TCP port number.
3000
0 to 65535
Acceptable time
difference
Integer that specifies the acceptable time difference in 4000
milliseconds for a packet being accepted.
1 to 60,000
iSCSI pWWN
allocation
Integer that specifies the number of pWWNs that
must be allocated to an iSCSI initiator.
1 to 64
CDP refresh and
hold time
Integer that specifies the refresh time interval and the 60
hold time in seconds for the CDP protocol.
2
5 to 255
Using Debug Commands
Caution
Because debugging output is assigned high priority in the CPU process, it can render the system
unusable. For this reason, use debug commands only to troubleshoot specific problems or during
troubleshooting sessions with Cisco technical support staff. Moreover, it is best to use debug commands
during periods of lower network traffic and fewer users. Debugging during these periods decreases the
likelihood that increased debug command processing overhead will affect system use.
All debug commands are entered in privileged EXEC mode, and most debug commands take no
arguments. Use the show debugging command to display the state of each debugging option.
To list and see a brief description of all the debugging command options, enter the command debug ? at
the command line in privileged EXEC mode. For example:
switch# debug ?
Not all debugging commands listed in the debug ? output are described in this document. Commands
are included here based on their usefulness in assisting you to diagnose network problems. Commands
not included are typically used internally by Cisco engineers during the development process and are not
intended for use outside the Cisco environment.
To enable all system diagnostics, enter the debug all command at the command line in privileged EXEC
mode. For example:
switch# debug all
To turn off all diagnostic output, enter the no debug all command at the command line in privileged
EXEC mode. For example:
switch# no debug all
Cisco MDS 9000 Family Command Reference
1-40
OL-29295-04
Chapter 1
CLI Overview
Using Debug Commands
Using the no debug all command is a convenient way to ensure that you have not accidentally left any
debug commands turned on.
Caution
Because debugging output takes priority over other network traffic, and because the debug all command
generates more output than any other debug command, it can severely diminish the performance of the
router or even render it unusable. In virtually all cases, it is best to use more specific debug commands.
Generating debug Command Output
Enabling a debug command can result in output similar to the following example for the debug modem
command:
Router# debug modem
15:25:51:
15:25:51:
15:25:51:
15:27:51:
15:27:51:
15:27:51:
15:27:52:
15:27:52:
15:27:57:
15:27:58:
TTY4:
tty4:
TTY4:
TTY4:
TTY4:
TTY4:
TTY4:
tty4:
TTY4:
TTY4:
DSR came up
Modem: IDLE->READY
Autoselect started
Autoselect failed
Line reset
Modem: READY->HANGUP
dropping DTR, hanging up
Modem: HANGUP->IDLE
restoring DTR
DSR came up
The router continues to generate such output until you enter the corresponding no debug command (in
this case, the no debug modem command).
If you enable a debug command and no output is displayed, consider the following possibilities:
•
The router may not be properly configured to generate the type of traffic you want to monitor. Use
the more system:running-config EXEC command to check its configuration.
•
Even if the router is properly configured, it may not generate the type of traffic you want to monitor
during the particular period that debugging is turned on. Depending on the protocol you are
debugging, you can use commands such as the TCP/IP ping EXEC command to generate network
traffic.
Redirecting debug and Error Message Output
By default, the network server sends the output from debug commands and system error messages to the
console. If you use this default, monitor debug output using a virtual terminal connection, rather than
the console port.
To redirect debug output, use the logging command options within configuration mode as described in
the following sections.
Possible destinations include the console, virtual terminals, internal buffer, and UNIX hosts running a
syslog server. The syslog format is compatible with 4.3 Berkeley Standard Distribution (BSD) UNIX
and its derivatives.
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-41
Chapter 1
CLI Overview
Using Debug Commands
Note
Be aware that the debugging destination you use affects system overhead. Logging to the console
produces very high overhead, whereas logging to a virtual terminal produces less overhead. Logging to
a syslog server produces even less, and logging to an internal buffer produces the least overhead of any
method.
To configure message logging, you need to be in configuration command mode. To enter this mode, use
the configure terminal command at the EXEC prompt.
Enabling Message Logging
To enable message logging to all supported destinations other than the console, enter the following
command:
logging on
The default condition is logging on.
To direct logging to the console only and disable logging output to other destinations, enter the following
command:
no logging on
Setting the Message Logging Levels
You can set the logging levels when logging messages to the following devices:
•
Console
•
Monitor
•
Syslog server
Table 1-8 lists and briefly describes the logging levels and corresponding keywords you can use to set
the logging levels for these types of messages. The highest level of message is level 0, emergencies. The
lowest level is level 7, debugging, which also displays the greatest amount of messages. For information
about limiting these messages, see sections later in this chapter.
Table 1-8
Message Logging Keywords and Levels
Level
Keyword
Description
Syslog Definition
0
emergencies
System is unusable.
LOG_EMERG
1
alerts
Immediate action is needed.
LOG_ALERT
2
critical
Critical conditions exist.
LOG_CRIT
3
errors
Error conditions exist.
LOG_ERR
4
warnings
Warning conditions exist.
LOG_WARNING
5
notification
Normal, but significant, conditions
exist.
LOG_NOTICE
6
informational
Informational messages.
LOG_INFO
7
debugging
Debugging messages.
LOG_DEBUG
Cisco MDS 9000 Family Command Reference
1-42
OL-29295-04
Chapter 1
CLI Overview
Using Debug Commands
Limiting the Types of Logging Messages Sent to the Console
To limit the types of messages that are logged to the console, use the logging console router
configuration command. The full syntax of this command follows:
logging console level
no logging console
The logging console command limits the logging messages displayed on the console to messages up to
and including the specified severity level, which is specified by the level argument. Keywords are listed
in order from the most severe level to the least severe.
The no logging console command disables logging to the console.
The following example sets console logging of messages at the debugging level, which is the least severe
level and which displays all logging messages:
logging console debugging
Logging Messages to an Internal Buffer
The default logging device is the console; all messages are displayed on the console unless otherwise
specified.
To log messages to an internal buffer, use the logging buffered router configuration command. The full
syntax of this command follows:
logging buffered
no logging buffered
The logging buffered command copies logging messages to an internal buffer instead of writing them
to the console. The buffer is circular in nature, so newer messages overwrite older messages. To display
the messages that are logged in the buffer, use the show logging privileged EXEC command. The first
message displayed is the oldest message in the buffer.
The no logging buffered command cancels the use of the buffer and writes messages to the console (the
default).
Limiting the Types of Logging Messages Sent to Another Monitor
To limit the level of messages logged to the terminal lines (monitors), use the logging monitor router
configuration command. The full syntax of this command follows:
logging monitor level
no logging monitor
The logging monitor command limits the logging messages displayed on terminal lines other than the
console line to messages with a level up to and including the specified level argument. To display logging
messages on a terminal (virtual console), use the terminal monitor privileged EXEC command.
The no logging monitor command disables logging to terminal lines other than the console line.
The following example sets the level of messages displayed on monitors other than the console to
notification:
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-43
Chapter 1
CLI Overview
Using Debug Commands
logging monitor notification
Logging Messages to a UNIX Syslog Server
To log messages to a syslog server host, use the logging host global configuration command. The full
syntax of this command follows:
logging host {ip-address | host-name} [xml]
no logging host {ip-address | host-name} [xml]
The logging host command identifies a syslog server host that is to receive logging messages. The
ip-address argument is the IP address of the host. By entering this command more than once, you build
a list of syslog servers that receive logging messages.
The no logging host command deletes the syslog server with the specified address from the list of
syslogs.
Limiting Messages to a Syslog Server
To limit the number of messages sent to syslog servers, use the logging trap router configuration
command. The full syntax of this command follows:
logging trap level
no logging trap
The logging trap command limits the logging messages sent to syslog servers to logging messages with
a level up to and including the specified level argument.
To send logging messages to a syslog server, specify its host address with the logging host command.
The default trap level is informational.
The no logging trap command returns the trap level to the default.
The current software generates the following categories of syslog messages:
•
Error messages at the emergencies level.
•
Error messages at the alerts level.
•
Error messages at the critical level.
•
Error messages about software or hardware malfunctions, displayed at the errors level.
•
Interface up/down transitions and system restart messages, displayed at the notification level.
•
Reload requests and low-process stack messages, displayed at the informational level.
•
Output from the debug commands, displayed at the debugging level.
The show logging privileged EXEC command displays the addresses and levels associated with the
current logging setup. The command output also includes ancillary statistics.
Example of Setting Up a UNIX Syslog Daemon
To set up the syslog daemon on a 4.3 BSD UNIX system, include a line such as the following in the file
/etc/syslog.conf:
local7.debugging /usr/adm/logs/tiplog
Cisco MDS 9000 Family Command Reference
1-44
OL-29295-04
Chapter 1
CLI Overview
Using Debug Commands
The local7 keyword specifies the logging facility to be used.
The debugging keyword specifies the syslog level. See Table 1-8 for other keywords that can be listed.
The UNIX system sends messages at or above this level to the specified file, in this case,
/usr/adm/logs/tiplog. The file must already exist, and the syslog daemon must have permission to write
to it.
For the System V UNIX systems, the line should read as follows:
local7.debug /usr/admin/logs/cisco.log
Cisco MDS 9000 Family Command Reference
OL-29295-04
1-45
Chapter 1
CLI Overview
Using Debug Commands
Cisco MDS 9000 Family Command Reference
1-46
OL-29295-04
CH A P T E R
5
D Commands
The commands in this chapter apply to the Cisco MDS 9000 Family of multilayer directors and fabric
switches. All commands are shown here in alphabetical order regardless of command mode. See “About
the CLI Command Modes” section on page 1-3 to determine the appropriate mode for each command.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-1
Chapter 5
D Commands
data-pattern-file
data-pattern-file
To configure data pattern file for a SAN tuner extension N port, use the data-pattern-file command in
interface configuration submode. To remove data pattern file, use the no form of the command.
data-pattern-file filename
no data-pattern-file
Syntax Description
filename
Defaults
All zero pattern.
Command Modes
SAN extension N port configuration submode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Specifies the data pattern file name.
Usage Guidelines
By default, an all-zero pattern is used as the pattern for data generated by the virtual N ports. You can
optionally specify a file as the data pattern to be generated by selecting a data pattern file from one of
three locations: the bootflash: directory, the volatile: directory, or the slot0: directory. This option is
especially useful when testing compression over FCIP links. You can also use Canterbury corpus or
artificial corpus files for benchmarking purposes.
Examples
The following example configures the data pattern file for an N port:
switch# san-ext-tuner
switch(san-ext)# nWWN 10:00:00:00:00:00:00:00
switch(san-ext)# nport pwwn 12:00:00:00:00:00:00:56 vsan 13 interface gigabitethernet
1/2
switch(san-ext-nport)# data-pattern-file bootflash://DataPatternFile
Related Commands
Command
Description
nport pwwn
Configures SAN extension tuner N port pWWNs.
san-ext-tuner
Enters SAN extension tuner configuration mode.
show san-ext-tuner
Displays SAN extension tuner information.
Cisco MDS 9000 Family Command Reference
5-2
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
deadtime (radius group configuration)
deadtime (radius group configuration)
To configure a periodic time interval where a nonreachable (non-responsive) RADIUS server is
monitored for responsiveness, use the deadtime command in RADIUS group configuration submode.
To disable the monitoring of the nonresponsive server, use the no form of the command.
deadtime time
no deadtime time
Syntax Description
time
Defaults
Zero.
Command Modes
RADIUS group configuration submode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Specifies the time interval (in minutes) for monitoring the server. The time
range is 1 to 1440 minutes.
If the dead time interval for an individual RADIUS server is greater than zero (0), that value takes
precedence over the value set for the server group.
When the dead time interval is 0 minutes, RADIUS server monitoring is not performed unless the
RADIUS server is part of a server group and the dead time interval for the group is greater than 0
minutes.
Examples
The following example shows the deadtime command in RADIUS group configuration submode:
switch# config terminal
switch(config)# aaa group server radius testgroup
switch(config-radius)# deadtime 10
Related Commands
Command
Description
radius-server
deadtime
Sets a time interval for monitoring a nonresponsive RADIUS server.
show radius-server
Displays RADIUS server information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-3
Chapter 5
D Commands
deadtime (tacacs+ group configuration)
deadtime (tacacs+ group configuration)
To configure a periodic time interval where a nonreachable (non responsive) TACACS+ server is
monitored for responsiveness, use the deadtime command in TACACS+ group configuration submode.
To disable the monitoring of the non responsive server, use the no form of the command.
deadtime time
no deadtime time
Syntax Description
time
Defaults
Zero.
Command Modes
TACACS+ group configuration submode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Specifies the time interval (in minutes) for monitoring the server. The time
range is 1 to 1440 minutes.
If the dead time interval for an individual TACACS+ server is greater than zero (0), that value takes
precedence over the value set for the server group.
When the dead time interval is 0 minutes, TACACS+ server monitoring is not performed unless the
TACACS+ server is part of a server group and the dead time interval for the group is greater than 0
minutes.
Examples
The following example shows the deadtime command in TACACS+ group configuration submode:
switch# config terminal
switch(config)# aaa group server tacacs mygroup
switch(config-tacacs)# deadtime 5
Related Commands
Command
Description
show tacacs-server
Displays TACACS+ server information.
tacacs-server
deadtime
Sets a time interval for monitoring a nonresponsive TACACS+ server.
Cisco MDS 9000 Family Command Reference
5-4
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
deadtime (server group configuration mode)
deadtime (server group configuration mode)
To configure deadtime within the context of LDAP server groups, use the deadtime command in server
group configuration mode. To disable this feature, use the no form of the command.
deadtime minutes
no deadtime minutes
Syntax Description-
This command has no arguments or keywords.
Defaults
None.
Command Modes
Server group configuration mode.
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure deadtime within the context of LDAP server groups:
switch(config-ldap)# deadtime minutes
switch(config-ldap)#
Related Commands
Command
Description
show ldap-server
groups
Displays the configured LDAP server groups.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-5
Chapter 5
D Commands
delete
delete
To delete a specified file or directory on a flash memory device, use the delete command in EXEC mode.
delete {bootflash: filename | debug: filename | log: filename | modflash: filename | slot0: filename
| volatile: filename}
Syntax Description
bootflash:
Flash image that resides on the supervisor module.
filename
The name of the file to be deleted.
debug:
Contains the debug files.
log:
Contains the two default logfiles. The file dmesg contains the kernel
log-messages and the file messages contains the system application
log-messages.
modflash:
Flash image that resides on a module.
slot0:
Flash image that resides on another module.
volatile:
Flash image that resides on the volatile file system.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2
This command was introduced.
2.1(1a)
Added debug, log, and modflash keywords.
Usage Guidelines
When you delete a file, the software erases the file.
If you attempt to delete the configuration file or image specified by the CONFIG_FILE or BOOTLDR
environment variable, the system prompts you to confirm the deletion. Also, if you attempt to delete the
last valid system image specified in the BOOT environment variable, the system prompts you to confirm
the deletion.
Caution
Examples
If you specify a directory, the delete command deletes the entire directory and all its contents.
The following example deletes the file named test from the flash card inserted in slot 0:
switch# delete slot0:test
Delete slot0:test? [confirm]
The following example deletes a file from a directory:
Cisco MDS 9000 Family Command Reference
5-6
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
delete
switch# delete dns_config.cfg
The following example deletes a file from an external CompactFlash (slot0):
switch# delete slot0:dns_config.cfg
The following example deletes the entire my-dir directory and all its contents:
switch# delete bootflash:my-dir
The following example deletes the entire user created dk log file on the active supervisor:
switch# delete log://sup-active/
log://sup-active/dk
log://sup-active/dmesg
switch# delete log://sup-active/dk
switch# dir log:
31
Feb 04 18:22:03 2005 dmesg
14223
Feb 04 18:25:30 2005 messages
log://sup-active/messages
Usage for log://sup-local
35393536 bytes used
174321664 bytes free
209715200 bytes total
switch#
Related Commands
Command
Description
cd
Changes the default directory or file system.
dir
Displays a list of files on a file system.
show boot
Displays the contents of the BOOT environment variable, the name of the
configuration file pointed to by the CONFIG_FILE environment variable,
the contents of the BOOTLDR environment variable, and the configuration
register setting.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-7
Chapter 5
D Commands
delete ca-certificate
delete ca-certificate
To delete certificate authority certificates, use the delete ca-certificate command in trust point
configuration submode.
delete ca-certificate
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Trust point configuration submode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Note
This command deletes the CA certificate or certificate chain corresponding to the trust point CA. As a
result, the trust point CA is no longer trusted. If there is an identity certificate form the CA, you should
delete it before attempting to delete the CA certificate. Doing so prevents the accidental deletion of a CA
certificate when you have not yet deleted the identity certificate from that CA. This action may be
necessary when you do not want to trust the CA any more for a reason such as the CA is compromised
or the CA certificate is already expired, with the latter being a very rare event.
The trust point configuration, certificates, and key pair configurations are made persistent only after
saving to the startup configuration. To be consistent with this configuration behavior, the delete behavior
is also the same. That is, the deletions are made persistent only after saving to the startup configuration.
Use the copy running-config startup-config command to make the certificate and key pair deletions
persistent.
Examples
The following example shows how to delete a certificate authority certificate:
switch# config terminal
switch(config)# crypto ca trustpoint admin-ca
switch(config-trustpoint)# delete ca-certificate
Related Commands
Command
Description
delete certificate
Deletes the identity certificate.
delete crl
Deletes the crl from the trustpoint.
Cisco MDS 9000 Family Command Reference
5-8
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
delete certificate
delete certificate
To delete the identity certificate, use the delete certificate command in trust point configuration
submode.
delete certificate [force]
Syntax Description
force
Defaults
None.
Command Modes
Trust point configuration submode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Note
(Optional) Forces the deletion of the identity certificate.
Use this command to delete the identity certificate from the trust point CA. This action may be necessary
when the identity certificate expires or the corresponding key pair is compromised. Applications will be
left without any identity certificate to use after the deletion of the last or the only identity certificate
present. Accordingly, an error message is generated if the certificate being deleted is the last or only
identity certificate present. If needed, the deletion can still be accomplished by forcing it using the force
option.
The trust point configuration, certificates, and key pair configurations are made persistent only after
saving to the startup configuration. To be consistent with this configuration behavior, the delete behavior
is also the same. That is, the deletions are made persistent only after saving to the startup configuration.
Use the copy running-config startup-config command to make the certificate and key pair deletions
persistent.
Examples
The following example shows how to delete the identity certificate:
switch# config terminal
switch(config)# crypto ca trustpoint admin-ca
switch(config-trustpoint)# delete certificate
The following example shows how to force the deletion of the identity certificate:
switch(config-trustpoint)# delete certificate force
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-9
Chapter 5
D Commands
delete certificate
Related Commands
Command
Description
delete ca-certificate
Deletes the certificate authority certificate.
delete crl
Deletes the crl from the trustpoint.
Cisco MDS 9000 Family Command Reference
5-10
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
delete crl
delete crl
To delete the crl from the trustpoint, use the delete crl command in trust point configuration submode.
delete crl
Syntax Description
This command has no argument or keywords.
Defaults
None.
Command Modes
Trust point configuration submode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to delete the crl from the trustpoint:
switch# config terminal
switch(config)# crypto ca trustpoint admin-ca
switch(config-trustpoint)# delete crl
Related Commands
Command
Description
delete ca-certificate
Deletes the certificate authority certificate.
delete certificate
Deletes the identity certificate.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-11
Chapter 5
D Commands
deny (IPv6-ACL configuration)
deny (IPv6-ACL configuration)
To configure deny conditions for an IPv6 access control list (ACL), use the deny command in IPv6-ACL
configuration submode. To remove the conditions, use the no form of the command.
deny {ipv6-protocol-number | ipv6} {source-ipv6-prefix/prefix-length | any | host
source-ipv6-address} {dest-ipv6-prefix/prefix-length | any | host dest-ipv6-address} [log-deny]
deny icmp {source-ipv6-prefix/prefix-length | any | host source-ipv6-address}
{dest-ipv6-prefix/prefix-length | any | host dest-ipv6-address} [icmp-type [icmp-code]]
[log-deny]
deny tcp {source-ipv6-prefix/prefix-length | any | host source-ipv6-address} [source-port-operator
source-port-number | range source-port-number source-port-number]
{dest-ipv6-prefix/prefix-length | any | host dest-ipv6-address} [dest-port-operator
dest-port-number | range dest-port-number dest-port-number] [established] [log-deny]
deny udp {source-ipv6-prefix/prefix-length | any | host source-ipv6-address}
[source-port-operator source-port-number | range source-port-number source-port-number]
{dest-ipv6-prefix/prefix-length | any | host dest-ipv6-address} [dest-port-operator
dest-port-number | range dest-port-number dest-port-number] [log-deny]
no deny {ipv6-protocol-number | ipv6 | icmp | tcp | udp}
Syntax Description
ipv6-protocol-number
Specifies an IPv6 protocol number. The range is 0 to 255.
ipv6
Applies the ACL to any IPv6 packet.
source-ipv6-prefix/
prefix-length
Specifies a source IPv6 network or class of networks. The format is
X:X:X::X/n.
any
Applies the ACL to any source or destination prefix.
host
source-ipv6-address
Applies the ACL to the specified source IPv6 host address. The format is
X:X:X::X.
dest-ipv6-prefix/prefixlength
Specifies a destination IPv6 network or class of networks. The format is
X:X:X::X/n.
host dest-ipv6-address
Applies the ACL to the specified destination IPv6 host address. The format
is X:X:X::X.
log-deny
(Optional) For packets that are dropped, creates an informational log
message about the packet that matches the entry. The message includes the
input interface.
icmp
Applies the ACL to any Internet Control Message Protocol (ICMP) packet.
icmp-type
Specifies an ICMP message type. The range is 0 to 255.
icmp-code
Specifies an ICMP message code. The range is 0 255.
tcp
Applies the ACL to any TCP packet.
source-port-operator
Specifies an operand that compares the source ports of the specified protocol.
The operands are lt (less than), gt (greater than), and eq (equals).
source-port-number
Specifies the port number of a TCP or UDP port. The number can be from 0
to 65535. A range requires two port numbers.
udp
Applies the ACL to any UDP packet.
Cisco MDS 9000 Family Command Reference
5-12
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
deny (IPv6-ACL configuration)
dest-port-operator
Specifies an operand that compares the destination ports of the specified
protocol. The operands are lt (less than), gt (greater than), and eq (equals).
dest-port-operator
Specifies the port number of a TCP or UDP port. The number can be from 0
to 65535. A range requires two port numbers.
range
Specifies a range of ports to compare for the specified protocol.
established
(Optional) Indicates an established connection, which is defined as a packet
whole SYN flag is not set.
Defaults
None.
Command Modes
IPv6-ACL configuration submode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
The following guidelines can assist you in configuring an IPv6-ACL.
•
Caution
Examples
You can apply IPv6-ACLs to VSAN interfaces, the management interface, Gigabit Ethernet
interfaces on IPS modules and MPS-14/2 modules, and Ethernet PortChannel interfaces. However,
if IPv6-ACLs are already configured in a Gigabit Ethernet interface, you cannot add this interface
to a Ethernet PortChannel group.
Do not apply IPv6-ACLs to just one member of a PortChannel group. Apply IPv6-ACLs to the entire
channel group.
•
Use only the TCP or ICMP options when configuring IPv6-ACLs on Gigabit Ethernet interfaces.
•
Configure the order of conditions accurately. Because the IPv6-ACL filters are applied sequentially
to the IP flows, the first match determines the action taken. Subsequent matches are not considered.
Be sure to configure the most important condition first. If no conditions match, the software drops
the packet.
The following example configures an IPv6-ACL called List1, enters IPv6-ACL submode, and adds an
entry to deny TCP traffic from any source address to any destination address:
switch# config terminal
switch(config)# ipv6 access-list List1
switch(config-ipv6-acl)# deny tcp any any
The following example removes a deny condition set for any destination prefix on a specified UDP host:
switch# config terminal
switch(config)# ipv6 access-list List1
switch(config-ipv6-acl)# no deny udp host 2001:db8:200d::4000 any
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-13
Chapter 5
D Commands
deny (IPv6-ACL configuration)
The following example removes the IPv6-ACL called List1 and all its entries:
switch# config terminal
switch(config)# no ipv6 access-list List1
Related Commands
Command
Description
ipv6 access-list
Configures an IPv6 ACL and enters IPv6-ACL configuration submode.
permit
Configures permit conditions for an IPv6 ACL.
Cisco MDS 9000 Family Command Reference
5-14
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
description
description
To configure a description for the Event Manager policy, use the description command.
description policy-description
Syntax Description
policy-description
Defaults
None.
Command Modes
Embedded Event Manager.
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Configures a descriptive string for the policy. The string can be any
alphanumeric string up to 80 characters. Enclose the string in quotation
marks.
Usage Guidelines
None.
Examples
The following example shows how to configure a descriptive string for the policy:
switch# configure terminal
switch(config)# event manager applet eem-applet
switch(config-applet)# description “Monitors interface shutdown.”
switch(config-applet)#
Related Commands
Command
Description
show interface
Displays an interface configuration for a specified interface.
shutdown
Disables and enables an interface.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-15
Chapter 5
D Commands
destination interface
destination interface
To configure a switched port analyzer (SPAN) destination interface, use the destination interface
command in SPAN session configuration submode. To disable this feature, use the no form of the
command.
destination interface {fc slot/port | fc-tunnel tunnel-id}
no destination interface {fc slot/port | fc-tunnel tunnel-id}
Syntax Description
fc slot/port
Specifies the Fibre Channel interface ID at a slot and port.
fc-tunnel tunnel-id
Specifies the Fibre Channel tunnel interface ID.
Defaults
Disabled.
Command Modes
SPAN session configuration submode.
Command History
Release
Modification
6.2(5)
SPAN is supported and RSPAN is not supported in Cisco MDS 9250i
Multiservice Fabric Switch.
1.0(2)
This command was introduced.
1.2(1)
Added the fc-tunnel parameter.
Usage Guidelines
The SPAN destination interface must be configured as SPAN destination port (SD port) mode using the
switchport command before the interface can be associated with SPAN session as a destination
interface.
Examples
The following example shows how to configure an interface as a SPAN destination port (SD port), create
a SPAN session, and then configure the interface fc3/13 as the SPAN destination interface:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# interface fc3/13
switch(config-if)# switchport mode sd
switch(config)# span session 1
switch(config-span)# destination interface fc3/13
switch(config-span)# do show span session 1
switch(config-span)# show span session 1
Session 1 (inactive as destination is down)
Destination is fc3/13
No session filters configured
No ingress (rx) sources
No egress (tx) sources
switch(config-span)#
Cisco MDS 9000 Family Command Reference
5-16
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
destination interface
Related Commands
Command
Description
show span session
Displays specific information about a SPAN session.
source
Configures a SPAN source.
span session
Selects or configures the SPAN session and changes to SPAN
configuration submode.
suspend
Suspends a SPAN session.
switchport
Configures the switch port mode on the Fibre Channel interface.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-17
Chapter 5
D Commands
destination-profile
destination-profile
To configure the attributes of the destination such as the e-mail address or the message level with the
Call Home function, use the destination-profile command in Call Home configuration submode. To
disable this feature, use the no form of the command.
destination-profile {profile-name | XML-destination | full-txt-destination |
short-txt-destination} {alert-group {all | cisco-Tac | environmental | inventory | license |
linecard-hardware | rmon | supervisor-hardware | syslog-group-port | system | test}} |
{email-addr email-address} | http {https-or-http url} | {message-level message-level} |
{message-size message-size} | {transport-method {email | http}}
no destination-profile {profile-name | XML-destination | full-txt-destination |
short-txt-destination} {alert-group {all | cisco-Tac | environmental | inventory | license |
linecard-hardware | rmon | supervisor-hardware | syslog-group-port | system | test}} |
{email-addr email-address} | http {https-or-http url} | {message-level message-level} |
{message-size message-size} | {transport-method {email | http}}
Syntax Description
profile-name
Specifies a user-defined user profile with a maximum of 32 alphanumeric
characters.
XML-destination
Configures the destination profile for XML messages.
full-txt-destination
Configures the destination profile for plain text messages.
short-txt-destination
Configures the destination for short text messages.
alert-group
Specifies one or more of the alert groups.
all
Specifies an alert group consisting of all Call Home messages.
cisco-Tac
Specifies an alert group consisting of events that are meant only for Cisco
TAC.
environmental
Specifies an alert group consisting of power, fan, and temperature-related
events.
inventory
Specifies an alert group consisting of inventory status events.
license
Specifies an alert group consisting of license status events.
linecard-hardware
Specifies an alert group consisting of module related events.
rmon
Specifies an alert group consisting of RMON status events.
supervisor-hardware
Specifies an alert group consisting of supervisor-related events.
syslog-port-group
Specifies an alert group consisting of syslog port group status events.
system
Specifies an alert group consisting of software-related events.
test
Specifies an alert group consisting of user-generated test events.
email-addr
E-mail transport method.
email-address
Specifies the E-mail address.
http
HTTP transport method.
https-or-http url
Specifies the HTTP or HTTPs URL.
message-level
message-level
Specifies Call Home message level (0 is the lowest urgency, 9 is the highest
urgency).
Cisco MDS 9000 Family Command Reference
5-18
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
destination-profile
message-size
message-size
Configures the maximum message size (default 2500000).
transport-method
Specifies Call Home message-sending transport method.
email
Specifies the e-mail transport method.
http
Specifies the HTTP transport method.
Defaults
None.
Command Modes
Call Home configuration submode.
Command History
Release
Modification
NX-OS 4.2(1)
Deleted Avanti keyword from the syntax description. Added the Usage
guideline.
NX-OS 4.1(3)
Added the HTTPs URL and transport method for syntax description.
1.0(2)
This command was introduced.
Usage Guidelines
The transport method as well as the HTTP URL is distributed only to the switches in the fabric running
images for 4.2(1) and later. The switches running in the lower version images will simply ignore the
HTTP configuration.
The HTTP configuration also will not be distributed to switches that support the HTTP configuration but
do not distribute it.
Examples
The following example shows how to configure XML destination profiles for the HTTP URL:
switch(config-callhome)# destination-profile XML-destination http http://site.service.com
switch(config-callhome)# no destination-profile XML-destination http
http://site.service.com
The following example enables the transport method for destination profile:
switch(config-callhome)#
switch(config-callhome)#
switch(config-callhome)#
switch(config-callhome)#
switch(config-callhome)#
switch(config-callhome)#
destination-profile XML-destination transport-method http
no destination-profile XML-destination transport-method http
destination-profile XML-destination transport-method email
no destination-profile XML-destination transport-method email
The following example shows how to configure full-text destination profiles:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# destination-profile full-txt-destination email-addr
[email protected]
switch(config-callhome)# destination-profile full-txt-destination message-size 1000000
The following example shows how to configure short-text destination profiles:
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-19
Chapter 5
D Commands
destination-profile
switch(config-callhome)# destination-profile short-txt-destination email-addr
[email protected]
switch(config-callhome)# destination-profile short-txt-destination message-size 100000
Related Commands
Command
Description
call home
Configures the Call Home function.
callhome test
Sends a dummy test message to the configured destinations.
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
5-20
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
device-alias (IVR fcdomain database configuration submode)
device-alias (IVR fcdomain database configuration submode)
To map a device alias to a persistent FC ID for IVR, use the device-alias command in IVR fcdomain
database configuration submode. To remove the mapping for the device alias, use the no form of the
command.
device-alias device-name fc-id
no device-alias device-name
Syntax Description
device-name
Specifies the device name. Maximum length is 64 characters.
fc-id
Specifies the FC ID for the device.
Defaults
None.
Command Modes
IVR fcdomain database configuration submode.
Command History
Release
Modification
2.1(2)
This command was introduced.
Usage Guidelines
Only one FC ID can be mapped to a device alias.
Examples
The following example shows how to map the device alias to the persistent FC ID:
switch# config t
switch(config)# ivr fcdomain database autonomous-fabric-num 10 vsan 20
switch(config-fcdomain)# native-autonomous-fabric-num 20 native-vsan 30 domain 15
switch(config-fcdomain-fcid)# device-alias SampleName 0x123456
The following example shows how to remove the mapping between the device alias and the FC ID:
switch# config t
switch(config)# ivr fcdomain database autonomous-fabric-num 10 vsan 20
switch(config-fcdomain)# native-autonomous-fabric-num 20 native-vsan 30 domain 15
switch(config-fcdomain-fcid)# no device-alias SampleName
Related Commands
Command
Description
ivr fcdomain database
autonomous-fabric-num
Creates IVR persistent FC IDs.
native-autonomous-fabric-num
Creates an IVR persistent FC ID database entry.
show ivr fcdomain database
Displays IVR fcdomain database entry information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-21
Chapter 5
D Commands
device-alias (SDV virtual device configuration submode)
device-alias (SDV virtual device configuration submode)
To add a device alias to a virtual device, use the device-alias command in SDV virtual device
configuration submode. To remove a device alias, use the no form of the command.
device-alias device-name [primary]
no device-alias device-name [primary]
Syntax Description
device-name
Specifies the device name. Maximum length is 64 characters.
primary
(Optional) Specifies the device as a primary device.
Defaults
None.
Command Modes
SDV virtual device configuration submode.
Command History
Release
Modification
3.1(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure a virtual target alias name:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# sdv virtual-device name sqa1 vsan 1
switch(config-sdv-virt-dev)# device-alias group1 primary
Related Commands
Command
Description
sdv enable
Enables or disables SAN device virtualization.
show sdv statistics
Displays SAN device virtualization statistics.
Cisco MDS 9000 Family Command Reference
5-22
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
device-alias abort
device-alias abort
To discard a Distributed Device Alias Services (device alias) Cisco Fabric Services (CFS) distribution
session in progress, use the device-alias abort command in configuration mode.
device-alias abort
Syntax Description
This command has no other arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to discard a device alias CFS distribution session in progress:
switch# config terminal
switch(config)# device-alias abort
Related Commands
Command
Description
device-alias database
Configures and activates the device alias database.
device-alias distribute
Enables CFS distribution for device aliases.
show device-alias
Displays device alias information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-23
Chapter 5
D Commands
device-alias commit
device-alias commit
To apply the pending configuration pertaining to the Distributed Device Alias Services (device alias)
Cisco Fabric Services (CFS) distribution session in progress in the fabric, use the device-alias commit
command in configuration mode.
device-alias commit
Syntax Description
This command has no other arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None
Note
Once the device-alias commit is done the running configuration has been modified on all switches
participating in device-alias distribution. You can then use the copy running-config startup-config
fabric command to save the running-config to the startup-config on all the switches in the fabric.
Note
When the device-alias commit is in progress, you must not issue the clear device-alias command, until
the device-alias commit is successful.
Examples
The following example shows how to commit pending changes to the active DPVM database:
switch# config terminal
switch(config)# device-alias commit
Related Commands
Command
Description
device-alias database
Configures and activates the device alias database.
device-alias distribute
Enables CFS distribution for device aliases.
show device-alias
Displays device alias information.
Cisco MDS 9000 Family Command Reference
5-24
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
device-alias confirm-commit enable
device-alias confirm-commit enable
To enable the display of the device-alias pending-diff and subsequent confirmation of pending-diff on
issuing a device-alias commit, use the device-alias confirm-commit enable command in configuration
mode. To disable this feature command, use the no form of this command.
device-alias confirm-commit enable
no device-alias confirm-commit enable
Syntax Description
This command has no other arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(9)
This command was introduced.
Usage Guidelines
Note
Examples
If the device alias confirm-commit command is enabled, on committing the pending database, the pendingdiff is displayed on the console and the user is prompted for Yes or No. If the device-alias confirm-commit
command is disabled, the pending-diff is not displayed and the user is not prompted for Yes or No.
If this feature is enabled, downgrade is blocked by a configuration check. To resume downgrade
correctly, confirm-commit has to be disabled.
The following example shows how to enable the confirm-commit mode for device-alias:
switch# config terminal
switch(config)# device-alias confirm-commit enable
switch(config)#
The following example shows how to disable the confirm-commit mode for device-alias:
switch# config terminal
switch(config)# no device-alias confirm-commit enable
switch(config)#
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-25
Chapter 5
D Commands
device-alias database
device-alias database
To initiate a Distributed Device Alias Services (device alias) session and configure device alias database,
use the device-alias database command.
device-alias database
Syntax Description
This command has no other arguments or keywords.
Defaults
Deactivated.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
The device-alias database command starts a device alias session that locks all the databases on all the
switches in this fabrics. When you exit device alias database configuration submode, the device alias
session ends and the locks are released.
You can only perform all modifications in the temporary device alias database. To make the changes
permanent, use the device-alias commit command.
Examples
The following example shows how to activate a device alias session and enter device alias database
configuration submode:
switch# config terminal
switch(config)# device-alias database
switch(config-device-alias-db)#
Related Commands
Command
Description
device-alias commit
Commits changes to the temporary device alias database to the active device
alias database.
show device-alias
Displays device alias database information.
Cisco MDS 9000 Family Command Reference
5-26
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
device-alias distribute
device-alias distribute
To enable Cisco Fabric Services (CFS) distribution for Distributed Device Alias Services (device alias),
use the device-alias distribute command. To disable this feature, use the no form of the command.
device-alias distribute
no device-alias distribute
Syntax Description
This command has no other arguments or keywords.
Defaults
Enabled.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
Use the device-alias commit command to apply pending changes to the CFS distribution session.
Examples
The following example shows how to enable distribution for device alias information:
switch# config terminal
switch(config)# device-alias distribute
Related Commands
Command
Description
device-alias commit
Commits changes to the active device alias database.
device-alias database
Configures and activates the device alias database.
show device-alias
Displays device alias information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-27
Chapter 5
D Commands
device-alias import fcalias
device-alias import fcalias
To import device alias database information from another VSAN, use the device-alias import fcalias
command. To revert to the default configuration or factory defaults, use the no form of the command.
device-alias import fcalias vsan vsan-id
no device-alias import fcalias vsan vsan-id
Syntax Description
vsan vsan-id
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
Specifies the VSAN ID. The range is 1 to 4093.
You can import legacy device name configurations using this feature without losing data, if they satisfy
the following restrictions:
•
Each fcalias has only one member.
•
The member type is supported by the device name implementation.
If any name conflict exists, the fcaliases are not imported. The device name database is completely
independent from the VSAN dependent fcalias database.
When the import operation is complete, the modified global fcalias table can distributed to all other
switches in the physical fabric using the device-alias distribute command so that new definitions are
available everywhere.
Examples
The following example shows how to import device alias information:
switch# config terminal
switch(config)# device-alias import fcalias vsan 10
Related Commands
Command
Description
device-alias database
Configures and activates the device alias database.
device-alias distribute
Distributes fcalias database changes to the fabric.
show device-alias
Displays device alias database information.
Cisco MDS 9000 Family Command Reference
5-28
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
device-alias mode enhanced
device-alias mode enhanced
To configure device aliases to operate in enhanced mode, use the device-alias mode enhanced
command. To disable this feature, use the no form of the command.
device-alias mode enhanced
no device-alias mode enhanced
Syntax Description
This command has no arguments or keywords.
Defaults
Basic mode.
Command Modes
Configuration mode.
Command History
Release
Modification
3.1(1)
This command was introduced.
Usage Guidelines
When a device alias is configured in basic mode, which is the default mode, all the applications operate
like 3.0 switches. For example, when you attempt to configure the device aliases, immediately the device
alias are expanded to a PWWN. This operation continues until the mode is changed to enhanced.
Whena device alias is configured in enhanced mode, all the applications accept a device alias name in
its native format, instead of expanding the device alias to a PWWN, the device alias name is stored in
the configuration and distributed in its native device alias format.
To use enhanced mode, all switches in the fabric must be running in the Cisco SAN-OS Release 3.1(1)
or later, or NX-OS 4.1(1b) later.
Note
Examples
Enhanced mode, or native device alias based configurations are not accepted in interop mode. VSANs.
IVR zoneset activation will fail in interop mode VSANs if the corresponding zones have native device
alias-based members
The following example shows how to configure the device alias in enhanced mode:
switch# config terminal
switch(config)# device-alias mode enhanced
switch(config)#
Related Commands
Command
Description
device-alias commit
Commits changes to the active device alias database.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-29
Chapter 5
D Commands
device-alias mode enhanced
Command
Description
device-alias database
Configures and activates the device alias database.
show device-alias
Displays device alias information.
Cisco MDS 9000 Family Command Reference
5-30
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
debug ldap
debug ldap
To configure debugging for LDAP, use the debug ldap command. To disable this feature, use the no form
of the command.
debug ldap {aaa-request | aaa-request-lowlevel | all | config | config-lowlevel}
no debug ldap {aaa-request | aaa-request-lowlevel | all | config | config-lowlevel}
Syntax Description
aaa-request
Enables LDAP AAA request debug.
aaa-request-lowlevel
Enables LDAP AAA request low level debugging.
config
Enables LDAP configuration debugging.
config-lowlevel
Enables LDAP configuring low level debugging.
all
Enables all the debug flags.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure LDAP AAA request debug:
switch# debug ldap aaa-request
switch#
The following example shows how to configure LDAP AAA request low level debugging:
switch# debug ldap aaa-request-lowlevel
switch#
Related Commands
Command
Description
show debug
Displays all Cisco SME related debug commands configured on the switch.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-31
Chapter 5
D Commands
device-alias name
device-alias name
To configure device names in the device alias database, use the device-alias name command. To remove
device names from the device alias database, use the no form of the command.
device-alias name device-name pwwn pwwn-id
no device-alias name device-name
Syntax Description
device-name
Specifies the device name. Maximum length is 64 characters.
pwwn pwwn-id
Specifies the pWWN ID. The format is hh:hh:hh:hh:hh:hh:hh:hh, where h
is a hexadecimal number.
Defaults
None.
Command Modes
Device alias database configuration submode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure a device name alias entry in the device name database:
switch# config terminal
switch(config)# device-alias database
switch(config-device-alias-db)# device-alias name Device1 pwwn 21:00:00:20:37:6f:db:bb
Related Commands
Command
Description
device-alias database
Enters device alias database configuration submode.
show device-alias
Displays device alias database information.
Cisco MDS 9000 Family Command Reference
5-32
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
diagnostic bootup level
diagnostic bootup level
To configure the bootup diagnostic level to trigger diagnostics when the device boots, use the diagnostic
bootup level command. To remove this diagnostic bootup level, use the no form of the command.
diagnostic bootup level bypass | complete
no diagnostic bootup level bypass | complete
Syntax Description
bypass
Specifies the skip all bootup test. Do not perform any bootup diagnostics.
complete
Specifies all bootup diagnostics. The default is complete.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure all bootup diagnostics level:
switch# config terminal
switch(config)# diagnostic bootup level complete
switch(config)#
Related Commands
Command
Description
device-alias database
Enters device alias database configuration submode.
show device-alias
Displays device alias database information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-33
Chapter 5
D Commands
diagnostic monitor interval module
diagnostic monitor interval module
To configure diagnostic monitoring tests interval for a module, use the diagnostic monitor interval
module command. To remove this diagnostic monitor interval module, use the no form of the command.
diagnostic monitor interval module module-number test [test-id | name | all] hour hour min
minutes second sec
no diagnostic monitor interval module module-number test [test-id | name | all] hour hour min
minutes second sec
Syntax Description
module-number
Specifies the module number. The range is from 1 to 10.
test
Specifies the diagnostic test selection.
test-id
Specifies test IDs. The range is from 1to 10.
name
Specifies the test name. Can be any case-sensitive alphanumeric string up to
32 characters.
all
Specifies all test ID.
hour
Specifies hour of the day.
hour
Specifies interval in hours. The range is from 0 to 23.
min
Specifies minute of an hour.
minutes
Specifies interval in minutes. The range is from 0 to 59.
second
Specifies second of a minute.
sec
Specifies inteval in seconds. The range is from 0 to 59.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure diagnostic monitoring tests interval for a module:
switch# config terminal
switch(config)# diagnostic monitor interval module 6 test 3 hour 1 min 0 sec 0
switch(config)#
Cisco MDS 9000 Family Command Reference
5-34
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
diagnostic monitor interval module
Related Commands
Command
Description
device-alias database
Enters device alias database configuration submode.
show device-alias
Displays device alias database information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-35
Chapter 5
D Commands
diagnostic monitor module
diagnostic monitor module
To configure diagnostic monitoring tests for a module, use the diagnostic monitor module command.
To remove this diagnostic monitor module, use the no form of the command.
diagnostic monitor module module-number test [test-id | name | all]
no diagnostic monitor module module-number test [test-id | name | all]
Syntax Description
module-number
Specifies the module number. The range is from 1 to 10.
test
Specifies the diagnostic test selection.
test-id
Specifies test IDs. The range is from 1to 10.
name
Specifies the test name. Can be any case-sensitive alphanumeric string up to
32 characters.
all
Specifies all test ID.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure diagnostic monitoring tests for a module:
switch# config terminal
switch(config)# diagnostic monitor module 6 test 3
switch(config)#
Related Commands
Command
Description
device-alias database
Enters device alias database configuration submode.
show device-alias
Displays device alias database information.
Cisco MDS 9000 Family Command Reference
5-36
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
diagnostic ondemand iteration
diagnostic ondemand iteration
To configure the number of times that the on demand test runs, use the diagnostic ondemand iteration
command. To remove this diagnostic ondemand iteration, use the no form of the command.
diagnostic ondemand iteration number
no diagnostic ondemand iteration number
Syntax Description
number
Defaults
1.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(1)
This command was introduced.
Specifies number of times to repeat ondemand test list. The range is from 1
to 999.
Usage Guidelines
None.
Examples
The following example shows how to configure the number of times that the on demand test runs:
switch# diagnostic ondemand iteration 4
switch(config)#
Related Commands
Command
Description
device-alias database
Enters device alias database configuration submode.
show device-alias
Displays device alias database information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-37
Chapter 5
D Commands
diagnostic ondemand action-on-failure
diagnostic ondemand action-on-failure
To configure the action to take if the on demand test fails, use the diagnostic ondemand
action-on-failure command. To remove this feature command, use the no form of the command.
diagnostic ondemand action-on-failure {continue failure-count num-fails | stop}
no diagnostic ondemand action-on-failure {continue failure-count num-fails | stop}
Syntax Description
continue
Specifies the continue ondemand test until test failure limit is reached.
failure-count
Specifies the continue failing tests these many times.
num-fails
The num-fails range is from 1 to 999.
stop
Stop ondemand tests immediately if a test fails.
Defaults
1.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure the action to take if the on demand test fails:
switch# diagnostic ondemand action-on-failure stop
switch#
Related
Commands
Command
Description
device-alias database
Enters device alias database configuration submode.
show device-alias
Displays device alias database information.
Cisco MDS 9000 Family Command Reference
5-38
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
diagnostic start module
diagnostic start module
To start one or more diagnostic tests on a module, use the diagnostic start module command. To remove
this feature command, use the no form of the command.
diagnostic start module module-number test [test-id | name | all | non-disruptive] [port
port-number | all]
no diagnostic start module module-number test [test-id | name | all | non-disruptive] [port
port-number | all]
Syntax Description
module-number
Specifies the module number. The range is from 1 to 10.
test
Specifies the diagnostic test selection.
test-id
Specifies test IDs. The range is from 1 to 10.
name
Specifies the test name. Can be any case-sensitive alphanumeric string up to
32 characters.
all
Specifies all test ID.
non-disruptive
Specifies non disruptive diagnostics.
port
Specifies the port.
port-number
Specfies the port number. The port range is from 1 to 48.
Defaults
1.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to start one or more diagnostic tests on a module:
switch# diagnostic start module 6 test all
switch#
switch#
Related
Commands
Command
Description
device-alias database
Enters device alias database configuration submode.
show device-alias
Displays device alias database information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-39
Chapter 5
D Commands
diagnostic stop module
diagnostic stop module
To stop one or more diagnostic tests on a module, use the diagnostic stop module command. To remove
this feature command, use the no form of the command.
diagnostic stop module slot test [test-id | name | all]
no diagnostic stop module slot test [test-id | name | all]
Syntax Description
module-number
Specifies the module number. The range is from 1 to 10.
test
Specifies the diagnostic test selection.
test-id
Specifies test IDs. The range is from 1to 10.
name
Specifies the test name. Can be any case-sensitive alphanumeric string up to
32 characters.
all
Specifies all test ID.
Defaults
1.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to stop one or more diagnostic tests on a module:
switch# diagnostic stop module 6 test all
switch#
switch#
Related
Commands
Command
Description
device-alias database
Enters device alias database configuration submode.
show device-alias
Displays device alias database information.
Cisco MDS 9000 Family Command Reference
5-40
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
dir
dir
To display the contents of the current directory or the specified directory, use the dir command in EXEC
mode.
dir [bootflash:module | directory-or-filename | debug:directory-or-filename | log:module |
directory-or-filename | modflash:module | directory-or-filename | slot0:directory-or-filename |
volatile:module | directory-or-filename]
Syntax Description
bootflash:
(Optional) Flash image that resides on the supervisor module.
debug:
(Optional) Provides information about the debug capture directory.
log:
(Optional) Provides information about the two default log files. The file
dmesg contains the kernel log messages and the file messages contains the
system application log messages.
modflash:
(Optional) Provides information about the flash image that resides in a
module flash file directory.
slot0:
(Optional) Flash image that resides on another module.
module
(Optional) Module name and number.
directory-or-filename
(Optional) Name of the file or directory to display on a specified device. The
files can be of any type. You can use wildcards in the filename. A wildcard
character (*) matches all patterns. Strings after a wildcard are ignored.
volatile:
(Optional) Flash image on the volatile file system.
Defaults
The default file system is specified by the cd command.
Command Modes
EXEC mode.
Command History
Release
Modification
1.2(1)
This command was introduced.
2.1(1a)
Added debug, log, and modflash keywords.
Usage Guidelines
None.
Examples
The following example shows how to list the files on the bootflash directory:
switch# dir bootflash:
40295206
Aug 05 15:23:51 1980 ilc1.bin
12456448
Jul 30 23:05:28 1980 kickstart-image1
12288
Jun 23 14:58:44 1980 lost+found/
27602159
Jul 30 23:05:16 1980 system-image1
12447232
Aug 05 15:08:30 1980 kickstart-image2
28364853
Aug 05 15:11:57 1980 system-image2
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-41
Chapter 5
D Commands
dir
Usage for bootflash://sup-local
135404544 bytes used
49155072 bytes free
184559616 bytes total
The following example shows how to list the files in the debug directory:
switch# dir debug:
Usage for debug://sup-local
0 bytes used
2097152 bytes free
2097152 bytes total
switch#
The following example shows how to list the files in the log file directory:
switch# dir log:
31
Feb 05 05:00:57 2005
8445
Feb 06 10:34:35 2005
dmesg
messages
Usage for log://sup-local
35196928 bytes used
174518272 bytes free
209715200 bytes total
switch#
Related Commands
Command
Description
cd
Changes the default directory or file system.
delete
Deletes a file on a flash memory device.
Cisco MDS 9000 Family Command Reference
5-42
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
disable
disable
To disable the Call Home function, use the disable command in Call Home configuration submode.
disable
Syntax Description
This command has no other arguments or keywords.
Defaults
None.
Command Modes
Call Home configuration submode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
To enable the Call Home function, use the enable command.
Examples
The following example shows how to disable the Call Home function:
switch# config terminal
Enter configuration commands, one per line.
switch(config)# callhome
switch(config-callhome)# disable
Related Commands
End with CNTL/Z.
Command
Description
callhome
Configures the Call Home function.
callhome test
Sends a dummy test message to the configured destination(s).
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-43
Chapter 5
D Commands
discover
discover
To initiate the discovery of hosts, use the discovery command. To disable this feature, use the no form
of the command.
discover host host port target target port vsan vsan id fabric fabric name
no discover
Syntax Description
host host port
Identifies the host port WWN. The format is hh:hh:hh:hh:hh:hh:hh:hh.
target target port
Identifies the target port WWN. The format is hh:hh:hh:hh:hh:hh:hh:hh.
vsan vsan id
Selects the VSAN identifier. The range is 1 to 4093.
fabric fabric name
Specifies the fabric for discovery.The maximum length is 32 characters.
Defaults
None.
Command Modes
Cisco SME cluster configuration submode.
Command History
Release
Modification
3.2(2)
This command was introduced.
Usage Guidelines
Examples
None.
The following example discovers a host and specifies a target, a VSAN, and a fabric for discovery:
switch# config t
switch(config)# sme cluster clustername1
switch(config-sme-cl)# discover host 20:00:00:00:c9:49:28:47 target
21:01:00:e0:8b:29:7e:0c vsan 2345 fabric sw-xyz
The following example disables the discovery feature:
switch# config t
switch(config)# sme cluster clustername1
switch(config-sme-cl)# no discover
Related Commands
Command
Description
show sme cluster
Displays information about the Cisco SME cluster.
Cisco MDS 9000 Family Command Reference
5-44
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
discover custom-list
discover custom-list
To selectively initiate discovery for specified domain IDs in a VSAN, use the discover custom-list
command in EXEC mode.
discover custom-list {add | delete} vsan vsan-id fcid fc-id
Syntax Description
add
Add a targets to the customized list.
delete
Deletes a target from the customized list.
vsan vsan-id
Discovers SCSI targets for the specified VSAN ID. The range is 1 to 4093.
fcip fc-id
Discovers SCSI targets for the specified FCID. The format is 0xhhhhhhh,
where h is a hexadecimal digit.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
1.1(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example selectively initiates discovery for the specified VSAN and FCID:
switch# discover custom-list add vsan 1 fcid 0X123456
The following example deletes the specified VSAN and FCID from the customized list:
switch# discover custom-list delete vsan 1 fcid 0X123456
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-45
Chapter 5
D Commands
discover scsi-target
discover scsi-target
To discover SCSI targets on local storage to the switch or remote storage across the fabric, use the
discover scsi-target command in EXEC mode.
discover scsi-target {custom-list | local | remote | vsan vsan-id fcid fc-id} os {aix | all | hpux |
linux | solaris | windows} [lun | target]
Syntax Description
custom-list
Discovers SCSI targets from the customized list.
local
Discovers local SCSI targets.
remote
Discovers remote SCSI targets.
vsan vsan-id
Discovers SCSI targets for the specified VSAN ID. The range is 1 to 4093.
fcip fc-id
Discovers SCSI targets for the specified FCID. The format is 0xhhhhhhh,
where h is a hexadecimal digit.
os
Discovers the specified operating system.
aix
Discovers the AIX operating system.
all
Discovers all operating systems.
hpux
Discovers the HPUX operating system.
linux
Discovers the Linux operating system.
solaris
Discovers the Solaris operating system.
windows
Discovers the Windows operating system.
lun
(Optional) Discovers SCSI targets and LUNs.
target
(Optional) Discovers SCSI targets.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(2a)
This command was introduced.
Usage Guidelines
On-demand discovery only discovers Nx ports present in the name server database that have registered
a FC4 Type = SCSI_FCP.
Examples
The following example shows how to discover local targets assigned to all OSs:
switch# discover scsi-target local os all
discovery started
The following example shows how to discover remote targets assigned to the Windows OS:
Cisco MDS 9000 Family Command Reference
5-46
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
discover scsi-target
switch# discover scsi-target remote os windows
discovery started
The following example shows how to discover SCSI targets for the specified VSAN (1) and FCID
(0x9c03d6):
switch# discover scsi-target vsan 1 fcid 0x9c03d6
discover scsi-target vsan 1 fcid 0x9c03d6
VSAN:
1 FCID: 0x9c03d6 PWWN: 00:00:00:00:00:00:00:00
PRLI RSP: 0x01 SPARM: 0x0012...
The following example begins discovering targets from a customized list assigned to the Linux operating
system:
switch# discover scsi-target custom-list os linux
discovery started
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-47
Chapter 5
D Commands
distribute
distribute
To enable distribution of the Call Home function using CFS, use the distribute command in Call Home
configuration submode. To disable this feature, use the no form of the command.
distribute
no distribute
Syntax Description
This command has no other arguments or keywords.
Defaults
None.
Command Modes
Call Home configuration submode.
Command History
Release
Modification
2.0(1b)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable distribution of the Call Home function using CFS:
switch# config terminal
Enter configuration commands, one per line.
switch(config)# callhome
switch(config-callhome)# distribute
Related Commands
End with CNTL/Z.
Command
Description
callhome
Configures the Call Home function.
callhome test
Sends a dummy test message to the configured destination(s).
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
5-48
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
dmm module
dmm module
To specify default DMM values for migration block size, number of migration blocks and fast migration
speed, use the dmm module command in configuration mode.
dmm module mod-id rate-of-migration fast migration-rate medium migration-rate slow
migration-rate
Syntax Description
mod-id
Specifies the module ID.
rate-of-migration
Migration rate can be configured as slow, medium or fast.
fast migration-rate
Specifies the rate for fast migration. Units are megabytes per
second (MB/s).
medium migration-rate
Specifies the rate for medium migration. Units are MB/s.
slow migration-rate
Specifies the rate for slow migration. Units are MB/s.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
3.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to set the fast migration rate to 100 MB/s, the medium migration rate
to 50 MB/s, and slow migration rate to 10 MB/s:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config) dmm module 3 rate_of_migration fast 100 medium 50 slow 10
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-49
Chapter 5
D Commands
dmm module
Related Commands
Command
Description
show dmm ip-peer
Displays a DMM port’s IP peer.
show dmm job
Displays job information.
Cisco MDS 9000 Family Command Reference
5-50
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
dmm module job
dmm module job
To configure a data migration job, use the dmm module mod-id job command in configuration mode.
dmm module mod-id job job-id {create | destroy | finish | get-vi vsan vsan-id | modify rate |
schedule {{hour hour min minute day day month month year year | now |reset}} | session |
set-vi portwwn nodewwn vsan vsan-id | start | stop | validate | verify}
Syntax Description
module mod-id
Specifies the module ID.
job job-id
Specifies the job ID. The range is 0 to18446744073709551615.
create
Creates the job and enters DMM job configuration submode.
destroy
Deletes the DMM job.
finish
Moves the Method 2 data migration job to completed state.
get-vi
Retrieves the virtual initiator (VI) for the DMM job.
vsan vsan-id
Specifies the VSAN ID. The range is 1 to 4093.
modify
Modifies the DMM job attributes.
rate
Specifies the rate of the job attribute. The range is from 1 to 4. Specify 1 for
a default value, 2 for slow, 3 for medium and 4 for fast rates.
schedule
Schedules the DMM job.
hour hour
Specifies the hour the DMM job starts. The range is 0 to 23.
min minute
Specifies the minute the DMM job starts. The range is 0 to 59.
day day
Specifies the day the DMM job starts. The range is 1 to 31.
month month
Specifies the month the DMM job starts. The range is 1 to 12.
year year
Specifies the year the DMM job starts. The range is 2000 to 2030.
now
Resets the schedule to start the DMM job immediately.
reset
Resets the DMM job to unscheduled.
session
Enables the Session Configuration submode.
set-vi
Sets the VI for the storage based job.
portwwn
Specifies the port WWN. The format is hh:hh:hh:hh:hh:hh:hh:hh, where h
is a hexadecimal number.
nodewwn
Specifies the node WWN. The format is hh:hh:hh:hh:hh:hh:hh:hh, where h
is a hexadecimal number.
vsan vsan-id
Specifies the VSAN ID. The range is 1 to 4093.
start
Starts the DMM job session.
stop
Stops the DMM job.
validate
Validates the DMM job data.
verify
Verifies the data migration for the specified job.
Defaults
None.
Command Modes
Configuration mode.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-51
Chapter 5
D Commands
dmm module job
Command History
Usage Guidelines
Release
Modification
NX-OS 4.1(1b)
The set-vi and modify rate keywords were introduced.
3.3(1a)
The finish keyword is introduced.
DMM must be enabled before you can create DMM jobs. Use the ssm enable feature dmm command
to enable DMM.
The data migration job stops executing if it encounters any errors. To restart the migration, enter the
validate command to validate the job configuration, then enter the restart command to restart the job.
Before creating a storage based data migration job, use the show dmm module vi-list command to
choose the VI for migrating the data and then use the set-vi command to specify the VI.
When the job is in the failed state, you can restart the job using the start command. This command will
start the job from point of last failure.
Examples
The following example shows how to restart the job in failed stated.
switch(config)# dmm module 3 job 4 start
switch#
The following example shows how to create a job with a schedule. The job is scheduled to start on
Sunday, January 6, 2008 at 11:00 P.M.
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# dmm module 3 job 1 schedule hour 23 min 0 day 6 month 1 year 2008
Command
Description
show dmm ip-peer
Displays the IP peers that the DMM port is connected to.
show dmm job
Displays DMM job information.
show dmm module vi-list Displays the list of VIs.
Cisco MDS 9000 Family Command Reference
5-52
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
do
do
Use the do command to execute an EXEC-level command from any configuration mode or submode.
do command
Syntax Description
command
Defaults
None.
Command Modes
All configuration modes.
Command History
Release
Modification
1.1(1)
This command was introduced.
NX-OS 4.1(1b)
Added the command output for extended bbcredit interface.
NX-OS 4.1(1b)
Added a note.
Usage Guidelines
Note
Examples
Specifies the EXEC command to be executed.
Use this command to execute EXEC commands while configuring your switch. After the EXEC
command is executed, the system returns to the mode from which you issued the do command.
The receive bbcredit value reflects the extended bbcredit configuration. Extended bbcredit range for
Vegas and ISOLA cards is 256-3500.
The following example shows how to execute the EXEC commands:
switch(config)# port-monitor name cisco
switch(config-port-monitor)# do
switch(config-port-monitor)#
The following example disables the terminal session-timeout command using the do command in
configuration mode:
switch(config)# do terminal session-timeout 0
switch(config)#
The following example creates and enables the interface from configuration mode:
switch(config)# int fc 3/1
switch(config-if)# no shut
The following example shows how to receive the extended bbcredit interface:
switch(config-if)# do show interface fc3/2
fc3/2 is trunking
Hardware is Fiber Channel, SFP is short wave laser w/o OFC (SN)
Port WWN is 20:82:00:05:30:00:2a:1e
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-53
Chapter 5
D Commands
do
Peer port WWN is 20:42:00:0b:46:79:f1:80
Admin port mode is auto, trunk mode is on
Port mode is TE
Port vsan is 1
Speed is 2 Gbps
Transmit B2B Credit is 255
Receive B2B Credit is 1500
Receive data field Size is 2112
Beacon is turned off
Trunk vsans (admin allowed and active) (1-10)
Trunk vsans (up)
(1-10)
Trunk vsans (isolated)
()
Trunk vsans (initializing)
()
5 minutes input rate 504 bits/sec, 63 bytes/sec, 0 frames/sec
5 minutes output rate 344 bits/sec, 43 bytes/sec, 0 frames/sec
69390 frames input, 4458680 bytes
0 discards, 0 errors
0 CRC, 0 unknown class
0 too long, 0 too short
69458 frames output, 3086812 bytes
0 discards, 0 errors
2 input OLS, 1 LRR, 0 NOS, 2 loop inits
1 output OLS, 1 LRR, 1 NOS, 1 loop inits
Cisco MDS 9000 Family Command Reference
5-54
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
dpvm abort
dpvm abort
To discard a dynamic port VSAN membership (DPVM) Cisco Fabric Services (CFS) distribution session
in progress, use the dpvm abort command in configuration mode.
dpvm abort
Syntax Description
This command has no other arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, DPVM must be enabled using the dpvm enable command.
Examples
The following example shows how to discard a DPVM CFS distribution session in progress:
switch# config terminal
switch(config)# dpvm abort
Related Commands
Command
Description
dpvm database
Configures the DPVM database.
dpvm distribute
Enables CFS distribution for DPVM.
dpvm enable
Enables DPVM.
show dpvm
Displays DPVM information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-55
Chapter 5
D Commands
dpvm activate
dpvm activate
To activate the dynamic port VSAN membership (DPVM) configuration database, use the dpvm
activate command. To deactivate the DPVM configuration database, use the no form of the command.
dpvm activate [force]
no dpvm activate [force]
Syntax Description
force
Defaults
Deactivated.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
(Optional) Forces the activation or deactivation if conflicts exist between the
configured DPVM database and the active DPVM database.
To use this command, DPVM must be enabled using the dpvm enable command.
Activation might fail if conflicting entries are found between the configured DPVM database and the
currently activated DPVM database. You can ignore the conflicts using the force option.
Examples
The following example shows how to activate the DPVM database:
switch# config terminal
switch(config)# dpvm activate
The following example shows how to deactivate the DPVM database:
switch# config terminal
switch(config)# no dpvm activate
Related Commands
Command
Description
dpvm database
Configures the DPVM database.
dpvm enable
Enables DPVM.
show dpvm
Displays DPVM database information.
Cisco MDS 9000 Family Command Reference
5-56
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
dpvm auto-learn
dpvm auto-learn
To enable the automatic learning feature (autolearn) for the active dynamic port VSAN membership
(DPVM) database, use the dpvm auto-learn command. To disable this feature, use the no form of the
command.
dpvm auto-learn
no dpvm auto-learn
Syntax Description
This command has no other arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, DPVM must be enabled using the dpvm enable command.
When autolearn is enabled, the system automatically creates the DPVM database by learning about
devices currently logged or newly logged devices with a VSAN. This is a quick way to create the DPVM
which can later be edited. Autolearn features include the following:
Examples
•
An autolearned entry is created by adding the device PWWN and VSAN to the active DPVM
database.
•
The active DPVM database must be present when autolearning is enabled.
•
Autolearned entries can be deleted from the active DPVM database by the user until autolearning is
disabled. Autolearned entries are not permanent in the active DPVM database until autolearning is
disabled.
•
If a device logs out when autolearning is enabled, the device entry is deleted from the active DPVM
database.
•
If a particular device logs into the switch multiple times through different ports, then only the VSAN
corresponding to last login is associated with the device.
•
Autolearn entries do not override previously configured activate entries.
The following example shows how to enable autolearning for the DPVM database:
switch# config terminal
switch(config)# dpvm auto-learn
The following example shows how to disable autolearning for the DPVM database:
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-57
Chapter 5
D Commands
dpvm auto-learn
switch# config terminal
switch(config)# no dpvm auto-learn
Related Commands
Command
Description
dpvm enable
Enables DPVM.
show dpvm
Displays DPVM database information.
Cisco MDS 9000 Family Command Reference
5-58
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
dpvm commit
dpvm commit
To apply the pending configuration pertaining to the dynamic port VSAN membership (DPVM) Cisco
Fabric Services (CFS) distribution session in progress in the fabric, use the dpvm commit command.
dpvm commit
Syntax Description
This command has no other arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, DPVM must be enabled using the dpvm enable command.
Examples
The following example shows how to commit changes to the DPVM database:
switch# config terminal
switch(config)# dpvm commit
Related Commands
Command
Description
dpvm distribute
Enables CFS distribution for DPVM.
dpvm enable
Enables DPVM.
show dpvm
Displays DPVM information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-59
Chapter 5
D Commands
dpvm database
dpvm database
To activate and configure the dynamic port VSAN membership (DPVM) database, use the dpvm
database command. To deactivate the database, use the no form of the command.
dpvm database
no dpvm database
Syntax Description
This command has no other arguments or keywords.
Defaults
Deactivated.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, DPVM must be enabled using the dpvm enable command.
The DPVM database consists of a series of device mapping entries. Each entry consists of device pWWN
or nWWN along with the dynamic VSAN to be assigned. Use the nwwn command or pwwn command
to add the entries to the DPVM database. This database is global to the whole switch (and fabric) and is
not maintained for each VSAN.
Examples
The following example shows how to activate the DPVM database and enter DPVM database
configuration submode:
switch# config terminal
switch(config)# dpvm database
switch#(config-dpvm-db)#
The following example shows how to activate the DPVM database and enter nWWN device:
switch#(config-dpvm-db)# nwwn 14:21:30:12:63:39:72:81 vsan 101
Successful. Commit should follow for command to take effect.
excal-178(config-dpvm-db)#
The following example shows how to activate the DPVM database and enter pWWN device:
switch#(config-dpvm-db)# pwwn 14:21:30:12:63:39:72:81 vsan 101
Successful. Commit should follow for command to take effect.
switch#(config-dpvm-db)#
Cisco MDS 9000 Family Command Reference
5-60
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
dpvm database
Related Commands
Command
Description
dpvm enable
Enables DPVM.
nwwn (DPVM database
configuration submode)
Adds entries to the DPVM database using the nWWN.
pwwn (DPVM database
configuration submode)
Adds entries to the DPVM database using the pWWN.
show dpvm
Displays DPVM database information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-61
Chapter 5
D Commands
dpvm database copy active
dpvm database copy active
To copy the active dynamic port VSAN membership (DPVM) database to the config DPVM database,
use the dpvm database copy active command.
dpvm database copy active
Syntax Description
This command has no other arguments or keywords.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, DPVM must be enabled using the dpvm enable command.
The following circumstances may require the active database to be copied to the config database:
Note
Examples
•
When the autolearned entries are only added to the active database.
•
When the config database or entries in the config database are accidently deleted.
If you want to copy the DPVM database and fabric distribution is enabled, you must first commit the
changes.
The following example shows how to copy the active DPVM database to the config DPVM database:
switch# dpvm database copy active
Related Commands
Command
Description
dpvm enable
Enables DPVM.
show dpvm
Displays DPVM database information.
Cisco MDS 9000 Family Command Reference
5-62
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
dpvm database diff
dpvm database diff
To display the active dynamic port VSAN membership (DPVM) database, use the dpvm database diff
command.
dpvm database diff {active | config}
Syntax Description
active
Displays differences in the DPVM active database compared to the DPVM
config database.
config
Displays differences in the DPVM config database compared to the DPVM
active database.
Defaults
Deactivated.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, DPVM must be enabled using the dpvm enable command.
Examples
The following example displays the differences in the DPVM active database when compared with the
DPVM config database:
switch# dpvm database diff active
Legend: “+” New Entry, “-” Missing Entry, “*” Possible Conflict Entry
--------------------------------------------------------------------- pwwn 44:22:33:44:55:66:77:88 vsan 44
* pwwn 11:22:33:44:55:66:77:88 vsan 11
The following example displays the differences in the DPVM config database when compared with the
DPVM active database:
switch# dpvm database diff config
Legend: “+” New Entry, “-” Missing Entry, “*” Possible Conflict Entry
--------------------------------------------------------------------- pwwn 44:22:33:44:55:66:77:88 vsan 44
* pwwn 11:22:33:44:55:66:77:88 vsan 11
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-63
Chapter 5
D Commands
dpvm database diff
Related Commands
Command
Description
dpvm enable
Enables DPVM.
show dpvm
Displays DPVM database information.
Cisco MDS 9000 Family Command Reference
5-64
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
dpvm distribute
dpvm distribute
To enable Cisco Fabric Services (CFS) distribution for dynamic port VSAN membership (DPVM), use
the dpvm distribute command. To disable this feature, use the no form of the command.
dpvm distribute
no dpvm distribute
Syntax Description
This command has no other arguments or keywords.
Defaults
Enabled.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, DPVM must be enabled using the dpvm enable command.
Temporary changes to the DPVM database must be committed to the active DPVM database using the
dpvm commit command before being distributed to the fabric.
Examples
The following example shows how to disable distribution for the DPVM database:
switch# config terminal
switch(config)# no dpvm distribute
The following example shows how to enable distribution for the DPVM database:
switch# config terminal
switch(config)# dpvm distribute
Related Commands
Command
Description
dpvm enable
Enables DPVM.
show dpvm
Displays DPVM information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-65
Chapter 5
D Commands
dpvm enable
dpvm enable
To enable dynamic port VSAN membership (DPVM), use to dpvm enable command. To disable DPVM,
use the no form of the command.
dpvm enable
no dpvm enable
Syntax Description
This command has no other arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
NX-OS 4.1(1b)
This command was deprecated.
Usage Guidelines
The configuration and verification commands for DPVM are only available when DPVM is enabled on
the switch. When you disable this feature, all related configurations are automatically discarded.
Examples
The following example shows how to enable DPVM:
switch# config terminal
switch(config)# dpvm enable
Related Commands
Command
Description
dpvm activate
Activates the DPVM database.
dpvm database
Configures the DPVM database.
show dpvm
Displays DPVM database information.
Cisco MDS 9000 Family Command Reference
5-66
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
dpvm overwrite-duplicate-pwwn
dpvm overwrite-duplicate-pwwn
To overwrite the first login information with the duplicate PWWN login, use the dpvm
overwrite-duplicate-pwwn command.
dpvm overwrite-duplicate-pwwn
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 4.1(1b)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to overwrite the DPVM duplicate PWWN login:
switch#(config)# dpvm overwrite-duplicate-pwwn
switch#(config)#
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-67
Chapter 5
D Commands
dscp
dscp
To configure a differentiated services code point (DSCP) in a QoS policy map class, use the dscp
command in EXEC mode. To disable this feature, use the no form of the command.
dscp value
no dscp value
Syntax Description
value
Defaults
The default DSCP value is 0.
Command Modes
QoS policy map class configuration submode.
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
Examples
Configures the DSCP value. The range is 0 to 63. DSCP value 46 is reserved.
Before you can configure a QoS policy map class you must complete the following:
•
Enable the QoS data traffic feature using the qos Enable command.
•
Configure a QoS class map using the qos Class-map command.
•
Configure a QoS policy map using the qos Policy-map command.
•
Configure a QoS policy map class using the class command.
The following example configures a DSCP value of 56 in QoS policy classMap1:
switch(config-pmap)# class classMap1
switch(config-pmap-c)# dscp 56
switch(config-pmap-c)#
Related Commands
Command
Description
class
Configure a QoS policy map class.
qos class-map
Configures a QoS class map.
qos enable
Enables the QoS data traffic feature on the switch.
qos policy-map
Configure a QoS policy map.
show qos
Displays the current QoS settings.
Cisco MDS 9000 Family Command Reference
5-68
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 5
D Commands
duplicate-message throttle
duplicate-message throttle
To enable throttling of duplicate Call Home alert messages, use the duplicate-message throttle
command in Call Home configuration submode. To disable this feature, use the no form of the command.
duplicate-message throttle
no duplicate-message throttle
Syntax Description
This command has no other arguments or keywords.
Defaults
Enabled.
Command Modes
Call Home configuration submode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
The rate of throttling is a maximum of thirty messages in 2 hours.
Examples
The following example shows how to enable throttling of duplicate Call Home alert messages:
switch# config terminal
switch(config)# callhome
switch(config-callhome)# duplicate-message throttle
Related Commands
Command
Description
callhome
Configures the Call Home function.
callhome test
Sends a dummy test message to the configured destination(s).
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
5-69
Chapter 5
D Commands
duplicate-message throttle
Cisco MDS 9000 Family Command Reference
5-70
OL-29295-04, Cisco MDS NX-OS Release 6.x
CH A P T E R
6
Debug Commands
The commands in this chapter apply to the Cisco MDS 9000 Family of multilayer directors and fabric
switches. All debug commands are issued in EXEC mode and are shown here in alphabetical order. For
more information, refer to the Cisco MDS 9000 Family NX-OS Troubleshooting Guide and the Cisco
MDS 9000 Family NX-OS System Messages Reference.
Using the CLI, you can enable debugging modes for each switch feature and view a real-time updated
activity log of the control protocol exchanges. Each log entry is time-stamped and listed in chronological
order. Access to the debug feature can be limited through the CLI roles mechanism and can be
partitioned on a per-role basis.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-1
Chapter 6
Debug Commands
debug aaa
debug aaa
To enable debugging for boot variables, use the debug aaa command in EXEC mode. To disable a debug
command, use the no form of the command or use the no debug all command to turn off all debugging.
debug aaa {all | conf-events | errors | events | mts}
no debug aaa {all | conf-events | errors | events | mts}
Syntax Description
all
Enables all AAA debug options.
conf-events
Enables AAA configuration events debugging.
errors
Enables debugging for AAA errors.
events
Enables debugging for AAA events.
mts
Enables AAA transmit and receive MTS packets debugging.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modifications
1.3(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug aaa conf-events command is issued:
switch# debug aaa conf-events
Nov 20 06:29:52 aaa: aaa_cleanup_session
Nov 20 06:29:52 aaa: mts_drop of request msg
Nov 20 06:29:52 aaa: Configured method local Succeeded
Nov 20 06:29:58 aaa: Src: 0x00000101/10886 Dst: 0x00000101/0 ID: 0x003
ize: 197 [REQ] Opc: 8402 (MTS_OPC_AAA_REQ) RR: 0x003A48F7 HA_SEQNO: 0x0
TS: 0x9FC1C1234E7C REJ:0 SYNC:0
Nov 20 06:29:58 aaa: 01 01 0C 00 00 00 00 00 00 00 00 00 00 00 02 01
Nov 20 06:29:58 aaa: 00 00 00 00 00 00 00 06 08 00 03 05 00 00 00 00
Nov 20 06:29:58 aaa: 08 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Nov 20 06:29:58 aaa: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Nov 20 06:29:58 aaa: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Nov 20 06:29:58 aaa: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Nov 20 06:29:58 aaa: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Nov 20 06:29:58 aaa: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Nov 20 06:29:58 aaa: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Nov 20 06:29:58 aaa: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Cisco MDS 9000 Family Command Reference
6-2
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug aaa
Related Commands
Command
Description
aaa authentication
login
Configures the authentication mode for a login.
no debug all
Disables all debugging.
show aaa
authentication
Displays the configured authentication methods.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-3
Chapter 6
Debug Commands
debug all
debug all
To enable debugging for all features on the switch, use the debug all command in EXEC mode. To
disable this command and turn off all debugging, use the no form of the command.
debug all
no debug all
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Caution
Examples
The no debug all command turns off all diagnostic output. Using the no debug all command is a
convenient way to ensure that you have not accidentally left any debug commands turned on.
Because debugging output takes priority over other network traffic, and because the debug all command
generates more output than any other debug command, it can severely diminish the performance of the
switch or even render it unusable. In virtually all cases, it is best to use more specific debug commands.
The following example displays the system output when the debug all command is issued:
switch# debug all
Related Commands
Command
Description
show debug
Displays the debug commands configured on the switch.
Cisco MDS 9000 Family Command Reference
6-4
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug biosd
debug biosd
To configure bios_daemon debugging, use the debug biosd command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug biosd all
no debug biosd all
Syntax Description
all
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
2.1(1)
This command was introduced.
Enables all bios_daemon debug options.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug biosd command is issued:
switch# debug biosd
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-5
Chapter 6
Debug Commands
debug bootvar
debug bootvar
To enable debugging for boot variables, use the debug bootvar command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug bootvar {all | errors | events | info | pss}
no debug bootvar {all | errors | events | info | pss}
Syntax Description
all
Enables all boot variable debug options.
errors
Enables debugging for boot variable errors.
events
Enables debugging for boot variable events.
info
Enables debugging for boot variable information.
pss
Enables debugging for boot variable PSS operations.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug bootvar all command is issued:
switch# debug bootvar all
Related Commands
Command
Description
debug all
Enables debugging for all features on the switch.
show boot
Displays the boot variables or modules.
Cisco MDS 9000 Family Command Reference
6-6
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug callhome
debug callhome
To enable debugging for the Call Home function, use the debug callhome command in EXEC mode. To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug callhome {all | events | mts}
no debug callhome {all | events | mts}
Syntax Description
all
Enables debugging for all Call Home features.
events
Enables debugging for all Call Home events.
mts
Enables debugging for all Call Home tx/rx packets of MTS.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Note
Examples
The debug callhome command, when used with the all parameter, displays the troubleshooting
information for both Call Home event traces and a dump of the messaging and transaction service (MTS)
messages that the Call Home function receives.
The debug Call Home function displays event traces for both successful and unsuccessful Call Home
e-mail transmissions.
The following example displays the system output when the debug callhome events command is issued:
switch# debug callhome events
2005-03-09T05:37:21 2005 Mar 9 05:37:21 callhome: filling in name field with Test
2005 Mar 9 05:37:21 callhome: filling in the header list
2005 Mar 9 05:37:21 callhome: filling up the chassis list
2005 Mar 9 05:37:21 callhome: filling up the main body list
2005 Mar 9 05:37:21 callhome: filling up the fru list 2005 Mar 9 05:37:21 callhome:
Entering function do_event_correlation
2005 Mar 9 05:37:21 callhome: getting dest profiles for alert group test
2005 Mar 9 05:37:21 callhome: getting dest profiles for alert group cisco-tac
2005 Mar 9 05:37:21 callhome: Applying the event rule for destination profile full_txt
2005 Mar 9 05:37:21 callhome: Applying the event rule for destination profile short_txt
2005 Mar 9 05:37:21 callhome: Applying the event rule for destination profile xml 2005
Mar 9 05:37:21 callhome: Applying the event rule for destination profile basu
2005 Mar 9 05:37:21 callhome: Exiting function do_event_correlation
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-7
Chapter 6
Debug Commands
debug callhome
2005 Mar 9 05:37:21 callhome: running cli commands for alert name : Test, message id :
1540383426
2005 Mar 9 05:37:21 callhome: process scheduled for running cli commands for alert Test,
message id 1540383426, destination profile basu
2005 Mar 9 05:37:21 callhome: process scheduled for running cli commands for alert Test,
message id 1540383426, destination profile xml
2005 Mar 9 05:37:21 callhome: process scheduled for running cli commands for alert Test,
message id 1540383426, destination profile short_txt
.
The following example displays the system output when the debug callhome mts command is issued:
switch# debug callhome mts
Apr 8 13:09:42 callhome: Src: 0x00000501/4067 Dst: 0x00000501/66 ID: 0x0004FA
0D Size: 252 [REQ] Opc: 182 (MTS_OPC_DEBUG_WRAP_MSG) RR: 0x0004FA0D HA_SEQNO:
0x00000000 TS: 0x86708AFE37B REJ:0
Apr 8 13:09:42 callhome: 00 00 00 00 06 00 00 00 00 00 00 00 00 00 00 00
Apr 8 13:09:42 callhome: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 8 13:09:42 callhome: 00 00 00 00 00 00 00 00 00 00 00 00 FF FF FF FF
...
Apr 8 13:09:42 callhome: Src: 0x00000501/4067 Dst: 0x00000501/66 ID: 0x0004FA
10 Size: 252 [REQ] Opc: 182 (MTS_OPC_DEBUG_WRAP_MSG) RR: 0x0004FA10 HA_SEQNO:
0x00000000 TS: 0x86708D6A974 REJ:0
Apr 8 13:09:42 callhome: 00 00 00 00 05 00 00 00 00 00 00 00 00 00 00 00
Apr 8 13:09:42 callhome: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 8 13:09:42 callhome: 00 00 00 00 00 00 00 00 00 00 00 00 FF FF FF FF
...
Related Commands
Command
Description
no debug all
Disables all debugging.
show callhome
Displays Call Home information configured on a switch.
Cisco MDS 9000 Family Command Reference
6-8
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug cert-enroll
debug cert-enroll
To enable debugging for the certificate enroll daemon, use the debug cert-enroll command in EXEC
mode. To disable a debug command use the no form of the command or use the no debug all command
to turn off all debugging.
debug cert-enroll {all | config | config-lowlevel | request | request-lowlevel}
no debug cert-enroll {all | config | config-lowlevel | request | request-lowlevel}
Syntax Description
all
Enables all debugging flags.
config
Enables debugging for the certificate enroll configuration.
config-lowlevel
Enables low-level debugging for the certificate enroll configuration.
request
Enables debugging for the certification enroll request.
request-lowlevel
Enables low-level debugging for the certification enroll request.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug cert-enroll all command is issued:
switch# debug cert-enroll all
2006 Jan 21 00:44:52.875125 cert_enroll: cert_en_debug_conf_open: entering...
2006 Jan 21 00:44:52.875602 cert_enroll: cert_en_debug_conf_open: exiting
2006 Jan 21 00:44:52.876284 cert_enroll: cert_en_conf_close: entering...
2006 Jan 21 00:44:52.876349 cert_enroll: cert_en_conf_close: returning 0
2006 Jan 21 00:44:52.876400 cert_enroll: cert_en_enable_info_config: entering for
Cert-enroll Daemon debug
2006 Jan 21 00:44:52.876428 cert_enroll: cert_en_debug_conf_open: entering...
2006 Jan 21 00:44:52.876679 cert_enroll: cert_en_debug_conf_open: exiting
sw-46-180# 2006 Jan 21 00:44:52.876712 cert_enroll: cert_en_enable_info_config:
SET_REQ for Cert-enroll Daemon debug with 1
2006 Jan 21 00:44:52.876857 cert_enroll: cert_en_enable_info_config: SET_REQ done for
Cert-enroll Daemon debug with 1
2006 Jan 21 00:44:52.876896 cert_enroll: cert_en_enable_info_config: got back the return
value of configuration operation:success
2006 Jan 21 00:44:52.876922 cert_enroll: cert_en_debug_conf_close: entering...
2006 Jan 21 00:44:52.876965 cert_enroll: cert_en_debug_conf_close: returning 0
2006 Jan 21 00:44:52.876991 cert_enroll: cert_en_enable_info_config: exiting for
Cert-enroll Daemon debug...
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-9
Chapter 6
Debug Commands
debug cert-enroll
Related Commands
Command
Description
no debug all
Disables all debugging.
show crypto ca
certificates
Displays configured trust point certificates.
Cisco MDS 9000 Family Command Reference
6-10
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug cdp
debug cdp
To enable debugging for the Cisco Discovery Protocol (CDP) function, use the debug cdp command in
EXEC mode. To disable a debug command use the no form of the command or use the no debug all
command to turn off all debugging.
debug cdp {all | errors | events {mts | packets | pss}} [interface {gigabitethernet slot/port | mgmt
0}]
no debug cdp {all | errors | events {mts | packets | pss}} [interface {gigabitethernet slot/port |
mgmt 0}]
Syntax Description
all
Enables debugging for all CDP features.
errors
Enables debugging for CDP error conditions.
events
Enables debugging for CDP events.
mts
Enables debugging for CDP tx/rx MTS packets.
packets
Enables debugging for CDP tx/rx CDP packets.
pss
Enables debugging for all PSS related CDP events.
interface
(Optional) Specifies debugging for the specified interface.
gigbitethernet slot/port
Specifies the Gigabit Ethernet interface slot and port.
mgmt 0
Specifies the management interface.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.1(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug cdp events packets command is
issued:
switch# debug cdp events packets
Apr 8 21:22:34 cdp: Sent CDP packet, interface 0x2380000
Apr 8 21:22:34 cdp: Sent CDP packet, interface 0x2381000
Apr 8 21:22:35 cdp: Sent CDP packet, interface 0x2382000
Apr 8 21:22:35 cdp: Sent CDP packet, interface 0x2383000
Apr 8 21:22:51 cdp: Received CDP packet, interface 0x5000000
Apr 8 21:23:01 cdp: Sent CDP packet, interface 0x5000000
Apr 8 21:23:34 cdp: Sent CDP packet, interface 0x2380000
Apr 8 21:23:34 cdp: Sent CDP packet, interface 0x2381000
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-11
Chapter 6
Debug Commands
debug cdp
Apr
...
Related Commands
8 21:23:35 cdp: Sent CDP packet, interface 0x2382000
Command
Description
no debug all
Disables all debugging.
show cdp
Displays CDP parameters configured globally or for a specific interface.
Cisco MDS 9000 Family Command Reference
6-12
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug cfs
debug cfs
To enable debugging for Cisco Fabric Services (CFS), use the debug cfs command in EXEC mode. To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug cfs {all | errors | events {db [vsan vsan-id] | fc2 [vsan vsan-id] | fsm-action [vsan vsan-id]
| fsm-trans [sap sap-id] | mts [vsan vsan-id] | pss [vsan vsan-id]} | fsm {ha | trans} | merge}
no debug cfs {all | errors | events {db [vsan vsan-id] | fc2 [vsan vsan-id] | fsm-action [vsan
vsan-id] | fsm-trans [sap sap-id] | mts [vsan vsan-id] | pss [vsan vsan-id]} | fsm {ha | trans}
| merge}
Syntax Description
all
Enables all CFS debugging.
errors
Enables debugging for CFS error conditions.
events
Enables debugging for CFS events.
db
Enables debugging for CFS database events.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN ID. The range is 1 to
4093.
fc2
Enables debugging for CFS FC2 events.
fsm-action
Enables debugging for CFS FSM action events.
fsm-trans
Enables debugging for CFS FSM transition events.
sap sap-id
(Optional) Restricts debugging to the specified SAP ID. The range is 0 to
2147483647.
mts
Enables debugging for CFS MTS events.
pss
Enables debugging for CFS PSS events.
fsm
Enables debugging for CFS FSM events.
ha
Enables debugging for CFS FSM high availability events.
trans
Enables debugging for CFS FSM transition events.
merge
Enables debugging for CFS merge events.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-13
Chapter 6
Debug Commands
debug cfs
Examples
The following example displays the system output when the debug cfs all command is issued:
switch# debug cfs all
Related Commands
Command
Description
no debug all
Disables all debugging.
show cfs
Displays CFS information.
Cisco MDS 9000 Family Command Reference
6-14
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug cimserver
debug cimserver
To enable debugging for the Common Information Model (CIM) management applications function, use
the debug cimserver command in EXEC mode. To disable a debug command use the no form of the
command or use the no debug all command to turn off all debugging.
debug cimserver {all | errors | events | mts | trace}
no debug cimserver {all | errors | events | mts | trace}
Syntax Description
all
Enables debugging for all CIM features.
errors
Enables debugging for CIM error conditions.
events
Enables debugging for CIM events.
mts
Enables debugging for CIM tx/rx MTS packets.
trace
Enables debugging for CIM traces.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug cimserver all command is issued:
switch# debug cimserver all
2004 Mar 29 20:05:22 cimsrvprov: cim_mts_dispatch(): Opcode is 182
Related Commands
Command
Description
no debug all
Disables all debugging.
show cimserver
Displays the CIM configurations and settings.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-15
Chapter 6
Debug Commands
debug cloud
debug cloud
To enable debugging of cloud discovery, use the debug cloud command in EXEC mode.To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug cloud {all | bypass ficon_mgr | cloud | conditional | demux vsan vsan-id | deque |
discovery | error | event vsan vsan-id | ha vsan vsan-id | init | member | memory | messages
| remotesync | trace [detail vsan vsan-id | vsan vsan-id] | warning [vsan-id] | xipc}
no debug cloud {all | bypass ficon_mgr | cloud | conditional | demux vsan vsan-id | deque |
discovery | error | event vsan vsan-id | ha vsan vsan-id | init | member | memory | messages
| remotesync | trace [detail vsan vsan-id | vsan vsan-id] | warning [vsan-id] | xipc}
Syntax Description
all
Enables debugging of all features of the cloud.
bypass
Enables some components in cloud execution to be bypassed during
debugging.
ficon_mgr
Enables the FICON manager to be bypassed during debugging.
cloud
Enables debugging of all cloud commands.
conditional
Enables debugging of the cloud discovery conditional service.
demux
Enables debugging of the cloud message demux.
vsan vsan-id
Restricts debugging to the specified VSAN ID. The range is 1 to 4094.
deque
Enables debugging of the cloud message dequeue.
discovery
Enables debugging of the discovery process.
error
Enables debugging of the cloud errors.
event vsan
Enables debugging of the cloud finite state machine (FSM) and events.
ha vsan
Enables debugging of cloud high availability (HA).
init
Enables debugging of cloud discovery initialization.
member
Enables debugging of cloud member changes.
memory
Enables debugging of cloud memory allocation.
messages
Enables debugging of cloud discovery messaging and transaction service
(MTS) messages.
remotesync
Enables debugging of discovery remote sync.
trace
Enables debugging of the cloud trace.
detail
(Optional) Enables debugging of the cloud detailed trace.
warning
Enables debugging of cloud warnings.
xipc
Enables debugging of XIPC messages.
Defaults
None.
Command Modes
EXEC mode.
Cisco MDS 9000 Family Command Reference
6-16
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug cloud
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays system output from the debug cloud all command:
switch# debug cloud all
1980 Feb 15 22:03:41.650721 cloud: fu_fsm_execute_all: match_msg_id(0), log_alre
ady_open(0)
1980 Feb 15 22:03:41.650874 cloud: fu_fsm_execute_all: null fsm_event_list
1980 Feb 15 22:03:41.650956 cloud: fu_fsm_engine_post_event_processing: mts msg
MTS_OPC_DEBUG_WRAP_MSG(msg_id 1302150) dropped
1980 Feb 15 22:03:41.651000 cloud: cloud_deque
Related Commands
Command
Description
no debug all
Disables all debugging.
show cloud discovery
Displays cloud discovery information.
show cloud membership
Displays information about members of the cloud.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-17
Chapter 6
Debug Commands
debug core
debug core
To enable core daemon debugging, use the debug core command in EXEC mode. To disable a debug
command use the no form of the command or use the no debug all command to turn off all debugging.
debug core {error | flow}
no debug core {error | flow}
Syntax Description
error
Enables debugging for core demon error conditions.
flow
Enables debugging for the core demon flow.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug core flow command is issued:
switch# debug core flow
Related Commands
Command
Description
no debug all
Disables all debugging.
show cores
Displays all the cores presently available for upload from active supervisor.
Cisco MDS 9000 Family Command Reference
6-18
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug device-alias
debug device-alias
To enable debugging for device aliases, use the debug device-alias command in EXEC mode. To disable
a debug command use the no form of the command or use the no debug all command to turn off all
debugging.
debug device-alias {all | database {detail | errors | events} | fsm | ha | import {errors | events} |
merge {errors | events | packets} | pss {errors | events} | session {errors | events | packets}
| trace}
no debug device-alias {all | database {detail | errors | events} | fsm | ha | import {errors | events}
| merge {errors | events | packets} | pss {errors | events} | session {errors | events | packets}
| trace}
Syntax Description
all
Enables all device alias debugging.
database
Enables debugging for device alias database events.
detail
Enables detailed debugging for device alias database events.
errors
Enables debugging for device alias error conditions.
events
Enables debugging for device alias events.
fsm
Enables debugging for device alias FSM events.
ha
Enables debugging for device alias HA events.
import
Enables debugging for device alias imports.
merge
Enables debugging for device alias merges.
packets
Enables debugging for device alias packets.
pss
Enables debugging for device alias PSS.
session
Enables debugging for device alias sessions.
trace
Enables debugging for device alias traces.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug device-alias all command is issued:
switch# debug device-alias all
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-19
Chapter 6
Debug Commands
debug device-alias
Related Commands
Command
Description
no debug all
Disables all debugging.
show device-alias
Displays device alias information.
Cisco MDS 9000 Family Command Reference
6-20
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug dpvm
debug dpvm
To enable debugging for dynamic port VSAN membership (DPVM), use the debug dpvm command in
EXEC mode. To disable a debug command use the no form of the command or use the no debug all
command to turn off all debugging.
debug dpvm {all | cfs-events | change-events | db-events | errors | ftrace | merge-event |
mts-events | pss-events | session-events | snmp-events | sys-events}
no debug dpvm {all | cfs-events | change-events | db-events | errors | ftrace | merge-event |
mts-events | pss-events | session-events | snmp-events | sys-events}
Syntax Description
all
Enables debugging for all DPVM.
cfs-events
Enables debugging for Cisco Fabric Services (CFS).
change-events
Enables debugging for change events.
db-events
Enables debugging for database events.
errors
Enables debugging for error.
ftrace
Enables debugging for function trace.
merge-event
Enables debugging for merge events.
mts-events
Enables debugging for MTS events.
pss-events
Enables debugging for PSS events.
session-events
Enables debugging for session events.
snmp-events
Enables debugging for SNMP events.
sys-events
Enables debugging for system events.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, DPVM must be enabled using the dpvm enable command.
Examples
The following example displays the system output when the debug dpvm all command is issued:
switch# debug dpvm all
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-21
Chapter 6
Debug Commands
debug dpvm
Related Commands
Command
Description
no debug all
Disables all debugging.
show dpvm
Displays DPVM database information.
Cisco MDS 9000 Family Command Reference
6-22
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug dstats
debug dstats
To enable delta statistics debugging, use the debug dstats command in EXEC mode. To disable a debug
command use the no form of the command or use the no debug all command to turn off all debugging.
debug dstats {error | flow}
no debug dstats {error | flow}
Syntax Description
error
Enables debugging for delta statistics error conditions.
flow
Enables debugging for the delta statistics flow.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug dstats flow command is issued:
switch# debug dstats flow
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-23
Chapter 6
Debug Commands
debug ethport
debug ethport
To enable Ethernet port debugging, use the debug ethport command in EXEC mode. To disable a debug
command, use the no form of the command or use the no debug all command to turn off all debugging.
debug ethport {all | error | event [interface gigabitethernet slot/port | module slot] | ha [interface
gigibetethernet slot/port | module slot] | trace [interface gigibetethernet slot/port | module
slot]}
no debug ethport {all | error | event [interface gigabitethernet slot/port | module slot] | ha
[interface gigibetethernet slot/port | module slot] | trace [interface gigibetethernet slot/port
| module slot]}
Syntax Description
all
Enables debugging for all Ethernet port features.
error
Enables debugging for Ethernet port error conditions.
event
Enables debugging for Ethernet port events.
ha
Enables debugging for port high availability.
trace
Enables debugging for Ethernet port traces.
interface gigibetethernet
slot/port
(Optional) Specifies the slot and port of the Gigabit Ethernet interface.
module slot
(Optional) Specifies the slot number of the module being debugged.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug ethport all command is issued:
switch# debug ethport all
1981 May 5 07:28:59 ethport:
1981 May 5 07:28:59 ethport:
1981 May 5 07:28:59 ethport:
MTS_OPC_DEBUG_WRAP_MSG(msg_id
fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
fu_fsm_execute_all: null fsm_event_list
fu_fsm_engine_post_event_processing: mts msg
52343) dropped
Related Commands
Cisco MDS 9000 Family Command Reference
6-24
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug ethport
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-25
Chapter 6
Debug Commands
debug exceptionlog
debug exceptionlog
To enable the exception log debugging feature, use the debug exceptionlog command in EXEC mode.
To disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug exceptionlog {demux | deque | error | flow | info}
no debug exceptionlog {demux | deque | error | flow | info}
Syntax Description
demux
Enables debugging for the exception logger demux functions.
deque
Enables debugging for the exception logger deque function.
error
Enables debugging for exception logger errors.
flow
Enables debugging for the exception logger flow.
info
Enables debugging for exception logger information.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug exceptionlog command is issued:
switch# debug exceptionlog
7), credit(3), empty
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-26
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fabric-binding
debug fabric-binding
To enable debugging for the fabric binding feature, use the debug fabric-binding command in EXEC
mode. To disable a debug command, use the no form of the command or use the no debug all command
to turn off all debugging.
debug fabric-binding {all | efmd {db-events | errors | merge {errors | events | packets}} |
mts-events | pss-events} | errors [vsan vsan-id] | events [vsan vsan-id] | mts-events |
pss-events | snmp-events | trace [vsan vsan-id]}
no debug fabric-binding {all | efmd {db-events | errors | merge {errors | events | packets}} |
mts-events | pss-events} | errors [vsan vsan-id] | events [vsan vsan-id] | mts-events |
pss-events | snmp-events | trace [vsan vsan-id]}
Syntax Description
all
Enables debugging for all fabric binding features.
db-events
Enables debugging for EFMD protocol database events.
efmd
Enables debugging for Exchange Fabric Membership Data (EFMD) protocol.
errors
Enables debugging for fabric binding errors.
events
Enables debugging for fabric binding events.
merge
Enables debugging for EFMD protocol merges.
packets
Enables debugging for EFMD protocol packets.
vsan vsan-id
(Optional) Specifies the VSAN ID. The range is 1 to 4093.
events
Enables debugging for fabric binding events.
mts-events
Enables debugging for fabric binding MTS events.
pss-events
Enables debugging for fabric binding PSS events.
snmp-events
Enables debugging for fabric binding SNMP events
trace
Enables debugging for fabric binding traces.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug fabric-binding all command is
issued:
switch# debug fabric-binding all
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-27
Chapter 6
Debug Commands
debug fabric-binding
Related Commands
Command
Description
no debug all
Disables all debugging.
show fabric-binding
Displays configured fabric binding information.
Cisco MDS 9000 Family Command Reference
6-28
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fc-tunnel
debug fc-tunnel
To enable debugging for the Fibre Channel tunnel feature, use the debug fc-tunnel command in EXEC
mode. To disable a debug command, use the no form of the command or use the no debug all command
to turn off all debugging.
debug fc-tunnel {all | errors | external-events | ha | label-update | mts {pkt | pkthdr} {both | rx
| tx} | pss | route-update [vsan vsan-id] | rsvp-messages [tunnel tunnel-id | vsan vsan-id] |
state-machine}
no debug fc-tunnel {all | errors | external-events | ha | label-update | mts {pkt | pkthdr} {both
| rx | tx} | pss | route-update [vsan vsan-id] | rsvp-messages [tunnel tunnel-id | vsan vsan-id]
| state-machine}
Syntax Description
all
Enables debugging for all FC tunnel features.
errors
Enables debugging for FC tunnel errors.
external-events
Enables debugging for external FC tunnel events.
ha
Enables debugging for FC tunnel high availability (HA) events.
label-update
Enables debugging for FC tunnel label updates.
mts
Enables debugging for FC tunnel MTS events.
pkt
Specifies debugging of packets.
pkthdr
Specifies debugging of headers.
both
Specifies debugging in both the transmit and receive directions.
tx
Specifies debugging in the transmit direction.
rx
Specifies debugging in the receive direction.
pss
Enables debugging for FC tunnel PSS events.
route-update
Enables debugging for FC tunnel route updates.
vsan vsan-id
(Optional) Specifies the VSAN ID. The range is 1 to 4093.
rsvp-messages
Enables debugging for FC tunnel SNMP events
tunnel tunnel-id
(Optional) Specifies the tunnel ID. The range is 1 to 255.
state-machine
Enables debugging for FC tunnel traces.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(2)
This command was introduced.
Usage Guidelines
None.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-29
Chapter 6
Debug Commands
debug fc-tunnel
Examples
The following example displays the system output when the debug fc-tunnel all command is issued:
switch# debug fc-tunnel all
Related Commands
Command
Description
no debug all
Disables all debugging.
show fc-tunnel
Display configured FC tunnel information.
Cisco MDS 9000 Family Command Reference
6-30
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fc2
debug fc2
To enable debugging for the FC2 feature, use the debug fc2 command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug fc2 {credit | error [fcid fcid [interface {fc slot/port | fcip port} | vsan vsan-id [interface
{fc slot/port | fcip port}]] | interface {fc slot/port | fcip port} | vsan vsan-id [interface {fc
slot/port | fcip port}]] flag | flow [fcid fcid [interface {fc slot/port | fcip port} | vsan vsan-id
[interface {fc slot/port | fcip port}]] | interface {fc slot/port | fcip port} | vsan vsan-id
[interface {fc slot/port | fcip port}]] | (interface fc type number | vsan vsan-id) | frame |
loopback pkt {both | tx | rx} [bytes bytes | fcid fcid [bytes bytes | interface {fc slot/port | fcip
port} [bytes bytes | pkts pkts [bytes bytes]] | pkts pkts [bytes bytes] | vsan vsan-id [bytes bytes
| interface {fc slot/port | fcip port} [bytes bytes | pkts pkts [bytes bytes]]] | pkthdr {both | tx
| rx} [bytes bytes | fcid fcid [bytes bytes | interface {fc slot/port | fcip port} [bytes bytes | pkts
pkts [bytes bytes]] | pkts pkts [bytes bytes] | vsan vsan-id [bytes bytes | interface {fc slot/port
| fcip port} [bytes bytes | pkts pkts [bytes bytes]]] | rdl | rxhdrhistory [fcid fcid [interface {fc
slot/port | fcip port} | vsan vsan-id [interface {fc slot/port | fcip port}]] | interface {fc slot/port
| fcip port} | vsan vsan-id [interface {fc slot/port | fcip port}]] txhdrhistory [fcid fcid
[interface {fc slot/port | fcip port} | vsan vsan-id [interface {fc slot/port | fcip port}]] |
interface {fc slot/port | fcip port} | vsan vsan-id [interface {fc slot/port | fcip port}]]}
no debug fc2 {credit | error [fcid fcid [interface {fc slot/port | fcip port} | vsan vsan-id [interface
{fc slot/port | fcip port}]] | interface {fc slot/port | fcip port} | vsan vsan-id [interface {fc
slot/port | fcip port}]] flag | flow [fcid fcid [interface {fc slot/port | fcip port} | vsan vsan-id
[interface {fc slot/port | fcip port}]] | interface {fc slot/port | fcip port} | vsan vsan-id
[interface {fc slot/port | fcip port}]] | (interface fc type number | vsan vsan-id) | frame |
loopback | pkt {both | tx | rx} [bytes bytes | fcid fcid [bytes bytes | interface {fc slot/port |
fcip port} [bytes bytes | pkts pkts [bytes bytes]] | pkts pkts [bytes bytes] | vsan vsan-id [bytes
bytes | interface {fc slot/port | fcip port} [bytes bytes | pkts pkts [bytes bytes]]] |
pkthdr {both | tx | rx} [bytes bytes | fcid fcid [bytes bytes | interface {fc slot/port | fcip port}
[bytes bytes | pkts pkts [bytes bytes]] | pkts pkts [bytes bytes] | vsan vsan-id [bytes bytes |
interface {fc slot/port | fcip port} [bytes bytes | pkts pkts [bytes bytes]]] | rdl |rxhdrhistory
[fcid fcid [interface {fc slot/port | fcip port} | vsan vsan-id [interface {fc slot/port | fcip port}]]
| interface {fc slot/port | fcip port} | vsan vsan-id [interface {fc slot/port | fcip port}]]
txhdrhistory [fcid fcid [interface {fc slot/port | fcip port} | vsan vsan-id [interface {fc
slot/port | fcip port}]] | interface {fc slot/port | fcip port} | vsan vsan-id [interface {fc slot/port
| fcip port}]]}
Syntax Description
credit
Enables FC2 credit debugging.
error
Enables FC2 error debugging.
fcid fcid
(Optional) Restricts debugging to the specified FCID.
interface
(Optional) Restricts debugging to the specified interface.
fc slot/port
(Optional) Restricts debugging to the specified interface.
fcip port
(Optional) Restricts debugging to the specified interface.
vsan vsan-id
Restricts debugging to the specified VSAN.
flag
Enables FC2 flags debugging.
flow
Enables FC2 flow debugging.
frame
Enables FC2 frame debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-31
Chapter 6
Debug Commands
debug fc2
loopback
Enables FC2 loopback debugging.
pkt
Enables FC packet debugging.
both
Enables debugging in both the transmit and receive directions.
tx
Enables debugging in the transmit direction,
rx
Enables debugging in the receive direction.
bytes bytes
(Optional) Specifies the number of bytes to display.
pkts pkts
Specifies the number of packets to display.
pkthdr
Enables FC header debugging.
rdl
Enables FC2 RDL debugging.
rxhdrhistory
Enables FC2 received header history debugging.
txhdrhistory
Enables FC2 transmitted header history debugging.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
If FSPF receives a bad FC2 packet analyze the output of the debug fc2 pkt command.
Examples
The following example displays the system output when the debug fc2 error vsan 1 command is issued:
switch1# debug fc2 error vsan 1
Related Commands
Command
Description
no debug all
Disables all debugging.
show fc2
Displays FC2 information.
Cisco MDS 9000 Family Command Reference
6-32
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fc2d
debug fc2d
To enable debugging for the FC2 feature, use the debug fc2 command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug fc2 {all | bypass ficon_mgr | demux [vsan vsan-id] | deque | error | event [vsan vsan-id] |
ha [vsan vsan-id] | trace [detail] [vsan vsan-id] | warning [vsan vsan-id]}
no debug fc2 {all | bypass ficon_mgr | demux [vsan vsan-id] | deque | error | event [vsan vsan-id]
| ha [vsan vsan-id] | trace [detail] [vsan vsan-id] | warning [vsan vsan-id]}
Syntax Description
all
Enables all FC2D debug flags.
bypass
Enables bypassing some components in fc2d execution.
ficon_mgr
Enables bypassing FICON Manager in fc2d execution.
demux
Enables debugging of FC2D message demux.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
deque
Enables debugging of FC2D message dequeue.
error
Enables debugging of FC2D error.
event
Enables debugging of FC2D FSM and events.
ha
Enables debugging of FC2D HA.
trace
Enables debugging of FC2D trace.
detail
(Optional) Enables detailed debugging of FC2D trace.
warning
Enables debugging of FC2D warning.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(4)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug fc2d all command is issued:
switch1# debug fc2d all
2004 Mar 29 22:57:25 fc2d: fu_fsm_execute_all: match_msg_id(0), log_already_open (0)
2004 Mar 29 22:57:25 fc2d: fu_fsm_execute_all: null fsm_event_list
2004 Mar 29 22:57:25 fc2d: fu_fsm_engine_post_event_processing: mts msg MTS_OPC_
DEBUG_WRAP_MSG(msg_id 6894921) dropped
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-33
Chapter 6
Debug Commands
debug fc2d
Related Commands
Command
Description
debug all
Enables debugging for the FC2 feature.
no debug all
Disables all debugging.
show fc2
Displays FC2 information.
Cisco MDS 9000 Family Command Reference
6-34
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fcc
debug fcc
To enable debugging for the Fibre Channel Congestion (FCC) function, use the debug fcc command in
EXEC mode. To disable a debug command, use the no form of the command or use the no debug all
command to turn off all debugging.
debug fcc {all | error [module slot] | event [module slot] | mts [pkt {both | rx [node range |
opcode range | sap range] | tx} | pkthdr {both | tx | rx [numpkt range]} | trace [module slot]}
no debug fcc {all | error [module slot] | event [module slot] | mts {pkt {both | rx [node range |
opcode range | sap range] | tx} | pkthdr {both | tx | rx [numpkt range]} | trace [module slot]}
Syntax Description
all
Enables debugging for all FCC features.
errors
Enables debugging for FCC error conditions.
events
Enables debugging for FCC events.
module slot
(Optional) Specifies the slot number of the module being debugged.
mts
Enables debugging for FCC tx/rx MTS packets.
pkt
Enables debugging for FCC tx/rx FCC packets.
both
Specifies debugging in both the transmit and receive directions.
tx
Specifies debugging in the transmit direction,
rx
Specifies debugging in the receive direction.
node range
(Optional) Specifies the node for the packets in the receive direction.
opcode range
(Optional) Specifies the opcode for the packets in the receive direction.
sap range
(Optional) Specifies the sap for the packets in the receive direction. The
integer range is from 1 to 4096.
pkthdr
Enables debugging for FCC tx/rx FCC headers.
numpkt range
(Optional) Specifies the number of required packets
trace
Enables debugging for FCC traces.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug fcc all command is issued:
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-35
Chapter 6
Debug Commands
debug fcc
switch# debug fcc all
Related Commands
Command
Description
no debug all
Disables all debugging.
show fcc
Displays FCC settings.
Cisco MDS 9000 Family Command Reference
6-36
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fcdomain
debug fcdomain
To enable debugging for the fcdomain feature, use the debug fcdomain command in EXEC mode.To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug fcdomain {all | critical | error | fc {pkt | pkthdr} {both | rx | tx} [interface type number
[vsan vsan-id] | vsan vsan-id] | ipc {pkt | pkthdr} {both | rx [node range | opcode range | sap
range] | tx} | memory | notify | phase}
no debug fcdomain {all | critical | error | fc {pkt | pkthdr} {both | rx | tx} [interface type number
[vsan vsan-id] | vsan vsan-id] | ipc {pkt | pkthdr} {both | rx [node range | opcode range | sap
range] | tx} | memory | notify | phase}
Syntax Description
all
Enables debugging of all fcdomain parameters.
critical
Enables debugging of critical operations.
error
Enables debugging of error operation.
fc
Enables debugging of Fibre Channel packets and headers.
ipc
Enables debugging of Fibre Channel IP packets and headers.
pkt
Enables debugging of packets.
pkthdr
Enables debugging of headers.
both
Enables debugging in both the transmit and receive directions.
rx
Enables debugging in the receive direction.
tx
Enables debugging in the transmit direction.
interface type number
(Optional) Specifies the interface to be debugged.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
node range
(Optional) Specifies the node for the packets in the receive direction.
opcode range
(Optional) Specifies the opcode for the packets in the receive direction.
sap range
(Optional) Specifies the sap for the packets in the receive direction. The
integer range is from 1 to 4096.
memory
Enables debugging of memory operations.
notify
Enables debugging of notifications.
phase
Enables debugging of global phases.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-37
Chapter 6
Debug Commands
debug fcdomain
Usage Guidelines
None.
Examples
The following example displays the system output when the debug fcdomain critical command is
issued:
switch# debug fcdomain critical
Jan 27 07:04:31 fcdomain: Src: 0x00000501/6243 Dst: 0x00000501/14 ID: 0x0005BF
41 Size: 252 [REQ] Opc: 182 (MTS_OPC_DEBUG_WRAP_MSG) RR: 0x0005BF41 HA_SEQNO:
0x00000000 TS: 0x183C4D027F4A3
Jan 27 07:04:31 fcdomain: 00 00 00 00 68 00 00 00 00 00 00 00 00 00 00 00
Jan 27 07:04:31 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Jan 27 07:04:31 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 FF FF FF FF
Jan 27 07:04:31 fcdomain: 2F 64 65 76 2F 70 74 73 2F 30 00 00 00 00 00 00
Jan 27 07:04:31 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
...
The following example displays the system output when the debug fcdomain error command is issued:
switch# debug fcdomain error
Jan 27 07:05:29 fcdomain: Src: 0x00000501/6245 Dst: 0x00000501/14 ID: 0x0005BF
7E Size: 252 [REQ] Opc: 182 (MTS_OPC_DEBUG_WRAP_MSG) RR: 0x0005BF7E HA_SEQNO:
0x00000000 TS: 0x183D5E63C081A
Jan 27 07:05:29 fcdomain: 00 00 00 00 64 00 00 00 00 00 00 00 00 00 00 00
Jan 27 07:05:29 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Jan 27 07:05:29 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 FF FF FF FF
Jan 27 07:05:29 fcdomain: 2F 64 65 76 2F 70 74 73 2F 30 00 00 00 00 00 00
...
The following example displays the system output when the debug fcdomain ipc pkthdr both
command is issued:
switch# debug fcdomain ipc pkthdr both
Apr 8 20:44:38 fcdomain: Src: 0x00000501/3883 Dst: 0x00000501/14 ID: 0x00038E
1D Size: 252 [REQ] Opc: 182 (MTS_OPC_DEBUG_WRAP_MSG) RR: 0x00038E1D HA_SEQNO:
0x00000000 TS: 0x5DD9B14EA3AA REJ:0
Apr 8 20:44:38 fcdomain: 00 00 00 00 08 00 00 00 00 00 00 00 00 00 00 00
Apr 8 20:44:38 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 8 20:44:38 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 FF FF FF FF
Apr 8 20:44:38 fcdomain: 2F 64 65 76 2F 70 74 73 2F 30 00 00 00 00 00 00
Apr 8 20:44:38 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 8 20:44:38 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
...
Apr 8 20:44:38 fcdomain: Src: 0x00000501/3883 Dst: 0x00000501/14 ID: 0x00038E
20 Size: 252 [REQ] Opc: 182 (MTS_OPC_DEBUG_WRAP_MSG) RR: 0x00038E20 HA_SEQNO:
0x00000000 TS: 0x5DD9B186CCEB REJ:0
Apr 8 20:44:38 fcdomain: 00 00 00 00 07 00 00 00 00 00 00 00 00 00 00 00
Apr 8 20:44:38 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 8 20:44:38 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 FF FF FF FF
Apr 8 20:44:38 fcdomain: 2F 64 65 76 2F 70 74 73 2F 30 00 00 00 00 00 00
Apr 8 20:44:38 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 8 20:44:38 fcdomain: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
...
Related Commands
Command
Description
fcdomain
Enables fcdomain features.
show fcdomain domain-list
Displays current domains in the fabric.
Cisco MDS 9000 Family Command Reference
6-38
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fcfwd
debug fcfwd
To enable debugging for the Fibre Channel forwarding feature, use the debug fcfwd command in EXEC
mode. To disable a debug command, use the no form of the command or use the no debug all command
to turn off all debugging.
debug fcfwd {flogimap | idxmap | pcmap | sfib | spanmap} {error | event | trace} [module slot |
vsan vsan-id [module slot]]
no debug fcfwd {flogimap | idxmap | pcmap | sfib | spanmap} {error | event | trace} [module
slot | vsan vsan-id [module slot]]
Syntax Description
flogimap
Enables flogimap debugging.
idxmap
Enables idxmap debugging.
pcmap
Enables pcmap debugging.
sfib
Enables sfib debugging.
spanmap
Enables spanmap debugging.
error
Enables debugging for FCC error conditions.
event
Enables debugging for FCC events.
trace
Enables debugging for FCC traces.
module slot
(Optional) Specifies the slot number of the module being debugged.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug fcfwd error command is issued:
switch# debug fcfwd error
Related Commands
Command
Description
no debug all
Disables all debugging.
show fcfwd
Displays the configured fcfwd tables and statistics.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-39
Chapter 6
Debug Commands
debug fcns
debug fcns
To enable debugging for name server registration, use the debug fcns command in EXEC mode. To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug fcns {all | errors | events {mts | query | register}} [vsan vsan-id]
no debug fcns {all | errors | events {mts | query | register}} [vsan vsan-id]
Syntax Description
all
Enables debugging for all name server features.
errors
Enables debugging for name server error conditions.
events
Enables debugging for name server events.
mts
Enables debugging for name server tx/rx MTS packets.
query
Enables debugging for name server tx/rx CDP packets.
register
Enables debugging for name server PSS related events.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug fcns events register vsan 99
command is issued:
switch# debug fcns events register vsan 99
Feb 17 04:42:54 fcns: vsan 99: Got Entry for port-id 27800
Feb 17 04:42:54 fcns: vsan 99: Registered port-name 36a4078be0000021 for port-id 780200
Feb 17 04:42:54 fcns: vsan 99: Registered node-name 36a4078be0000020 for port-id 780200
...
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-40
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fcns
Command
Description
show fcns database
Displays the results of the discovery or the name server database for a
specified VSAN or for all VSANs.
show fcns statistics
Displays the statistical information for a specified VSAN or for all VSANs.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-41
Chapter 6
Debug Commands
debug fcs
debug fcs
To enable debugging for the fabric configuration server, use the debug fcs command in EXEC mode. To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug fcs {all | discovery events | errors [vsan vsan-id] | ess-events [vsan vsan-id] |
mts events {brief | detail} | pss events | queries events [vsan vsan-id] |
registrations events [vsan vsan-id] | rscn events [vsan vsan-id] | snmp events}
no debug fcs {all | discovery events | errors [vsan vsan-id] | ess-events [vsan vsan-id] |
mts events {brief | detail} | pss events | queries events [vsan vsan-id] |
registrations events [vsan vsan-id] | rscn events [vsan vsan-id] | snmp events}
Syntax Description
all
Enables debugging for all FCS features.
discovery events
Enables debugging for FCS discovery events.
errors
Enables debugging for FCS error conditions.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
ess-events
Enables debugging for FCS tx/rx ESS events.
mts events
Enables debugging for FCS tx/rx MTS events.
brief
Provides brief information for each event.
detail
Provides detailed information for each event.
pss events
Enables debugging for FCS
queries events
Enables debugging for FCS tx/rx events.
registration events
Enables debugging for FCS PSS related events.
rscn events
Enables debugging for FCS RSCN events.
snmp events
Enables debugging for FCS SNMP events.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug fcs all command is issued:
switch# debug fcs all
Cisco MDS 9000 Family Command Reference
6-42
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fcs
Related Commands
Command
Description
no debug all
Disables all debugging.
show fcs
Displays the status of the fabric configuration.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-43
Chapter 6
Debug Commands
debug fcsp-mgr
debug fcsp-mgr
To enable debugging for the Fibre Channel Security Protocol (FC-SP) manager, use the debug fcsp-mgr
command in EXEC mode. To disable a debug command, use the no form of the command or use the no
debug all command to turn off all debugging.
debug fcsp-mgr {all | critical | datastructure | dhchap | error | event-gen | fc2 | fsm | general |
ha | init | level1 | level2 | level3 | level4 | level5 | message | mts | notify | trace}
no debug fcsp-mgr {all | critical | datastructure | dhchap | error | event-gen | fc2 | fsm | general
| ha | init | level1 | level2 | level3 | level4 | level5 | message | mts | notify | trace}
Syntax Description
all
Enables debugging for all FC-SP features.
critical
Enables debugging of FC-SP critical errors.
datastructure
Enables debugging of FC-SP data structures.
dhchap
Enables debugging of DHCHAP.
error
Enables debugging of FC-SP error.
event-gen
Enables debugging of FC-SP event generation.
fc2
Enables debugging of FC-SP FC2 messages.
fsm
Enables debugging of FC-SP events.
general
Enables general debugging of FC-SP.
ha
Enables debugging of FC-SP high availability
init
Enables debugging of FC-SP initialization.
level1
Sets debugging level of FC-SP Mgr to 1.
level2
Sets debugging level of FC-SP Mgr to 2.
level3
Sets debugging level of FC-SP Mgr to 3.
level4
Sets debugging level of FC-SP Mgr to 4.
level5
Set debugging level of FC-SP Mgr to 5.
message
Enables debugging of FC-SP messages.
mts
Enables debugging of FC-SP MTS messages.
notify
Sets debug level to notify.
trace
Enables debugging of FC-SP function enter/exit.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(2)
This command was introduced.
Cisco MDS 9000 Family Command Reference
6-44
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fcsp-mgr
Usage Guidelines
None.
Examples
The following example displays the system output when the debug fcsp-mgr all command is issued:
switch# debug fcsp-mgr all
2004 Mar 29 23:33:56 fcsp-mgr: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
2004 Mar 29 23:33:56 fcsp-mgr: fu_fsm_execute_all: null fsm_event_list
2004 Mar 29 23:33:56 fcsp-mgr: fu_fsm_engine_post_event_processing: mts msg MTS_
OPC_DEBUG_WRAP_MSG(msg_id 7061762) dropped
Related Commands
Command
Description
no debug all
Disables all debugging.
show fcsp
Displays the status of the FC-SP configuration
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-45
Chapter 6
Debug Commands
debug fdmi
debug fdmi
To enable debugging for the Fabric-Device Management Interface (FDMI) feature, use the debug fdmi
command in EXEC mode. To disable a debug command, use the no form of the command or use the no
debug all command to turn off all debugging.
debug fdmi {all | errors | fdmi-messages [vsan vsan-id] | ha | mts {pkt {both | rx [node range |
opcode range | sap range] | tx} | pkthdr {both | tx | rx [numpkt range]} | pss | trace}
no debug fdmi {all | errors | fdmi-messages [vsan vsan-id] | ha | mts {pkt {both | rx [node range
| opcode range | sap range] | tx} | pkthdr {both | tx | rx [numpkt range]} | pss | trace}
Syntax Description
all
Enables debugging for all FDMI features.
errors
Enables debugging for FDMI error conditions.
fdmi-messages
Enables the dump of FDMI PDUs.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
ha
Enables the dump of HA synchronization messages.
mts
Enables debugging for FDMI tx/rx MTS events.
pkt
Enables debugging for FCC tx/rx FCC packets.
both
Specifies debugging in both the transmit and receive directions.
tx
Specifies debugging in the transmit direction,
node range
(Optional) Specifies the node for the packets in the receive direction.
The integer range is from 1 to 4096.
opcode range
(Optional) Specifies the opcode for the packets in the receive direction.
The integer range is from 1 to 4096.
sap range
(Optional) Specifies the sap for the packets in the receive direction. the
integer range is from 1 to 4096.
rx
Specifies debugging in the receive direction.
pkthdr
Enables debugging for FCC tx/rx FCC headers.
numpkt range
Specifies the number of required packets
pss
Enables debugging for FDMI PSSs.
trace
Restricts debugging for FDMI traces.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(2)
This command was introduced.
Cisco MDS 9000 Family Command Reference
6-46
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fdmi
Usage Guidelines
None.
Examples
The following example displays the system output when the debug fdmi all command is issued:
switch# debug fdmi all
2005 Mar 10 02:37:28 fdmi: 00 00 00 02 00 00 00 1C 04 19 65 08 00 82 39 08
2005 Mar 10 02:37:28 fdmi: C4 16 65 08 44 19 65 08 E4 87 39 08 04 17 65 08
2005 Mar 10 02:37:28 fdmi: 84 19 65 08 4C 8D 39 08 44 17 65 08 C4 19 65 08
2005 Mar 10 02:37:28 fdmi: B4 92 39 08 00 17 65 08 04 1A 65 08 1C 98 39 08
2005 Mar 10 02:37:28 fdmi: C4 17 65 08 44 1A 65 08 84 9D 39 08 04 18 65 08
2005 Mar 10 02:37:28 fdmi: 84 1A 65 08 EC A2 39 08 44 18 65 08 C4 1A 65 08
2005 Mar 10 02:37:28 fdmi: 54 A8 39 08 84 18 65 08 04 1B 65 08 BC AD 39 08
2005 Mar 10 02:37:28 fdmi: 00 00 00 02 00 00 0B B8 00 00 00 00 00 00 00 00
2005 Mar 10 02:37:28 fdmi: 00 00 00 00 00 00 00 00 00 00 00 00
2005 Mar 10 02:37:28 fdmi: Src: 0x00000601/27 Dst: 0x00000601/105 ID: 0x0069E217
140 [REQ] Opc: 7804 (MTS_OPC_FDMI_SNMP) RR: 0x0069E217 HA_SEQNO: 0x00000000 TS:
0x25218CC5A40E3 REJ:0 SYNC:0
Related Commands
Command
Description
no debug all
Disables all debugging.
show fdmi
Displays the FDMI database information.
Size:
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-47
Chapter 6
Debug Commands
debug ficon
debug ficon
To enable debugging for the Fibre Connection (FICON) interface capabilities, use the debug ficon
command in EXEC mode. To disable a debug command, use the no form of the command or use the no
debug all command to turn off all debugging.
debug ficon {all | bypass {acl | esa | file | pm | postcheck | precheck} | control-device {all | bypass
ficon_mgr | demux [vsan vsan-id] | deque | error | event [vsan vsan-id] | ficon_mgr | ha [vsan
vsan-id] | demux [vsan vsan-id] | sb3 {error | flow} trace [detail] [vsan vsan-id] | warning
[vsan vsan-id]} | error | event | file-trace | ha | max-port-number ports | pss-trace |
stat {all | demux [vsan vsan-id] | deque | error | event [vsan vsan-id] | ha [vsan vsan-id] | trace
[detail] [vsan vsan-id] | warning [vsan vsan-id]} | timer | trace}
no debug ficon {all | bypass {acl | esa | file | pm | postcheck | precheck} | control-device {all |
bypass ficon_mgr | demux [vsan vsan-id] | deque | error | event [vsan vsan-id] | ficon_mgr |
ha [vsan vsan-id] | demux [vsan vsan-id] | sb3 {error | flow} trace [detail] [vsan vsan-id] |
warning [vsan vsan-id]} | error | event | file-trace | ha | max-port-number port | pss-trace |
stat {all | demux [vsan vsan-id] | deque | error | event [vsan vsan-id] | ha [vsan vsan-id] | trace
[detail] [vsan vsan-id] | warning [vsan vsan-id]} | timer | trace}
Syntax Description
all
Enables debugging for all FICON features.
bypass
Enables bypass flags for FICON error conditions.
acl
Bypasses ACL manager execution.
esa
Bypasses ESA execution.
file
Bypasses file operations execution.
pm
Bypasses port manager execution.
postcheck
Bypass es post check execution for VSAN enable.
precheck
Bypasses precheck execution for VSAN enable.
control-device
Enables the dump of FICON control devices.
all
Specifies all debug flags of FICON control device.
bypass ficon_mgr
Bypasses FICON Manager.
demux
Configures debugging of FICON control device message demux.
deque
Configures debugging of FICON control device message deque.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
error
Configures debugging of FICON control device error.
event
Configures debugging of FICON control device FSM and Events.
ficon_mgr
Configures debugging of FICON manager control device.
ha
Configures debugging of FICON control device HA.
sb3
Configures debugging of SB3 library.
error
Enables debugging for FICON errors.
flow
trace
Configures debugging of FICON control device trace.
detail
(Optional)
warning
Configures debugging of FICON control device warning.
Cisco MDS 9000 Family Command Reference
6-48
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug ficon
error
Enables debugging for FICON errors.
event
Enables debugging for FICON events.
file-trace
Enables debugging of FICON file flow.
ha
Enables the debugging of HA synchronization messages.
max-port-number ports
Specifies maximum number of ports.
pss-trace
Enables debugging of FICON PSS flow.
stat
Enables debugging of FICON statistics.
all
Specifies all debug flags of FICON statistics.
demux
Specifies FICON statistics message demux.
deque
Specifies FICON statistics message deque.
error
Specifies FICON statistics errors.
event
Specifies FICON statistics FSM and events.
ha
Specifies FICON statistics HA.
trace
Specifies FICON statistics trace.
warning
Specifies FICON statistics warnings
timer
Enables debugging of FICON timer messages.
trace
Enables debugging of FICON flow.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(2)
This command was introduced.
Usage Guidelines
FICON must be enabled on the switch to use this command.
Examples
The following example displays the system output when the debug ficon all command is issued:
switch# debug ficon all
2005 Mar 10 02:38:58 ficon: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
2005 Mar 10 02:38:58 ficon: fu_fsm_execute_all: null fsm_event_list
2005 Mar 10 02:38:58 ficon: fu_fsm_engine_post_event_processing: mts msg
MTS_OPC_DEBUG_WRAP_MSG(msg_id 6943776) dropped
switch# undebug all
Related Commands
Command
Description
no debug all
Disables all debugging.
show ficon
Displays configured FICON information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-49
Chapter 6
Debug Commands
debug flogi
debug flogi
To enable debugging for the fabric login (FLOGI) feature, use the debug flogi command in EXEC mode.
To disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug flogi {action [interface type number | vsan vsan-id] | all | bypass {acl | dm | dpvm | fcsp |
lcp | npiv | ns | pl | pm | pmvc | rib| vsan_mgr | zs} | demux [interface type number | vsan
vsan-id] | error | event [interface type number | vsan vsan-id] | ha [interface type number |
vsan vsan-id] | init [interface type number | vsan vsan-id] | timers [interface type number |
vsan vsan-id] | trace [interface type number | vsan vsan-id] | warning}
no debug flogi {action [interface type number | vsan vsan-id] | all | bypass {acl | dm | dpvm | fcsp
| lcp | npiv | ns | pl | pm | pmvc | rib| vsan_mgr | zs} | demux [interface type number | vsan
vsan-id] | error | event [interface type number | vsan vsan-id] | ha [interface type number |
vsan vsan-id] | init [interface type number | vsan vsan-id] | timers [interface type number |
vsan vsan-id] | trace [interface type number | vsan vsan-id] | warning}
Syntax Description
action
Enables all FLOGI debug features.
interface type number
(Optional) Restricts debugging to the specified interface.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
all
Enables all FLOGI debug options.
bypass
Bypasses some components in FLOGI execution.
acl
Bypasses ACL execution.
dm
Bypasses domain manager execution.
dpvm
Bypasses DPVM execution.
fcsp
Bypasses FCSP execution.
lcp
Bypasses LCP execution.
npiv
Bypasses NPIV execution.
ns
Bypasses name server execution.
pl
Bypasses port lock execution.
pm
Bypasses port manager execution.
pmvc
Bypasses PM VSAN change execution.
rib
Bypasses RIB execution.
vsan_mgr
Bypasses VSAN manager execution.
zs
Bypasses zone server execution.
demux
Enables FLOGI demux
error
Enables debugging for FLOGI error conditions.
event
Enables debugging for FLOGI FSMs and events.
ha
Enables debugging for FLOGI high availability.
init
Enables debugging of FLOGI addition, deletion, and initialization.
timers
Enables debugging for FLOGI message timers.
trace
Enables debugging for FLOGI traces.
warning
Enables debugging for FLOGI warnings.
Cisco MDS 9000 Family Command Reference
6-50
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug flogi
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug flogi all command is issued:
switch# debug flogi all
Apr 9 22:44:08 flogi: fs_demux: msg consumed by sdwrap_process msg
Apr 9 22:44:08 flogi: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
Apr 9 22:44:08 flogi: fu_fsm_execute_all: null fsm_event_list
Apr 9 22:44:08 flogi: fu_fsm_engine: mts msg MTS_OPC_DEBUG_WRAP_MSG(msg_id 67690) dropped
The following example displays the system output when the debug flogi event command is issued:
switch# debug flogi event
Apr 10 00:07:16 flogi: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
Apr 10 00:07:16 flogi: fu_fsm_execute_all: null fsm_event_list
Apr 10 00:07:16 flogi: fu_fsm_engine: mts msg MTS_OPC_DEBUG_WRAP_MSG(msg_id 71314) dropped
The following example displays the system output when the debug flogi trace command is issued:
switch# debug flogi trace
Apr 10 00:42:36 flogi: fs_genport_vsan_hash_fn: key: 0x1 index: 0x1
Apr 10 00:42:36 flogi: fs_mts_hdlr_fs_flogo: FLOGI HOLD(0x8122144) refcnt:3
Apr 10 00:42:36 flogi: fs_clear_all_outstanding_responses_for_flogi: FLOGI FREE(
a07e00300500252b) refcnt:3
Related Commands
Command
Description
no debug all
Disables all debugging.
show flogi database
Displays all the FLOGI sessions through all interfaces across all VSANs.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-51
Chapter 6
Debug Commands
debug fm
debug fm
To enable feature manager debugging, use the debug fm command in EXEC mode. To disable a debug
command, use the no form of the command or use the no debug all command to turn off all debugging.
debug fm {error | flow}
no debug fm {error | flow}
Syntax Description
error
Enables debugging for feature manager error conditions.
flow
Enables debugging for the feature manager flow.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug fm flow command is issued:
switch# debug fm flow
switch# 2005 Mar 10 02:40:19 feature-mgr: fm_event_loop: ----------- EVENT START
2005 Mar 10 02:40:19 feature-mgr: fm_event_loop: received MTS message:
2005 Mar 10 02:40:19 feature-mgr: fm_event_loop: Src: 0x00000601/27 Dst: 0x00000601/121
ID: 0x006A0FC4 Size: 160 [REQ] Opc: 8922 (MTS_OPC_FM_CMI_GET_FEATURE_OP) RR: 0x006A0FC4
HA_SEQNO: 0x00000000 TS: 0x2524B48D52B53 REJ:0 SYNC:0
2005 Mar 10 02:40:19 feature-mgr: fm_handle_cmi_get_feature_op: Get feature (1) op request
2005 Mar 10 02:40:19 feature-mgr: fm_handle_cmi_get_feature_op: Reply to get feature ivr
op request: op 2, op_state 0, result 0x0 (success)
2005 Mar 10 02:40:19 feature-mgr: fm_event_loop: ----------- EVENT START
2005 Mar 10 02:40:19 feature-mgr: fm_event_loop: received MTS message:
2005 Mar 10 02:40:19 feature-mgr: fm_event_loop: Src: 0x00000601/27 Dst: 0x00000601/121
ID: 0x006A0FC6 Size: 160 [REQ] Opc: 8922 (MTS_OPC_FM_CMI_GET_FEATURE_OP) RR: 0x006A0FC6
HA_SEQNO: 0x00000000 TS: 0x2524B48EBF55D REJ:0 SYNC:0
2005 Mar 10 02:40:19 feature-mgr: fm_handle_cmi_get_feature_op: Get feature (1) op request
2005 Mar 10 02:40:19 feature-mgr: fm_handle_cmi_get_feature_op: Reply to get feature ivr
op request: op 2, op_state 0, result 0x0 (success)
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-52
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug fspf
debug fspf
To enable debugging for the FSPF feature, use the debug fspf command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug fspf {all [interface type number] [vsan vsan-id] | database [interface type number] [vsan
vsan-id | error | event [interface type number] [vsan vsan-id] | fc {pkt | pkthdr} {both | tx |
rx} [interface type number] [vsan vsan-id] | flood [interface type number] [vsan vsan-id] |
ha [interface type number] [vsan vsan-id] | mts {pkt {both | rx [node range | opcode range |
sap range] | tx} | pkthdr {both | rx [numpkt range] | tx}} | retrans [interface type number]
[vsan vsan-id] | route | timer}
no debug fspf {all [interface type number] [vsan vsan-id] | database [interface type number]
[vsan vsan-id | error | event [interface type number] [vsan vsan-id] | fc {pkt | pkthdr} {both
| tx | rx} [interface type number] [vsan vsan-id] | flood [interface type number] [vsan vsan-id] |
ha [interface type number] [vsan vsan-id] | mts {pkt {both | rx [node range | opcode range |
sap range] | tx} | pkthdr {both | rx [numpkt range] | tx}} | retrans [interface type number]
[vsan vsan-id] | route | timer}
Syntax Description
all
Enables debugging for all FSPF features.
interface type number
(Optional) Restricts debugging to the specified interface.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
database
Enables debugging for the FSPF database.
error
Enables debugging for FSPF error conditions.
event
Enables debugging for FSPF events.
fc
Enables debugging of Fibre Channel packets and headers.
pkt
Enables debugging for FCC tx/rx FCC packets.
pkthdr
Enables debugging for FCC tx/rx FCC headers.
both
Specifies debugging in both the transmit and receive directions.
tx
Specifies debugging in the transmit direction,
rx
Specifies debugging in the receive direction.
flood
Enables debugging for FSPF flodding events.
ha
Enables debugging for FSPF high availability.
mts
Enables debugging for FSPF tx/rx MTS events.
node range
(Optional) Specifies the node for the packets in the receive direction.
The integer range is from 1 to 4096.
opcode range
(Optional) Specifies the opcode for the packets in the receive direction.
The integer range is from 1 to 4096.
sap range
(Optional) Specifies the sap for the packets in the receive direction. the
integer range is from 1 to 4096.
numpkt range
(Optional) Specifies the number of required packets
retrans
Enables debugging for FSPF retransmits.
route
Enables debugging for FSPF route computation.
timer
Enables debugging for FSPF timers.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-53
Chapter 6
Debug Commands
debug fspf
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
If you receive bad packets on an interface, use the debug fc pkt command.
If you receive an error in processing a packet on an interface in VSAN, enter debug fspf error to get
more information. Make sure there is no misconfiguration of FSPF parameters on the two ends of the
interface. Also issue the debug fspf fc pkt command for the specific interface.
If you receive an error in flooding the local LSR in a VSAN issue the debug fspf flood and debug fspf
error commands. If error is reported in transmitting packet check if interface is up and turn on debug
fc2 error.
If you receive an error in processing a timer event for the interface in a VSAN, issue the debug fspf error
command.
If you receive an error in processing due to a wrong MTS message, use the debug fspf mts pkt and
debug fspf error commands.
If you receive an error when interacting with RIB, use the debug fspf route command along with the
RIB debug traces.
If you receive an error in computing routes for VSANs, issue the debug fspf error and the debug fspf
route commands.
If you receive an error due to the interface being stuck in a state other than FULL, use the debug fspf
event and debug fspf fc pkt commands on the interfaces involved.
Examples
The following example displays the system output when the debug fspf all command is issued:
switch1# debug fspf all
Apr 5 11:50:01 fspf: Wrong hello interval for packet on interface 100f000 in VSAN 1
Apr 5 11:50:04 fspf: Error in processing hello packet , error code = 4
Related Commands
Command
Description
no debug all
Disables all debugging.
show fspf
Displays global FSPF information.
Cisco MDS 9000 Family Command Reference
6-54
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug hardware arbiter
debug hardware arbiter
To configure debugging for the hardware arbiter driver, use the debug hardware arbiter command in
EXEC mode. To disable a debug command, use the no form of the command or use the no debug all
command to turn off all debugging.
debug hardware arbiter {error | flow} [group number]}
no debug hardware arbiter {error | flow} [group number]}
Syntax Description
error
Enables debugging for hardware arbiter kernel errors.
flow
Enables debugging for hardware arbiter kernel flow.
group number
(Optional) Restricts debugging to the specified group. The range is 0 to
17.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug hardware arbiter error group
command is issued:
switch# debug hardware arbiter error group 1
Related Commands
Command
Description
no debug all
Disables all debugging.
show hardware
Displays switch hardware inventory details.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-55
Chapter 6
Debug Commands
debug idehsd
debug idehsd
To enable IDE hot swap handler debugging, use the debug idehsd command in EXEC mode. To disable
a debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug idehsd {cmd dbglevel [debug-level] | error | flow}
no debug idehsd {cmd dbglevel [debug-level] | error | flow}
Syntax Description
cmd dbglevel
Enables debugging for the IDE hot swap handler.
debug-level
(Optional) Specifies the debug level (0 to 8).
error
Enables debugging for IDE hot swap handler error conditions.
flow
Enables debugging for IDE hot swap handler flow.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug idehsd cmd dbglevel command is
issued:
switch# debug idehsd cmd dbglevel 5
set debug level to 5 succeeded
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-56
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug ike
debug ike
To enable debugging for the IKE protocol, use the debug ike command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug ike {all | error | event | message | mts | protocol | verbose | warning}
no debug ike {all | error | event | message | mts | protocol | verbose | warning}
Syntax Description
all
Enables all of the debugging flags for IKE.
error
Enables debugging for IKE errors.
event
Enables debugging for IKE event generation.
message
Enables debugging for IKE messages.
mts
Enables debugging for MTS-related IKE activity.
protocol
Enables debugging for IKE protocol-related handling.
verbose
Enables verbose debugging for IKE protocol-related handling.
warning
Enables debugging for IKE warnings.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, IKE must be enabled using the crypto ike enable command.
Examples
The following example displays the system output when the debug ike all command is issued:
switch# debug ike all
Related Commands
Command
Description
no debug all
Disables all debugging.
show crypto ike
domain ipsec
Displays IKE protocol information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-57
Chapter 6
Debug Commands
debug ilc_helper
debug ilc_helper
To enable ILC helper debugging, use the debug ilc_helper command in EXEC mode. To disable a debug
command, use the no form of the command or use the no debug all command to turn off all debugging.
debug ilc_helper {all | errors | events | info}
no debug ilc_helper {all | errors | events | info}
Syntax Description
all
Enables debugging for all ILC helper features.
errors
Enables debugging for ILC helper error conditions.
events
Enables debugging for the ILC helper events.
info
Enables debugging for ILC helper information.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Examples
None.
The following example displays the system output when the debug ilc_helper all command is issued:
switch# debug ilc_helper all
For Application :125, sdwrap:mts_send : Broken pipe
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-58
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug ipacl
debug ipacl
To enable IP access control list (ACL) debugging, use the debug ipacl command in EXEC mode. To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug ipacl {all | error | event | trace}
no debug ipacl {all | error | event | trace}
Syntax Description
all
Enables debugging for all IP ACL features.
error
Enables debugging for IP ACL error conditions.
event
Enables debugging for the IP ACL events.
trace
Enables debugging for IP ACL trace.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Examples
None.
The following example displays the system output when the debug ipacl all command is issued:
switch# debug ipacl all
Related Commands
Command
Description
no debug all
Disables all debugging.
show ip access-list
Displays the IP access control lists that are currently active.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-59
Chapter 6
Debug Commands
debug ipconf
debug ipconf
To enable IP configuration debugging, use the debug ipconf command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug ipconf {all | errors | events | info | pss}
no debug ipconf {all | errors | events | info | pss}
Syntax Description
all
Enables debugging for all IP configuration features.
errors
Enables debugging for IP configuration error conditions.
events
Enables debugging for IP configuration tx/rx MTS events.
info
Enables debugging for IP configuration information.
pss
Enables debugging for IP configuration PSS operations.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug ipconf all command is issued:
switch# debug ipconf all
switch# 2005 Mar 10 02:45:30
2005 Mar 10 02:45:30 ipconf:
2005 Mar 10 02:45:30 ipconf:
2005 Mar 10 02:45:30 ipconf:
2005 Mar 10 02:45:30 ipconf:
2005 Mar 10 02:45:30 ipconf:
2005 Mar 10 02:45:30 ipconf:
2005 Mar 10 02:45:30 ipconf:
2005 Mar 10 02:45:30 ipconf:
Related Commands
ipconf: Received MTS
MTS message received
Getting ip addresses
Received MTS message
MTS message received
Getting ip addresses
Received MTS message
MTS message received
Getting ip addresses
Command
Description
no debug all
Disables all debugging.
message
opcode 862 source 0x00000601/27
on interface 5000000
opcode 862 source 0x00000601/27
on interface 5000000
opcode 862 source 0x00000601/27
on interface 5000000
Cisco MDS 9000 Family Command Reference
6-60
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug ipfc
debug ipfc
To enable IP over Fibre Channel (IPFC) debugging, use the debug ipfc command in EXEC mode. To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug ipfc {all | errors | events | info | kernel {errors | events}}
Syntax Description
all
Enables debugging for all IPFC features.
errors
Enables debugging for IPFC error conditions.
events
Enables debugging for IPFC tx/rx MTS events.
info
Enables debugging for IPFC information.
kernel
Enables debugging for IPFC kernel operations.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug ipfc kernel errors command is
issued:
switch# debug ipfc kernel errors
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-61
Chapter 6
Debug Commands
debug ips
debug ips
To enable debugging for the IP Storage Services (IPS) module, use the debug ips command in EXEC
mode. To disable a debug command, use the no form of the command or use the no debug all command
to turn off all debugging.
debug ips {acl {flow | flow-detail} | all | demux | error | flow {ethernet | fcip} | fsm | ha | init |
iscsi {config | config-detail | flow | flow-detail | msgs} | islb {cfs {config | config-detail | error
| flow | flow-detail} | config | config-detail | flow | flow-detail | vrrp {error | flow |
flow-detail}} | isns {config | config-detail | error | flow | flow-detail | msgs | packet} |
show_all | upgrade}
no debug ips {acl {flow | flow-detail} | all | demux | error | flow {ethernet | fcip} | fsm | ha | init
| iscsi {config | config-detail | flow | flow-detail | msgs} | islb {cfs {config | config-detail |
error | flow | flow-detail} | config | config-detail | flow | flow-detail | vrrp {error | flow |
flow-detail}} | isns {config | config-detail | error | flow | flow-detail | msgs | packet} |
show_all | upgrade}
Syntax Description
acl
Enables debugging for ACLs.
flow
Enables debugging for the IPS flow.
flow-detail
Enables detailed debugging for the IPS flow.
all
Enables all IPS debug options.
demux
Enables debugging for IPS demux.
error
Enables debugging for IPS error conditions.
ethernet
Restricts debugging to the Ethernet flow.
fcip
Restricts debugging to the FCIP flow.
fsm
Enables debugging for IPS FSM and events.
ha
Enables debugging for IPS high availability.
init
Enables debugging of IPS addition, deletion, and initialization.
iscsi
Enables debugging of iSCSI.
config
Enables debugging of the iSCSI configuration.
config-detail
Enables detailed debugging of the iSCSI configuration.
msgs
Enables debugging of the iSCSI messages received and responded.
islb
Enables debugging of iSLB.
cfs
Enables debugging of iSLB CFS.
error
Enables debugging of iSLB CFS error conditions.
flow
Enables debugging for the iSLB CFS flow.
flow-detail
Enables detailed debugging for the iSLB CFS flow.
vrrp
Enables debugging of iSLB VRRP.
error
Enables debugging of iSNS error conditions.
msgs
Enables debugging of the iSNS messages received and responded.
packet
Enables debugging of an iSNS packet.
show_all
Enables all debugging IPS manager flags.
upgrade
Enables debugging for upgrade.
Cisco MDS 9000 Family Command Reference
6-62
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug ips
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.1(1)
This command was introduced.
3.0(1)
Added the iSLB and iSNS options.
Usage Guidelines
Examples
None.
The following example displays the system output when the debug ips show_all command is issued:
switch# debug ips show_all
IPS Manager:
iSCSI Trace Detail debugging is on
Related Commands
Command
Description
no debug all
Disables all debugging.
show ips stats
Displays IP storage statistics.
show ips status
Displays the IP storage status.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-63
Chapter 6
Debug Commands
debug ipsec
debug ipsec
To enable debugging for IPsec, use the debug ipsec command in EXEC mode.To disable a debug
command, use the no form of the command or use the no debug all command to turn off all debugging.
debug ipsec {all | bypass ficon_mgr | config | config-detail | demux | deque | error | event | flow
| flow-detail | ha | trace [detail] | warning}
no debug ipsec {all | bypass ficon_mgr | config | config-detail | demux | deque | error | event |
flow | flow-detail | ha | trace [detail] | warning}
Syntax Description
all
Enables all IPsec debugging.
bypass ficon_mgr
Bypasses the FICON manager.
config
Enables debugging for IPsec configuration.
config-detail
Enables debugging for detailed IPsec configuration.
demux
Enables debugging for IPsec message demux.
deque
Enables debugging for IPsec message dequeue.
error
Enables debugging for IPsec errors.
event
Enables debugging for IPsec FSM and events.
flow
Enables debugging for IPsec flow.
flow-detail
Enables debugging for detailed IPsec flow.
ha
Enables debugging for IPsec high availability.
trace
Enables debugging for IPsec trace.
detail
(Optional) Specifies detailed trace.
warning
Enables debugging for IPsec warning.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, IPsec must be enabled using the crypto ipsec enable command.
Examples
The following example displays the system output when the debug ipsec config command is issued.
switch# debug ipsec config
Cisco MDS 9000 Family Command Reference
6-64
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug ipsec
Related Commands
Command
Description
crypto ipsec enable
Enables IPsec.
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-65
Chapter 6
Debug Commands
debug isns
debug isns
To enable debugging for Internet storage name services (iSNS), use the debug isns command in EXEC
mode. To disable a debug command, use the no form of the command or use the no debug all command
to turn off all debugging.
debug isns {all | bypass ficon_mgr | cloud | db | deque | error | event [vsan vsan-id] |
fabric distribute | ha [vsan vsan-id] | prot | trace [detail] | warning [vsan vsan-id]}
no debug isns {all | bypass ficon_mgr | cloud | db | deque | error | event [vsan vsan-id] |
fabric distribute | ha [vsan vsan-id] | prot | trace [detail] | warning [vsan vsan-id]}
Syntax Description
all
Enables all iSNS debugging.
bypass ficon_mgr
Enables bypassing FICON manager execution.
cloud
Enables debugging for iSNS cloud discovery.
db
Enables debugging for iSNS database.
deque
Enables debugging for iSNS message dequeue.
error
Enables debugging for iSNS error.
event
Enables debugging for iSNS event.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN ID. The range is 1 to
4093.
fabric distribute
Enables debugging for iSNS fabric distribution.
ha
Enables debugging for iSNS high availability.
prot
Enables debugging for iSNS protocol.
trace
Enables debugging for iSNS trace.
detail
(Optional) Enables detailed iSNS trace.
warning
Enables debugging for iSNS warning.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, iSNS must be enabled using the isns-server enable command.
Examples
The following example displays the system output when the debug isns error command is issued.
switch# debug isns error
Cisco MDS 9000 Family Command Reference
6-66
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug isns
Related Commands
Command
Description
isns-server enable
Enables the iSNS server.
no debug all
Disables all debugging.
show isns
Displays iSNS information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-67
Chapter 6
Debug Commands
debug ivr
debug ivr
To enable debugging for inter-VSAN routing (IVR), use the debug ivr command in EXEC mode. To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug {all | demux | dep | dep-detail | dequeue | drav-fsm | drav-fsm-detail | errors |
fcid-rewrite | fcid-rewrite-detail | ficon | ficon-detail | ha | pnat | pv | pv-detail |
state-machine [vsan vsan-id] | test | trace | trace-detail | tu-fsm | tu-fsm-detail |
zone-distrib-errors | zone-distrib-events | zone-fsm | zone-fsm-detail}
no debug {all | demux | dep | dep-detail | dequeue | drav-fsm | drav-fsm-detail | errors |
fcid-rewrite | fcid-rewrite-detail | ficon | ficon-detail | ha | pnat | pv | pv-detail |
state-machine [vsan vsan-id] | test | trace | trace-detail | tu-fsm | tu-fsm-detail |
zone-distrib-errors | zone-distrib-events | zone-fsm | zone-fsm-detail}
Syntax Description
all
Enables all filters for IVR debugging.
demux
Enables debugging of IVR event demultiplexing.
dep
Enables debugging of IVR DEP.
dep-detail
Enables debugging of IVR DEP detail.
dequeue
Enables debugging of IVR event dequeue.
drav-fsm
Enables debugging of IVR DRAV finite state machine (FSM).
drav-fsm-detail
Enables debugging of IVR DRAV FSM detail.
errors
Enables debugging for IVR errors.
fcid-rewrite
Enables debugging of IVR FC ID rewrite.
fcid-rewrite-detail
Enables debugging of IVR FC ID rewrite detail.
ficon
Enables debugging of IVR FICON.
ficon-detail
Enables debugging of IVR FICON detail.
ha
Enables debugging of IVR high-availability.
pnat
Enables debugging of IVR payload Network Address Translation (NAT).
pv
Enables debugging of IVR PV state machine.
pv-detail
Enables debugging of IVR PV state machine detail.
state-machine
Enables debugging of FSM.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
test
Enables debugging of IVR test features.
trace
Enables debugging of IVR trace.
trace-detail
Enables debugging of IVR detail trace.
tu-fsm
Enables debugging of IVR TU FSM.
tu-fsm-detail
Enables debugging of IVR TU FSM detail.
zone-distrib-errors
Enables debugging of IVR zone distribution errors.
zone-distrib-events
Enables debugging of IVR zone distribution events.
zone-fsm
Enables debugging of IVR zone FSM.
zone-fsm-detail
Enables debugging of IVR zone FSM detail.
Cisco MDS 9000 Family Command Reference
6-68
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug ivr
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
2.1(1)
This command was introduced.
3.0(1)
Usage Guidelines
Examples
•
Added the ficon and ficon-detail options.
None.
The following example displays the system output when the debug ivr all command is issued:
switch# debug ivr all
2005 Mar 10 01:27:27 ivr: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
2005 Mar 10 01:27:27 ivr: fu_fsm_execute_all: null fsm_event_list
2005 Mar 10 01:27:27 ivr: fu_fsm_engine_post_event_processing: mts msg
MTS_OPC_DEBUG_WRAP_MSG(msg_id 6774251) dropped
Related Commands
Command
Description
no debug all
Disables all debugging.
show ivr
Displays IVR configurations.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-69
Chapter 6
Debug Commands
debug klm
debug klm
To enable kernel loadable module parameter debugging, use the debug klm command in EXEC mode.
To disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug klm {fc2 {cpuhog seconds | flag flags} | scsi-target {driver | error [vsan vsan-id] [fcid
fc-id] | flag flags | flow [vsan vsan-id] [fcid fc-id] | snmp | syscall} | sdip {all | error | flow |
warning}}
no debug klm {fc2 {cpuhog seconds | flag flags} | scsi-target {driver | error [vsan vsan-id] [fcid
fc-id] | flag flags | flow [vsan vsan-id] [fcid fc-id] | snmp | syscall} | sdip {all | error | flow |
warning}}
Syntax Description
fc2
Enables debugging for FC2 driver debug parameters.
cpuhog seconds
Specifies the FC2 CPU hog value. The ranges is 0 to 10000 seconds.
flag flags
Specifies the flag values. The ranges is 0x0 to 0xffffffff.
scsi-target
Enables debugging for the SCSI target driver.
driver
Enables debugging for SCSI target driver flags.
error
Enables debugging for driver error conditions.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
fcid fc-id
(Optional) Restricts debugging to the specified FCID interface.
flow
Enables debugging for SCSI target flow.
snmp
Enables debugging for SCSI target SNMP requests.
syscall
Enables debugging for SCSI target system call request.
sdip
Enables debugging for the SDIP driver.
all
Enables debugging for the SCSI target driver.
flow
Enables debugging for driver flow.
warning
Enables debugging for driver warnings.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Cisco MDS 9000 Family Command Reference
6-70
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug klm
Examples
The following example displays the system output when the debug klm scsi-target driver command is
issued:
switch# debug klm scsi-target driver
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-71
Chapter 6
Debug Commands
debug license
debug license
To enable licensing debugging, use the debug license command in EXEC mode. To disable a debug
command, use the no form of the command or use the no debug all command to turn off all debugging.
debug license {all | errors | event s | mts}
no debug license {all | errors | events | mts}
Syntax Description
all
Enables debugging for all licensing features.
errors
Enables debugging for licensing error conditions.
events
Enables debugging for the licensing events.
mts
Enables debugging for Tx/Rx packets of MTS.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Examples
None.
The following example displays the system output when the debug license all command is issued:
switch# debug license all
Related Commands
Command
Description
no debug all
Disables all debugging.
show license
Displays license information.
Cisco MDS 9000 Family Command Reference
6-72
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug logfile
debug logfile
To direct the output of the debug commands to a specified file, use the debug logfile command in EXEC
mode. To disable a debug command, use the no form of the command or use the no debug all command
to turn off all debugging.
debug logfile filename [size bytes]
Syntax Description
filename
Assigns the name of the log file. Maximum length is 80 characters.
size bytes
(Optional) Specifies the logfile size in bytes. The range is 4096 to
4194304.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Use this command to log debug messages to a special log file. This file is more secure and easier to
process than sending the debug output to the console.
When you use the debug logfile command to create a log file, the file is automatically created in the log:
directory on the supervisor module unless you specify a different path.
For example, when you use the debug logfile command to create a log file named captureDebug, you
must enter the dir log://sup-local/? command to find the log file you created. This example shows you
how to find the log file created:
switch# debug logfile captureDebug
switch# dir log://sup-local/?
log:
Enter URL "log:[//<module-number>]/<filename>"
log://sup-local/dmesg
log://sup-local/messages
log://sup-local/captureDebug
switch#
Examples
dir log://sup-local/
The following example redirects the output of the debug commands to the file named sample:
switch# debug logfile sample
The following example assigns the log file size for the file named sample:
switch# debug logfile sample size 410000
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-73
Chapter 6
Debug Commands
debug logfile
Related Commands
Command
Description
no debug all
Disables all debugging.
show logging
Displays the current message logging configuration.
Cisco MDS 9000 Family Command Reference
6-74
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug mcast
debug mcast
To enable debugging for multicast definitions, use the debug mcast command in EXEC mode. To disable
a debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug mcast {all | error [vsan vsan-id] [interface fc slot/port] | event [vsan vsan-id] [interface fc
slot/port] | mts {pkt {both | rx [node range | opcode range | sap range] | tx} | pkthdr {both |
rx [numpkt range] | tx}} | trace [vsan vsan-id] [interface fc slot/port]]
no debug mcast {all | error [vsan vsan-id] [interface fc slot/port] | event [vsan vsan-id] [interface
fc slot/port] | mts {pkt {both | rx [node range | opcode range | sap range] | tx} | pkthdr {both
| rx [numpkt range] | tx}} | trace [vsan vsan-id] [interface fc slot/port]]
Syntax Description
all
Enables debugging for all multicast definitions.
error
Enables debugging for multicast errors.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
interface fc slot/port
(Optional) Restricts debugging to the specified interface.
event
Enables debugging for multicast events.
mts
Enables debugging for multicast tx/rx MTS events.
pkt
Specifies debugging of packets.
both
Specifies debugging in both the transmit and receive direction.
rx
Specifies debugging in the receive direction.
node range
Specifies the node for the packets in the receive direction. The integer
range is from 1 to 4096.
opcode range
Specifies the opcode for the packets in the receive direction. The integer
range is from 1 to 4096.
sap range
Specifies the sap for the packets in the receive direction.The integer
range is from 1 to 4096.
tx
Specifies debugging in the transmit direction,
pkthdr
Specifies debugging of headers.
numpkt
Specifies the number of required packets.
trace
Enables debugging for multicast traces.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-75
Chapter 6
Debug Commands
debug mcast
Usage Guidelines
None.
Examples
The following example displays the system output when the debug mcast all command is issued:
switch# debug mcast all
Related Commands
Command
Description
no debug all
Disables all debugging.
show mcast
Displays multicast information.
Cisco MDS 9000 Family Command Reference
6-76
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug mip
debug mip
To enable debugging for multiple IP (MIP) kernel drivers, use the debug mip command in EXEC mode.
To disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug mip {errors | events}
no debug mip {errors | events}
Syntax Description
errors
Enables debugging for MIP error conditions.
events
Enables debugging for MIP events.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug mip errors command is issued:
switch# debug mip errors
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-77
Chapter 6
Debug Commands
debug module
debug module
To enable debugging for switching or service modules, use the debug module command in EXEC mode.
To disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug module {all | error [module slot] | event | ha | no-powerdown | trace [module slot]}
no debug module {all | error [module slot] | event | ha | no-powerdown | trace [module slot]}
Syntax Description
all
Enables debugging for all module features.
error
Enables debugging for module error conditions.
module slot
(Optional) Restricts debugging to the specified module.
event
Enables debugging for module events.
ha
Enables debugging for a module’s high availability features.
no-powerdown
Disables the power cycle feature for the module.
trace
Enables debugging for a module’s trace flows.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug module all command is issued:
switch# debug module all
2005 Mar 10 02:51:01 module: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
2005 Mar 10 02:51:01 module: fu_fsm_execute_all: null fsm_event_list
2005 Mar 10 02:51:01 module: fu_fsm_engine_post_event_processing: mts msg
MTS_OPC_DEBUG_WRAP_MSG(msg_id 6986564) dropped
Related Commands
Command
Description
no debug all
Disables all debugging.
show module
Displays the status of a module.
Cisco MDS 9000 Family Command Reference
6-78
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug ntp
debug ntp
To enable debugging for the Network Time Protocol (NTP) module, use the debug ntp command in
EXEC mode. To disable a debug command, use the no form of the command or use the no debug all
command to turn off all debugging.
debug ntp {errors | info}
no debug ntp {errors | info}
Syntax Description
errors
Enables debugging for NTP error conditions.
info
Enables debugging for NTP information and events.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug ntp info command is issued:
switch# debug ntp info
2005 Mar 10 03:00:42 ntp: Dropping msg_ref with rr_token [7002722]
Related Commands
Command
Description
no debug all
Disables all debugging.
show ntp
Displays the configured NTP server and peer associations.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-79
Chapter 6
Debug Commands
debug npv
debug npv
To enable debugging N Port Virtualization (NPV) configuration on the switch, use the debug npv
command.
debug npv
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
3.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows all NPV debug commands configured on the switch:
switch# show debug npv
N_port Virtualizer:
FC Receive Packets debugging is on
FC Transmit Packets debugging is on
FC Receive Packet header debugging is on
FC Transmit Packet header debugging is on
MTS Receive Packets debugging is on
MTS Transmit Packets debugging is on
MTS Receive Packet header/payload debugging is on
MTS Transmit Packet header/payload debugging is on
High Availability debugging is on
FSM Transitions debugging is on
Error debugging is on
Warning debugging is on
Trace debugging is on
Trace Detail debugging is on
Demux debugging is on
Dequeue debugging is on
Packets debugging is on
Database debugging is on
Timers debugging is on
External Interface FSM Events debugging is on
External Interface FSM Errors debugging is on
External Interface FSM Trace debugging is on
FLOGI FSM Events debugging is on
FLOGI FSM Errors debugging is on
FLOGI FSM Trace debugging is on
Server Interface FSM Events debugging is on
Cisco MDS 9000 Family Command Reference
6-80
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug npv
Server Interface FSM Errors debugging is on
Server Interface FSM Trace debugging is on
Events debugging is on
Related Commands
Command
Description
show debug npv
Displays the NPV debug commands configured on the switch.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-81
Chapter 6
Debug Commands
debug obfl
debug obfl
To enable debugging for Onboard Failure Logging (OBFL), use the debug obfl command in EXEC
mode. To disable a debug command, use the no form of the command or use the no debug all command
to turn off all debugging.
debug obfl {error | trace}
no debug obfl {error | trace}
Syntax Description
error
Enables debugging for OBFL error conditions.
trace
Enables debugging for OBFL events.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug obfl error command is issued:
switch# debug obfl error
2006 Jan 23 21:30:59.573503 obfl: obfl_process_mts_msgs(): OBFL received mts mes
sage: opc:182
Related Commands
Command
Description
no debug all
Disables all debugging.
show logging onboard
Displays OBFL information.
Cisco MDS 9000 Family Command Reference
6-82
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug platform
debug platform
To enable debugging for the platform manager, use the debug platform command in EXEC mode. To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug platform {all [fc_id fc-id] | error [module slot] | flow [module slot] | fsm | ha | hitless |
mts {pkt | pkthdr} {tx | rx} | nopowerdown | supervisor-reset}
no debug platform {all [fc_id fc-id] | error [module slot] | flow [module slot] | fsm | ha | hitless |
mts {pkt | pkthdr} {tx | rx} | nopowerdown | supervisor-reset}
Syntax Description
all
Enables debugging for all platform features.
fcid fc-id
(Optional) Restricts debugging to the specified FC ID module number. The range
is 0 to 2147483647.
error
Enables debugging for platform-related error conditions.
module slot
Restricts debugging to the specified module.
flow
Enables debugging for platform-related flows.
fsm
Enables debugging for platform-related FSMs.
ha
Enables debugging for platform-related high availability.
hitless
Enables the platform loading feature while the switch is in hitless mode.
mts
Enables debugging for platform-related tx/rx MTS events.
pkt
Enables debugging of packets.
pkthdr
Enables debugging of headers.
tx
Enables debugging in the transmit direction.
rx
Enables debugging in the receive direction.
nopowerdown
Enables powering down modules
supervisor-reset
Resets the local supervisor.
pkt
Enables debugging of packets.
pkthdr
Enables debugging of headers.
tx
Enables debugging in the transmit direction.
rx
Enables debugging in the receive direction.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-83
Chapter 6
Debug Commands
debug platform
Usage Guidelines
None.
Examples
The following example displays the system output when the debug platform all command is issued:
switch# debug platform all
2005 Mar 10 03:01:56 platform: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
2005 Mar 10 03:01:56 platform: fu_fsm_execute_all: null fsm_event_list
2005 Mar 10 03:01:56 platform: fu_fsm_engine_post_event_processing: mts msg
MTS_OPC_DEBUG_WRAP_MSG(msg_id 7004045) dropped
v-185# 2005 Mar 10 03:01:56 platform: env_chg_none: ps 0 old 1 new 1
2005 Mar 10 03:01:57 platform: env_chg_none: ps 0 old 1 new 1
2005 Mar 10 03:01:58 platform: env_chg_none: ps 0 old 1 new 1
v-185# debug platform all
2005 Mar 10 03:01:59 platform: fu_priority_select: - setting fd[7] for select call
2005 Mar 10 03:01:59 platform: fu_priority_select_select_queue: round credit(5)
2005 Mar 10 03:01:59 platform:
curr_q - FU_PSEL_Q_CAT_CQ, usr_q_info(0), priority(1),
credit(0), empty
2005 Mar 10 03:01:59 platform: fu_priority_select: returning FU_PSEL_Q_CAT_FD queue,
fd(7), usr_q_info(1)
2005 Mar 10 03:01:59 platform: fu_fsm_engine: line[2139]
.
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-84
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug plog
debug plog
To enable debugging of persistent logging (PLOG), use the debug plog command in EXEC mode. To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug plog {error | trace}
no debug plog {error | trace}
Syntax Description
error
Enables debugging of PLOG error conditions.
trace
Enables debugging of PLOG events.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug plog command is issued:
switch# debug plog
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-85
Chapter 6
Debug Commands
debug port
debug port
To enable debugging for ports, use the debug port command in EXEC mode. To disable a debug
command, use the no form of the command or use the no debug all command to turn off all debugging.
debug port {all | bypass {acl_manager | domain_manager | fcsp | ficon | fport_server | lcp |
loopback_diag | port_channel_mgr | port_lock | qos_mgr | span | switch_wwn | vsan_mgr |
wwn_mgr |xbar_mgr | zone_server} | error | event [interface type number | module slot] | ha
[interface type number | module slot] | trace [interface type number | module slot]}
no debug port {all | bypass {acl_manager | domain_manager | fcsp | ficon | fport_server | lcp |
loopback_diag | port_channel_mgr | port_lock | qos_mgr | span | switch_wwn | vsan_mgr |
wwn_mgr | xbar_mgr | zone_server} | error | event [interface type number | module slot] |
ha [interface type number | module slot] | trace [interface type number | module slot]}
Syntax Description
all
Enables all port debug options.
bypass
Bypasses some components in port execution.
acl_manager
Bypasses ACL manager execution.
domain_manager
Bypasses domain manager execution.
fcsp
Bypasses FCSP execution.
ficon
Bypasses FICON execution.
fport_server
Bypasses FPort server execution.
lcp
Bypasses LCP execution.
loopback_diag
Bypasses loopback diagnostics execution.
port_channel_mgr
Bypasses PortChannel manager execution.
port_lock
Bypasses port lock execution.
qos_mgr
Bypasses QOS manager execution.
span
Bypasses SPAN execution.
switch_wwn
Bypasses using switch WWN and uses VSAN WWN in ELP.
vsan_mgr
Bypasses VSAN manager execution.
wwn_mgr
Bypasses WWN manager execution.
xbar_mgr
Bypasses XBAR manager execution.
error
Enables debugging for port error conditions.
event
Enables debugging for port FSMs and events.
interface type number
(Optional) Restricts debugging to the specified interface.
module slot
(Optional) Restricts debugging to the specified module.
ha
Enables debugging for port high availability.
trace
Enables debugging for port traces.
Defaults
Disabled.
Command Modes
EXEC mode.
Cisco MDS 9000 Family Command Reference
6-86
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug port
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug port all command is issued:
switch# debug port all
Apr 10 00:49:38 port: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
Apr 10 00:49:38 port: fu_fsm_execute_all: null fsm_event_list
Apr 10 00:49:38 port: fu_fsm_engine: mts msg MTS_OPC_DEBUG_WRAP_MSG(msg_id 40239) dropped
The following example displays the system output when the debug port event command is issued:
switch# debug port event
Apr 10 15:30:35 port: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
Apr 10 15:30:35 port: fu_fsm_execute_all: null fsm_event_list
Apr 10 15:30:35 port: fu_fsm_engine: mts msg MTS_OPC_DEBUG_WRAP_MSG(msg_id 7002)
dropped
switch# Apr 10 15:30:35 port: fu_priority_select: - setting fd[3] for select call setting fd[5] for select call - setting fd[6] for select call
Apr 10 15:30:35 port: fu_priority_select_select_queue: round credit(16)
Apr 10 15:30:35 port:
curr_q - FU_PSEL_Q_CAT_FD, usr_q_info(32), fd(5), priority(3),
credit(2), empty
Apr 10 15:30:35 port: fu_priority_select: returning FU_PSEL_Q_CAT_MTS queue, fd(3),
usr_q_info(8)
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-87
Chapter 6
Debug Commands
debug port-channel
debug port-channel
To enable debugging for PortChannels, use the debug port-channel command in EXEC mode. To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug port-channel {all | error | event | ha | trace | warning}
no debug port-channel {all | error | event | ha | trace | warning}
Syntax Description
all
Enables all PortChannel debug options.
error
Enables debugging for PortChannel error conditions.
event
Enables debugging for PortChannel FSMs and events.
ha
Enables debugging for PortChannel high availability.
trace
Enables debugging for PortChannel traces.
warning
Enables debugging for PortChannel warning.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug port-channel all command is issued:
switch# debug port-channel all
2005 Mar 10 03:03:26 port_channel: fu_fsm_execute_all: match_msg_id(0),
log_already_open(0)
2005 Mar 10 03:03:26 port_channel: fu_fsm_execute_all: null fsm_event_list
2005 Mar 10 03:03:26 port_channel: fu_fsm_engine_post_event_processing: mts msg
MTS_OPC_DEBUG_WRAP_MSG(msg_id 7005958) dropped
Related Commands
Command
Description
no debug all
Disables all debugging.
show port-channel
Displays information about existing PortChannel configurations.
Cisco MDS 9000 Family Command Reference
6-88
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug port-resources
debug port-resources
To enable debugging for a port resources module, use the debug port-resources command in EXEC
mode. To disable a debug command, use the no form of the command or use the no debug all command
to turn off all debugging.
debug port-channel {all | demux | deque | error | event | ha | mts | trace | warning}
no debug port-channel {all | demux | deque | error | event | ha | mts | trace | warning}
Syntax Description
all
Enables all port resources debug options.
demux
Enables debugging of port resources messages.
deque
Enables debugging of port resources message dequeues.
error
Enables debugging for port resources error conditions.
event
Enables debugging for port resources FSMs and events.
ha
Enables debugging for port resources high availability.
mts
Enables debugging for port resources message MTS events.
trace
Enables debugging for port resources traces.
warning
Enables debugging for port resources warning.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug port-resources demux command is
issued:
switch# debug port-resources demux vsan 2
2006 Jan 19 22:10:59.244892 port-resources: fu_priority_select: - setting fd[5]
for select call
2006 Jan 19 22:10:59.244985 port-resources: fu_priority_select_select_queue: rou
nd credit(12)
2006 Jan 19 22:10:59.245018 port-resources:
curr_q - FU_PSEL_Q_CAT_CQ, usr_q
_info(2), priority(7), credit(6), empty
2006 Jan 19 22:10:59.245051 port-resources: fu_priority_select: returning FU_PSE
L_Q_CAT_MTS queue, fd(5), usr_q_info(1)
2006 Jan 19 22:10:59.245168 port-resources: prm_get_data_from_queue(664): dequeued mts msg
(128136), MTS_OPC_DEBUG_WRAP_MSG
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-89
Chapter 6
Debug Commands
debug port-resources
2006 Jan 19 22:10:59.245205 port-resources: fu_fsm_engine: line[2205]
2006 Jan 19 22:10:59.245248 port-resources: prm_demux: ev[0]
ips-hac2# 2006 Jan 19 22:10:59.246440 port-resources: fu_fsm_execute_all: match_
msg_id(0), log_already_open(0)
2006 Jan 19 22:10:59.246507 port-resources: fu_fsm_execute_all: null fsm_event_list
2006 Jan 19 22:10:59.246578 port-resources: fu_fsm_engine_post_event_processing:
mts msg MTS_OPC_DEBUG_WRAP_MSG(msg_id 128136) dropped
Related Commands
Command
Description
no debug all
Disables all debugging.
show port-resources
module
Displays information about port resources in a Generation 2 module.
Cisco MDS 9000 Family Command Reference
6-90
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug qos
debug qos
To enable debugging for quality of service (QoS), use the debug qos command in EXEC mode. To
disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug qos {all [interface fc slot/port] | detail | errors supervisor | flow | trace}
no debug qos {all [interface fc slot/port] | detail | errors supervisor | flow | trace}
Syntax Description
all
Enables all QoS debug options.
interface fc slot/port
(Optional) Restricts debugging to the specified interface.
detail
Enables all QoS debug output.
errors supervisor
Enables debugging for supervisor QoS error conditions.
flow
Enables flow-level QoS debug options.
trace
Enables debugging for QoS traces.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug qos all command is issued:
switch# debug qos all
Related Commands
Command
Description
no debug all
Disables all debugging.
show qos
Displays the current QoS settings along with a the number of frames marked
high priority.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-91
Chapter 6
Debug Commands
debug radius
debug radius
To enable debugging for boot variables, use the debug radius command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug radius {aaa-request | aaa-request-lowlevel | all | config | config-lowlevel | server-monitor
| server-monitor-errors}
no debug radius {aaa-request | aaa-request-lowlevel | all | config | config-lowlevel |
server-monitor | server-monitor-errors}
Syntax Description
aaa-request
Enables RADIUS AAA request debug.
aaa-request-lowlevel
Enables RADIUS AAA request low-level debugging.
all
Enables Enable all the debug flags.
config
Enables RADIUS configuration debugging.
config-lowlevel
Enables RADIUS configuring low-level debugging.
server-monitor
Enables RADIUS server monitoring.
server-monitor-errors
Enables RADIUS server monitor errors.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
3.0(1)
Added the server-monitor and server-monitor-errors options.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug radius config-lowlevel command is
issued:
switch# debug radius config-lowlevel
Nov 20 06:36:42 radius: radius_new_debug_conf_open: entering...
Nov 20 06:36:42 radius: radius_new_conf_close: entering...
Nov 20 06:36:42 radius: radius_new_conf_close: returning 0
Nov 20 06:36:42 radius: radius_new_enable_info_config: entering for Radius Daemon debug
Nov 20 06:36:42 radius: radius_new_debug_conf_open: entering...
Nov 20 06:36:42 radius: radius_new_debug_conf_open: exiting
Nov 20 06:36:42 radius: radius_new_enable_info_config: SET_REQ for Radius Daemon debug
with 1
Nov 20 06:36:42 radius: radius_new_enable_info_config: SET_REQ done for Radius Daemon
debug with 1
Cisco MDS 9000 Family Command Reference
6-92
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug radius
Nov 20 06:36:42 radius: radius_new_enable_info_config: got back the return value of
configuration operation:success
Nov 20 06:36:42 radius: radius_new_debug_conf_close: entering...
Nov 20 06:36:42 radius: radius_new_debug_conf_close: returning 0
Nov 20 06:36:42 radius: radius_new_enable_info_config: exiting for Radius Daemon debug
Related Commands
Command
Description
no debug all
Disables all debugging.
show radius
Displays the RADIUS Cisco Fabric Services (CFS) distribution status and
other details.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-93
Chapter 6
Debug Commands
debug rd-reg
debug rd-reg
To enable debugging for the list of devices using the read-register feature, use the debug rd-reg
command in EXEC mode. To disable a debug command, use the no form of the command or use the no
debug all command to turn off all debugging.
debug rd-reg [device-name | register address]
Syntax Description
device-name
(Optional) Specifies the device name for the required device.
register address
(Optional) Specifies the register address for the required device.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug rd-reg abc command is issued:
switch# debug rd-reg abc
switch#
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-94
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug rdl errors
debug rdl errors
To enable debugging for RDL errors, use the debug rdl errors command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug rdl errors
no debug rdl errors
Syntax Description
This command has no other arguments or keywords.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug rdl errors command is issued:
switch# debug rdl errors
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-95
Chapter 6
Debug Commands
debug rib
debug rib
To enable debugging for the routing information base (RIB) feature, use the debug rib command in
EXEC mode. To disable a debug command, use the no form of the command or use the no debug all
command to turn off all debugging.
debug rib {all | detail | error | event | liod_error | liod_event | liod_trace | trace}
no debug rib {all | detail | error | event | liod_error | liod_event | liod_trace | trace}
Syntax Description
all
Enables debugging for all RIB features.
detail
Enables detailed debugging for all RIB features.
error
Enables debugging for RIB errors.
event
Enables debugging for RIB events.
liod_error
Enables debugging for lossless in-order delivery (LIOD) errors.
liod_event
Enables debugging for LIOD errors.
liod_trace
Enables debugging for LIOD trace events.
trace
Enables debugging for trace events.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
3.0(1)
Added the liod_error, liod_event, and liod_trace options.
Usage Guidelines
If a RIB operation is ignored or not supported, then issue the debug rib all command to find out more
details.
Examples
The following example shows the debug rib error command:
switch# debug rib error
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-96
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug rlir
debug rlir
To enable Registered Link Incident Report (RLIR) debugging, use the debug rlir command in EXEC
mode. To disable a debug command, use the no form of the command or use the no debug all command
to turn off all debugging.
debug rlir {all | errors | events | mts-errors | mts-events}
no debug rlir {all | errors | events | mts-errors | mts-events}
Syntax Description
all
Enables debugging for all RLIR features.
errors
Enables debugging for RLIR error conditions.
events
Enables debugging for the RLIR events.
mts-errors
Enables debugging for MTS error conditions.
mts-events
Enables debugging for MTS events.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug rlir all command is issued:
switch# debug rlir all
Related Commands
Command
Description
no debug all
Disables all debugging.
show rlir
Displays information about RLIR, Link Incident Record Registration
(LIRR), and Distribute Registered Link Incident Record (DRLIR) frames.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-97
Chapter 6
Debug Commands
debug rscn
debug rscn
To enable debugging for the registered state change notification (RSCN) feature, use the debug rscn
command in EXEC mode. To disable a debug command, use the no form of the command or use the no
debug all command to turn off all debugging.
debug rscn {all | errors | events | mts-errors | mts-events} [vsan vsan-id]
no debug rscn {all | errors | events | mts-errors | mts-events} [vsan vsan-id]
Syntax Description
all
Enables debugging for all RSCN features.
errors
Enables debugging for RSCN errors.
events
Enables debugging for RSCN events.
mts-errors
Enables debugging for RSCN MTS errors.
mts-events
Enables debugging for RSCN MTS events.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug rscn errors command is issued:
switch# debug rscn errors
Related Commands
Command
Description
no debug all
Disables all debugging.
show rscn
Displays RSCN information.
Cisco MDS 9000 Family Command Reference
6-98
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug san-ext-tuner
debug san-ext-tuner
To enable debugging for SAN extension tuner, use the debug san-ext-tuner command in EXEC mode.
To disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug isns {all | demux | deque | error | event | ha | trace [detail] | warning}
no debug isns {all | demux | deque | error | event | ha | trace [detail] | warning}
Syntax Description
all
Enables all SAN extension tuner debugging.
demux
Enables debugging for SAN extension tuner message demux.
deque
Enables debugging for SAN extension tuner message dequeue.
error
Enables debugging for SAN extension tuner error conditions.
event
Enables debugging for SAN extension tuner events.
ha
Enables debugging for SAN extension tuner high availability.
trace
Enables debugging for SAN extension tuner trace.
detail
(Optional) Enables detailed debugging for SAN extension tuner trace.
warning
Enables debugging for SAN extension tuner warnings.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug san-ext-tuner error command is
issued:
switch# debug san-ext-tuner error
Related Commands
Command
Description
isns-server enable
Enables the iSNS server.
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-99
Chapter 6
Debug Commands
debug san-ext-tuner
Command
Description
show isns
Displays iSNS information.
show san-ext-tuner
Displays SAN extension tuner information.
Cisco MDS 9000 Family Command Reference
6-100
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug scsi-flow
debug scsi-flow
To enable debugging of a SCSI flow, use the debug scsi-flow command. To disable a debug command,
use the no form of the command or use the no debug all command to turn off all debugging.
debug scsi-flow {all | demux vsan vsan-id | deque | error | event vsan vsan-id | ha | trace {detail
vsan vsan-id | vsan vsan-id} | warning vsan vsan-id}
no debug scsi-flow {all | demux vsan vsan-id | deque | error | event vsan vsan-id | ha | trace
{detail vsan vsan-id | vsan vsan-id} | warning vsan vsan-id}
Syntax Description
all
Enables all debug flags for all SCSI flows.
demux
Enables debugging for SCSI flow demux functions.
vsan vsan-id
Restricts debugging to the specified VSAN. The range is 1 to 4093.
deque
Enables debugging for SCSI flow deque events.
error
Enables debugging for SCSI flow errors.
event
Enables debugging for SCSI flow events.
ha
Enables debugging for SCSI flow high availability events.
trace
Enables debugging for SCSI flow traces.
detail
Enables debugging of SCSI flow detail trace.
warning
Enables debugging for SCSI flow warning messages.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
2.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example enables all debug flags for all SCSI flows:
switch# debug scsi-flow all
2004 Nov 29 17:24:49 sfm: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
2004 Nov 29 17:24:49 sfm: fu_fsm_execute_all: null fsm_event_list
2004 Nov 29 17:24:49 sfm: fu_fsm_engine_post_event_processing: mts msg
MTS_OPC_DEBUG_WRAP_MSG(msg_id 536440) dropped
switch#
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-101
Chapter 6
Debug Commands
debug scsi-flow
Related Commands
Command
Description
no debug all
Disables all debugging.
show scsi-flow
Displays SCSI flow information.
Cisco MDS 9000 Family Command Reference
6-102
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug scsi-target
debug scsi-target
To enable debugging for SCSI targets, use the debug scsi-target command in EXEC mode. To disable
a debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug scsi-target {error | flow}
no debug scsi-target {error | flow}
Syntax Description
error
Enables debugging for SCSI target daemon error conditions.
flow
Enables debugging for the SCSI target flow.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.1(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug scsi-target flow command is issued:
switch# debug scsi-target flow
Apr 28 21:11:52 vhbad: vhba_mts_handler: sdwrap_dispatch: retval:0
Apr 28 21:11:54 vhbad: vhbad_handle_timeout: timer:1 context:(nil)
Apr 28 21:12:06 vhbad: vhba_mts_handler: sysmgr_dispatch: retval:-1
Related Commands
Command
Description
no debug all
Disables all debugging.
show scsi-target
Displays information about existing SCSI target configurations.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-103
Chapter 6
Debug Commands
debug sdv
debug sdv
To enable debugging for SAN device virtualization, use the debug sdv command in EXEC mode.
debug sdv {all | all-sdv | ddas {errors | events} | ddas-config {errors | events | packets} |
discovery {errors vsan vsan-id | events vsan vsan-id} | distribution {errors vsan vsan-id |
events vsan vsan-id} | errors vsan vsan-id | fu {ha | transition} | mgmt {errors | events} | ns
{errors | events | packets} | rewrite {errors | events | packets} | trace vsan vsan-id |
virtual-domain {errors vsan vsan-id | events vsan vsan-id} | zone-activation {errors | events
| packets}}
Syntax Description
all
Configures all SDV debugs.
all-sdv
Configures all filters for SDV debugging.
ddas
Enables the DDAS debugs.
errors
Enables debugs for errors.
events
Enables debugs for events.
ddas-config
Enables the DDAS-CFG debugs.
packets
Enables debugs for packets.
discovery
Enables the Disc debugs.
vsan vsan-id
Specifies the number of the VSAN. The range is 1 to 4093.
distribution
Enables the Dist debugs.
errors
Enables the Error debugs.
fu
Enables the FU debugs.
ha
Enables the FU HA debugs.
transition
Enables the transition debugs.
mgmt
Enables the Config FSM debugs.
ns
Enables the NS debugs.
rewrite
Enables the Rewrite debugs.
trace
Enables the Trace debugs.
virtual-domain
Enables the Virtual Domain debugs.
zone-activation
Enables the ZS-ACTV debugs.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
3.1(2)
This command was introduced.
Cisco MDS 9000 Family Command Reference
6-104
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug sdv
Usage Guidelines
None.
Examples
The following example displays the system output when the debug sdv all command is issued.
switch# debug sdv all
2007 Jan 26 22:17:25.232055 sdv: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
2007 Jan 26 22:17:25.232151 sdv: fu_fsm_execute_all: null fsm_event_list
2007 Jan 26 22:17:25.232233 sdv: fu_fsm_engine_post_event_processing: mts msg
MTS_OPC_DEBUG_WRAP_MSG(msg_id 83409) dropped
Related Commands
Command
Description
sdv enable
Enables or disables SAN device virtualization.
show sdv statistics
Displays SAN device virtualization statistics.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-105
Chapter 6
Debug Commands
debug security
debug security
To enable debugging for the security and accounting features, use the debug security command in
EXEC mode. To disable a debug command, use the no form of the command or use the no debug all
command to turn off all debugging.
debug security {all | events | mts | radius}
no debug security {all | events | mts | radius}
Syntax Description
all
Enables debugging for all security features.
events
Enables debugging for security events.
mts
Enables debugging for security MTS packets.
radius
Enables debugging for RADIUS events.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Examples
None.
The following example displays the system output when the debug security radius command is issued:
switch# debug security radius
Mar 5 00:51:13 securityd: RADIUS is enabled, hence it will be tried first for CHAP
authentication
Mar 5 00:51:13 securityd: reading RADIUS configuration
Mar 5 00:51:13 securityd: opening radius configuration for group:default
Mar 5 00:51:13 securityd: opened the configuration successfully
Mar 5 00:51:13 securityd: GET request for RADIUS global config
Mar 5 00:51:13 securityd: got back the return value of global radius configuration
operation:success
Mar 5 00:51:13 securityd: closing RADIUS pss configuration
Mar 5 00:51:13 securityd: opening radius configuration for group:default
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-106
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug sensor
debug sensor
To enable debugging for the sensor manager, use the debug sensor command in EXEC mode. To disable
a debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug sensor {demux | deque | error | info | init}
no debug sensor {demux | deque | error | info | init}
Syntax Description
demux
Enables debugging for sensor demux functions.
deque
Enables debugging for sensor deque events.
error
Enables debugging for sensor errors.
info
Enables debugging for sensor information.
init
Enables debugging for sensor initialization.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Use this command to debug sensor manager events and information.
Examples
The following example displays the system output when the debug sensor info command is issued:
switch# debug sensor info
Related Commands
Command
Description
no debug all
Disables all debugging.
show environment temperature
Displays current temperature threshold settings and state.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-107
Chapter 6
Debug Commands
debug sme
debug sme
To enable debugging for the Cisco SME features, use the debug sme command. To disable a debug
command, use the no form of the command.
debug sme {all | demux vsan vsan id | deque | error | event vsan vsan id | ha vsan vsan id | trace
vsan vsan id | trace-detail vsan vsan id | warning vsan vsan id}
no debug sme {all | demux vsan vsan id | deque | error | event vsan vsan id | ha vsan vsan id |
trace vsan vsan id | trace-detail vsan vsan id | warning vsan vsan id}
Syntax Description
all
Enables debugging of all Cisco SME features.
demux
Enables debugging of Cisco SME message demux.
vsan vsan id
Restricts debugging to a specified VSAN ID. The range is 1 to 4094.
deque
Enables debugging of Cisco SME message dequeue.
error
Enables debugging of Cisco SME errors.
event
Enables debugging of Cisco SME finite state machine (FSM) and events.
ha
Enables debugging of Cisco SME high availability (HA).
trace
Enables debugging of Cisco SME trace.
trace-detail
Enables debugging of Cisco SME trace-detail.
warning
Enables debugging of Cisco SME warning.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
3.2(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output from the debug sme all command:
switch# debug sme all
2007 Sep 23 15:44:44.490796 sme:
call
2007 Sep 23 15:44:44.490886 sme:
)
2007 Sep 23 15:44:44.490918 sme:
riority(7), credit(4), empty
2007 Sep 23 15:44:44.490952 sme:
queue, fd(5), usr_q_info(1)
2007 Sep 23 15:44:44.491059 sme:
fu_priority_select:
- setting fd[5] for select
fu_priority_select_select_queue: round credit(8
curr_q - FU_PSEL_Q_CAT_CQ, usr_q_info(2), p
fu_priority_select: returning FU_PSEL_Q_CAT_MTS
sme_get_data_from_queue(1031): dequeued mts msg
Cisco MDS 9000 Family Command Reference
6-108
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug sme
(34916564), MTS_OPC_DEBUG_WRAP_MSG
2007 Sep 23 15:44:44.491096 sme: fu_fsm_engine: line[2253]
2007 Sep 23 15:44:44.492596 sme: fu_fsm_execute_all: match_msg_id(0), log_alread
y_open(0)
Related Commands
Command
Description
no debug all
Disables all debugging.
show sme
Displays all information about Cisco SME.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-109
Chapter 6
Debug Commands
debug snmp
debug snmp
To enable debugging for the SNMP manager, use the debug snmp command in EXEC mode. To disable
a debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug snmp {all | errors | mts {pkt {both | rx [node range | opcode range | sap range] | tx} |
pkthdr {both | rx [numpkt range] | tx}} | pkt-dump | trace {trace-entryexit | trace-stub}}
no debug snmp {all | errors | mts {pkt {both | rx [node range | opcode range | sap range] | tx} |
pkthdr {both | rx [numpkt range] | tx}} | pkt-dump | trace {trace-entryexit | trace-stub}}
Syntax Description
all
Enables debugging for all SNMP output.
errors
Enables debugging for SNMP error output.
mts
Enables debugging for SNMP packets and headers.
pkt
Specifies debugging of packets.
both
Specifies debugging in both the transmit and receive directions.
rx
Specifies debugging in the receive direction.
node range
(Optional) Specifies the node for the packets in the receive direction.
The integer range from 1 to 4095.
opcode range
(Optional) Specifies the opcode for the packets in the receive direction.
The integer range from 1 to 4095.
sap range
(Optional)Specifies the SAP for the packets in the receive direction. The
integer range from 1 to 4095.
tx
Specifies debugging in the transmit direction.
pkt
Specifies debugging of packets.
numpkt range
(Optional) Specifies the number of required packets.
trace
Enables trace level debug output.
trace-entryexit
Specifies trace-level entry or exit debug output.
trace-stub
Specifies trace-level stub debug output.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Cisco MDS 9000 Family Command Reference
6-110
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug snmp
Examples
The following example displays the system output when the debug snmp trace command is issued:
switch# debug snmp trace
Apr 29 16:03:34 snmpd[1177]: SDWRAP message Successfully processed
Related Commands
Command
Description
no debug all
Disables all debugging.
show snmp
Displays SNMP status and setting information.
snmp-server
Configures the SNMP server information, switch location, and switch
name.
snmp-server enable
traps
Enables SNMP server notifications (informs and traps).
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-111
Chapter 6
Debug Commands
debug span
debug span
To enable SPAN debugging, use the debug span command in EXEC mode. To disable a debug
command, use the no form of the command or use the no debug all command to turn off all debugging.
debug span {all | buffer-size bytes | error | event | trace | warning}
no debug span {all | error | event | trace | warning}
Syntax Description
all
Enables debugging for all SPAN features.
buffer-size bytes
Configures event logs buffer size for SPAN. The range is 4096 to 131072.
error
Enables debugging for SPAN errors.
event
Enables debugging for SPAN events.
trace
Enables debugging for SPAN traces.
warning
Enables debugging for SPAN warning messages.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug span all command is issued:
switch# debug span all
Apr 29 16:06:44 span: span_demux: msg consumed by sdwrap_process msg
Apr 29 16:06:44 span: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
Apr 29 16:06:44 span: fu_fsm_execute_all: null fsm_event_list
Apr 29 16:06:44 span: fu_fsm_engine: mts msg MTS_OPC_DEBUG_WRAP_MSG(msg_id 2548887)
dropped
Apr 29 16:06:48 span: fu_priority_select: - setting fd[3] for select call
Apr 29 16:06:48 span: fu_priority_select_select_queue: round credit(12)
Apr 29 16:06:48 span:
curr_q - FU_PSEL_Q_CAT_CQ, usr_q_info(4), priority(7),
credit(6), empty
Apr 29 16:06:48 span: fu_priority_select: returning FU_PSEL_Q_CAT_MTS queue, fd(3),
usr_q_info(2)
Apr 29 16:06:48 span: span_get_data_from_mts_q dequeued mts msg (26e525),
MTS_OPC_DEBUG_WRAP_MSG
Cisco MDS 9000 Family Command Reference
6-112
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug span
Related Commands
Command
Description
no debug all
Disables all debugging.
show span session
Displays specific information about a Switched Port Analyzer (SPAN)
session.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-113
Chapter 6
Debug Commands
debug system health
debug system health
To enable system health monitoring debugging, use the debug system health command in EXEC mode.
To disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug system health {all | asic-counters | battery-charger | bootflash | cache-disk | cfr | eobc |
error | event | external-loopback | failure-analysis | fc2 | free-disk | ha | inband | loopback |
mgmt | misc | mts | nvram | plog | pss | serdes | special | trace | xipc}
no debug system health {all | asic-counters | battery-charger | bootflash | cache-disk | cfr | eobc
| error | event | external-loopback | failure-analysis | fc2 | free-disk | ha | inband | loopback
| mgmt | misc | mts | nvram | plog | pss | serdes | special | trace | xipc}
Syntax Description
Defaults
all
Enables debugging of all online health flags.
asic-counters
Enables debugging of system health ASIC statistics.
battery-charger
Enables debugging of system health battery charger tests.
bootflash
Enables debugging of system health bootflash tests.
cache-disk
Enables debugging of system health cache-disk tests.
cfr
Enables debugging of system health compact health tests.
eobc
Enables debugging of system health EOBC tests.
error
Enables debugging of system health error conditions.
event
Enables debugging of system health events.
external-loopback
Enables debugging of system health external loopback tests.
failure-analysis
Enables debugging of system health failure analysis.
fc2
Enables debugging of system health FC2 frames.
free-disk
Enables debugging of system health free disk.
ha
Enables debugging of health monitoring HA flags.
inband
Enables debugging of system health inband tests.
loopback
Enables debugging of system health loopback tests.
mgmt
Enables debugging of system health management-port port tests.
misc
Enables debugging of system health misc.
mts
Enables debugging of system health MTS.
nvram
Enables debugging of system health nvram.
plog
Enables debugging of system health persistent logging.
pss
Enables debugging of system health pss.
serdes
Enables debugging of system health SerDes tests.
special
Enables debugging of system health special.
trace
Enables debugging of health monitoring trace flags.
xipc
Enables debugging of system health XIPC.
Disabled.
Cisco MDS 9000 Family Command Reference
6-114
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug system health
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
3.0(1)
Added the free-disk, nvram, and plog options.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug system health command is issued:
switch# debug system health all
2005 Mar 10 01:49:28 SystemHealth: ohms_snake_fd_activity: Module 1 Snake Frame came.
2005 Mar 10 01:49:28 SystemHealth: ohms_snake_fd_activity: Module 8 waiting for Snake
Frame to come.
2005 Mar 10 01:49:28 SystemHealth: ohms_dequeue: select timeout 0 998000
2005 Mar 10 01:49:28 SystemHealth: fu_priority_select: - setting fd[4] for select call setting fd[20] for select call - setting fd[22] for select call - setting fd[28] for
select call - setting fd[29] for select call - setting fd[30] for select call
2005 Mar 10 01:49:28 SystemHealth: fu_priority_select_select_queue: round credit(14)
2005 Mar 10 01:49:28 SystemHealth:
curr_q - FU_PSEL_Q_CAT_FD, usr_q_info(466240),
fd(29), priority(6), credit(3), empty
2005 Mar 10 01:49:28 SystemHealth: fu_priority_select: returning FU_PSEL_Q_CAT_CQ queue,
usr_q_info(1)
2005 Mar 10 01:49:28 SystemHealth: ohms_dequeue: Select woken up
2005 Mar 10 01:49:28 SystemHealth: ohms_dequeue: Process event type 0x1
2005 Mar 10 01:49:28 SystemHealth: ohms_dequeue: Processing timer type
2005 Mar 10 01:49:28 SystemHealth: fu_fsm_engine: line[2139]
2005 Mar 10 01:49:28 SystemHealth: fu_fsm_handle_sysmgr_msg: Not mts event
2005 Mar 10 01:49:28 SystemHealth: ohms_timer_event_handler: called.
2005 Mar 10 01:49:28 SystemHealth: fu_fsm_execute_all: match_msg_id(0),
log_already_open(0)
.
Related Commands
Command
Description
no debug all
Disables all debugging.
show system health
Displays configured Online Health Management System (OHMS)
information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-115
Chapter 6
Debug Commands
debug tacacs+
debug tacacs+
To enable debugging for boot variables, use the debug tacacs+ command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug tacacs+ {aaa-request | aaa-request-lowlevel | all | config | config-lowlevel |
server-monitor | server-monitor-errors}
no debug tacacs+ {aaa-request | aaa-request-lowlevel | all | config | config-lowlevel |
server-monitor | server-monitor-errors}
Syntax Description
aaa-request
Enables TACACS+ AAA request debug.
aaa-request-lowlevel
Enables TACACS+ AAA request low-level debugging.
all
Enables all the debug flags.
config
Enables TACACS+ configuration debugging.
config-lowlevel
Enables TACACS+ configuring low-level debugging.
server-monitor
Enables TACACS+ server monitoring.
server-monitor-errors
Enables TACACS+ server monitor errors.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
3.0(1)
Added the server-monitor and server-monitor-errors options.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug tacacs+ config-lowlevel command
is issued:
switch# debug tacacs+ config-lowlevel
Nov 20 06:39:44 tacacs: tacacs_debug_conf_open: entering...
172.22.94.252# Nov 20 06:39:44 tacacs: tacacs_debug_conf_open: exiting
Nov 20 06:39:44 tacacs: tacacs_conf_close: entering...
Nov 20 06:39:44 tacacs: tacacs_conf_close: returning 0
Nov 20 06:39:44 tacacs: tacacs_enable_info_config: entering for TACACS+ Daemon debug
Nov 20 06:39:44 tacacs: tacacs_debug_conf_open: entering...
Nov 20 06:39:44 tacacs: tacacs_debug_conf_open: exiting
Nov 20 06:39:44 tacacs: tacacs_enable_info_config: SET_REQ for TACACS+ Daemon debug with 1
Nov 20 06:39:44 tacacs: tacacs_enable_info_config: SET_REQ done for TACACS+ Daemon debug
with 1
Cisco MDS 9000 Family Command Reference
6-116
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug tacacs+
Nov 20 06:39:44 tacacs: tacacs_enable_info_config: got back the return value of
configuration operation:success
Nov 20 06:39:44 tacacs: tacacs_debug_conf_close: entering...
Nov 20 06:39:44 tacacs: tacacs_debug_conf_close: returning 0
Nov 20 06:39:44 tacacs: tacacs_enable_info_config: exiting for TACACS+ Daemon debug
Related Commands
Command
Description
no debug all
Disables all debugging.
show tacacs+
Displays the TACACS+ Cisco Fabric Services (CFS) distribution status and
other details.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-117
Chapter 6
Debug Commands
debug tcap
debug tcap
To enable debugging the exception logger, use the debug tcap command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug tcap {demux | deque | error | info | init}
no debug tcap {demux | deque | error | info | init}
Syntax Description
demux
Enables debugging for terminal capture demux functions.
deque
Enables debugging for terminal capture deque events.
error
Enables debugging for terminal capture errors.
info
Enables debugging for terminal capture information.
init
Enables debugging for terminal capture initialization.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Use this command to debug terminal capture utility events and information.
Examples
The following example displays the system output when the debug tcap demux command is issued:
switch# debug tcap demux
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-118
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug tlport
debug tlport
To enable debugging for TL port interfaces, use the debug tlport command in EXEC mode. To disable
a debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug tlport {all | errors | events {fc2 {terminal | transit} | mts | pss}} [interface fc slot/port]
no debug tlport {all | errors | events {fc2 {terminal | transit} | mts | pss}} [interface fc slot/port]
Syntax Description
all
Enables debugging for all TL port features.
errors
Enables debugging for TL port error conditions.
events
Enables debugging for TL port monitoring events.
fc2
Enables debugging for TL port monitoring FC 2 events.
terminal
Specifies TL port monitoring FC 2 terminating events.
transit
Specifies TL port monitoring FC 2 transit events.
mts
Enables debugging for TL port monitoring MTS packets.
pss
Enables debugging for TL port monitoring PSS packets.
interface fc slot/port
(Optional) Restricts debugging to the specified interface.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug tlport events pss command is issued:
switch# debug tlport events pss
Related Commands
Command
Description
no debug all
Disables all debugging.
show tlport
Displays configured TL port information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-119
Chapter 6
Debug Commands
debug ttyd
debug ttyd
To enable TTYD debugging, use the debug ttyd command in EXEC mode. To disable a debug
command, use the no form of the command or use the no debug all command to turn off all debugging.
debug ttyd {all | errors | events}
no debug ttyd {all | errors | events}
Syntax Description
all
Enables debugging for all TTYD features.
errors
Enables debugging for TTYD error conditions.
events
Enables debugging for TTYD events.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug ttyd events command is issued:
switch# debug ttyd events
switch#
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-120
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug vni
debug vni
To enable debugging for a virtual network interface (VNI), use the debug vni command in EXEC mode.
To disable a debug command, use the no form of the command or use the no debug all command to turn
off all debugging.
debug vni {all | errors | events | info | pss}
no debug vni {all | errors | events | info | pss}
Syntax Description
all
Enables debugging for all VNI features.
errors
Enables debugging for VNI error conditions.
events
Enables debugging for VNI events.
info
Enables debugging for VNI events.
pss
Enables debugging for VNI PSS packets.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug vni all command is issued:
switch# debug vni all
Apr 29 17:00:59 vni: Received MTS message
Apr 29 17:00:59 vni: message not processed by system mgr library , so process it normal
way
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-121
Chapter 6
Debug Commands
debug vrrp
debug vrrp
To enable debugging for a Virtual Router Redundancy Protocol (VRRP), use the debug vrrp command
in EXEC mode. To disable a debug command, use the no form of the command or use the no debug all
command to turn off all debugging.
debug vrrp {configuration | engine} {all | error | event | info}
no debug vrrp {configuration | engine} {all | error | event | info}
Syntax Description
configuration
Enables VRRP configuration debugging.
engine
Enables VRRP engine debugging.
all
Enables debugging for all VRRP features.
error
Enables debugging for VRRP error conditions.
event
Enables debugging for VRRP events.
info
Enables debugging for VRRP events.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug vrrp engine all command is issued:
switch# debug vrrp engine all
Apr 29 17:35:58 vrrp_eng: fu_priority_select: - setting fd[7] for select call - setting
fd[11] for select call - setting fd[12] for select call - setting fd [13] for select
call - setting fd[15] for select call
Apr 29 17:35:58 vrrp_eng: fu_priority_select_select_queue: round credit(6)
Apr 29 17:35:58 vrrp_eng:
curr_q - FU_PSEL_Q_CAT_FD, usr_q_info(6), fd(15),
priority(2), credit(1), empty
Apr 29 17:35:58 vrrp_eng: fu_priority_select: returning FU_PSEL_Q_CAT_FD queue, fd(7),
usr_q_info(3)
Apr 29 17:35:58 vrrp_eng: heartbeat sent
Apr 29 17:35:58 vrrp_eng: message not processed by system mgr library , so process it
normal way
Cisco MDS 9000 Family Command Reference
6-122
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug vrrp
Related Commands
Command
Description
no debug all
Disables all debugging.
show vrrp
Displays VRRP configuration information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-123
Chapter 6
Debug Commands
debug vsan
debug vsan
To enable debugging for VSANs, use the debug vsan command in EXEC mode. To disable a debug
command, use the no form of the command or use the no debug all command to turn off all debugging.
debug vsan {all | global | ha | info | membership | mts}
no debug vsan {all | global | ha | info | membership | mts}
Syntax Description
all
Enables all debugging flags for the VSAN feature.
global
Enables debugging of events for the VSAN global parameter database
ha
Enables debugging of VSAN's HA-related events.
info
Enables debugging of events for VSAN information database.
membership
Enables debugging of events for VSAN membership database.
mts
Enables debugging of Tx/Rx packets of MTS.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug vsan all command is issued:
switch# debug vsan all
2005 Mar 10 01:44:35 vsan: Calling handling function
2005 Mar 10 01:44:35 vsan: querying trunking membership(readonly) for interface:16859136
2005 Mar 10 01:44:35 vsan: Replying to trunking membership query for interface:fc1/21 with
VSAN bitmap:1-4093
2005 Mar 10 01:44:35 vsan: got back reply_code:0
2005 Mar 10 01:44:35 vsan: Returned from handling function
2005 Mar 10 01:44:35 vsan: Freeing notifications
2005 Mar 10 01:44:35 vsan: Src: 0x00000601/15 Dst: 0x00000601/27 ID: 0x0067CEA1 Size:
520 [RSP] Opc: 116 (MTS_OPC_VSAN_GET_PORT_TRUNKING_MEMBERSHIP) RR: 0x0067CEA0 HA_SEQNO:
0x00000000 TS: 0x24E717EAC7CE2 REJ:0 SYNC:1
2005 Mar 10 01:44:35 vsan: 00 00 00 00 00 00 02 00 7F FF FF FF FF FF FF FF
2005 Mar 10 01:44:35 vsan: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
2005 Mar 10 01:44:35 vsan: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
2005 Mar 10 01:44:35 vsan: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
2005 Mar 10 01:44:35 vsan: FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF FF
.
Cisco MDS 9000 Family Command Reference
6-124
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug vsan
Related Commands
Command
Description
no debug all
Disables all debugging.
show vsan
Displays information about configured VSANs.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-125
Chapter 6
Debug Commands
debug wr-reg
debug wr-reg
To enable debugging for the list of devices using the write-register feature, use the debug wr-reg
command in EXEC mode. To disable a debug command, use the no form of the command or use the no
debug all command to turn off all debugging.
debug wr-reg [device-name | register-address]
no debug wr-reg [device-name | register-address]
Syntax Description
device-name
(Optional) Specifies the device name for the required device.
register-address
(Optional) Specifies the register address for the required device.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug wr-reg command is issued:
switch# debug wr-reg
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-126
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug wwn
debug wwn
To enable debugging for the world wide name (WWN) manager, use the debug wwn command in EXEC
mode. To disable a debug command, use the no form of the command or use the no debug all command
to turn off all debugging.
debug wwn {all | detail | errors | flow | trace}
no debug wwn {all | detail | errors | flow | trace}
Syntax Description
all
Enables all WWN debug options.
detail
Enables all WWN output
errors
Enables debugging for WWN error conditions.
flow
Enables flow-level WWN debug options.
trace
Enables debugging for WWN traces.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug wwn all command is issued:
switch# debug wwn all
Apr 29 19:24:17 wwn: 53601-wwnm_sdwrap_dispatch:77|SDWRAP massage Successfully processed
Apr 29 19:24:17 wwn: Src: 0x00000601/5206 Dst: 0x00000601/46 ID: 0x002C7DE4 Size: 252
[REQ] Opc: 182 (MTS_OPC_DEBUG_WRAP_MSG) RR: 0x002C7DE4 HA_SEQNO: 0x00000000 TS:
0x55D49A130243 REJ:0
Apr 29 19:24:17 wwn: 2F 64 65 76 2F 70 74 73 2F 30 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Apr 29 19:24:17 wwn: 00 00 00 00 00 00 00 00 2E 00 00 00
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-127
Chapter 6
Debug Commands
debug wwn
Apr 29 19:24:17 wwn: 53601-wwnm_unmask_sigalrm:1261|TRACE:
FILE=_manager/wwnm/wwnm_utilities.c
Related Commands
Command
Description
no debug all
Disables all debugging.
show wwn
Displays the status of the WWN configuration.
Cisco MDS 9000 Family Command Reference
6-128
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug xbar
debug xbar
To enable crossbar debugging (XBAR), use the debug xbar command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug xbar {all | demux | deque | error [module slot] | fsm [module slot] | ha [module slot] |
init | main}
no debug xbar {all | demux | deque | error [module slot] | fsm [module slot] | ha [module slot] |
init | main}
Syntax Description
all
Enables all XBAR debug options.
demux
Enables debugging for XBAR demux functions.
deque
Enables debugging for XBAR deque events.
error
Enables debugging for XBAR errors.
module slot
(Optional) Specifies the slot number of the module being debugged.
fsm
Enables debugging for XBAR FSMs.
ha
Enables debugging for XBAR high availability information.
init
Enables debugging for XBAR initialization.
main
Enables XBAR debugging for main functions.
Defaults
Enabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug xbar all command is issued:
switch# debug xbar all
Apr 29 19:48:34 xbar: its a sdwrap msg, fsm utils dropping the mts msg
Apr 29 19:48:34 xbar: fu_fsm_engine: (Error) SYSERR_FU_xx: 0x10, err_num (16) in demux
Apr 29 19:48:34 xbar: fu_fsm_execute_all: match_msg_id(0), log_already_open(0)
Apr 29 19:48:34 xbar: fu_fsm_execute_all: null fsm_event_list
...
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-129
Chapter 6
Debug Commands
debug xbar
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-130
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug xbar_driver
debug xbar_driver
To enable debugging of the crossbar driver (XBAR driver), use the debug xbar_driver command in
EXEC mode. To disable a debug command, use the no form of the command or use the no debug all
command to turn off all debugging.
debug xbar {error | flow | trace}
no debug xbar {error | flow | trace}
Syntax Description
error
Enables debugging of XBAR driver errors.
flow
Enables debugging of the XBAR driver flow.
trace
Enables debugging of the XBAR driver trace.
Defaults
Enabled.
Command Modes
EXEC mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example displays the system output when the debug xbar_driver command is issued:
switch# debug xbar_driver error
switch# 2006 Jan 23 22:02:41.770329 xbar_driver: sc_stats_timer_hdlr called
2006 Jan 23 22:03:41.780356 xbar_driver: sc_stats_timer_hdlr called
2006 Jan 23 22:04:41.780356 xbar_driver: sc_stats_timer_hdlr called
2006 Jan 23 22:05:41.780357 xbar_driver: sc_stats_timer_hdlr called
2006 Jan 23 22:06:41.780356 xbar_driver: sc_stats_timer_hdlr called
2006 Jan 23 22:07:41.780359 xbar_driver: sc_stats_timer_hdlr called
2006 Jan 23 22:08:41.790341 xbar_driver: sc_stats_timer_hdlr called...
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-131
Chapter 6
Debug Commands
debug xbc
debug xbc
To enable crossbar client debugging (XBC), use the debug xbc command in EXEC mode. To disable a
debug command, use the no form of the command or use the no debug all command to turn off all
debugging.
debug xbc {demux | deque | init | main}
no debug xbc {demux | deque | init | main}
Syntax Description
demux
Enables debugging for crossbar demux functions.
deque
Enables debugging for crossbar deque events.
init
Enables debugging for crossbar initialization.
main
Enables debugging for crossbar main functions.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Examples
Use this command to debug crossbar client events and information.
The following example displays the system output when the debug xbc init command is issued:
switch# debug xbc init
Related Commands
Command
Description
no debug all
Disables all debugging.
Cisco MDS 9000 Family Command Reference
6-132
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 6
Debug Commands
debug zone
debug zone
To enable debugging for zones, use the debug zone command in EXEC mode. To disable a debug
command, use the no form of the command or use the no debug all command to turn off all debugging.
debug zone {all | change {errors | events | packets} | database {detail | errors | events} gs errors
{errors | events | packets} | lun-zoning {errors | events | packets} | merge {errors | events |
packets} | mts notifications | pss {errors | events} | read-only-zoning {errors | events |
packets} | tcam errors {errors | events | packets} | transit {errors | events}} [vsan vsan-id]
no debug zone {all | change {errors | events | packets} | database {detail | errors | events} | gs
errors {errors | events | packets} | lun-zoning {errors | events | packets} | merge {errors |
events | packets} | mts notifications | pss {errors | events} | read-only-zoning {errors |
events | packets} | tcam errors {errors | events | packets} | transit {errors | events}} [vsan
vsan-id]
Syntax Description
all
Enables all zone server debug options.
change
Enables debugging for change protocol messages.
errors
Enables debugging for zone errors.
events
Enables debugging for zone events.
packets
Enables debugging for zone packets.
database
database
Enables debugging for database messages.
gs
Enables debugging for GS protocol messages.
lun-zoning
Enables debugging for LUN zoning messages.
merge
Enables debugging for merge protocol messages.
mts notification
Enables debugging for MTS notification messages.
pss
Enables debugging for PSS debug messages
read-only-zoning
Enables debugging for read-only Zoning messages.
tcam
Enables debugging for TCAM messages.
transit
Enables debugging for transit frame messages.
vsan vsan-id
(Optional) Restricts debugging to the specified VSAN.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
6-133
Chapter 6
Debug Commands
debug zone
Usage Guidelines
None.
Examples
The following example displays the system output when the debug zone all command is issued:
switch# debug zone all
2005 Mar 10 01:46:36 zone: Src: 0x00000601/18 Dst: 0x00000601/94 ID: 0x0067D5CD Size:
276 [REQ] Opc: 182 (MTS_OPC_DEBUG_WRAP_MSG) RR: 0x0067D5CD HA_SEQNO: 0x00000000 TS:
0x24E95060E0EF4 REJ:0 SYNC:0
2005 Mar 10 01:46:36 zone: 01 00 00 00 E8 03 00 00 00 00 00 00 00 00 00 00
2005 Mar 10 01:46:36 zone: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
2005 Mar 10 01:46:36 zone: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
2005 Mar 10 01:46:36 zone: FF FF FF FF 2F 64 65 76 2F 70 74 73 2F 30 00 00
2005 Mar 10 01:46:36 zone: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
2005 Mar 10 01:46:36 zone: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
.
Related Commands
Command
Description
no debug all
Disables all debugging.
show zone
Displays zone information.
Cisco MDS 9000 Family Command Reference
6-134
OL-29295-04, Cisco MDS NX-OS Release 6.x
CH A P T E R
7
E Commands
The commands in this chapter apply to the Cisco MDS 9000 Family of multilayer directors and fabric
switches. All commands are shown here in alphabetical order regardless of command mode. See “About
the CLI Command Modes” section on page 1-3 to determine the appropriate mode for each command.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-1
Chapter 7
E Commands
egress-sa
egress-sa
To configure the Security Association (SA) to the egress hardware, use the engress-sa command. To
delete the SA from the egress hardware, use the no form of the command.
engress-sa spi-number
no engress-sa spi-number
Syntax Description
spi-number
Defaults
None.
Command Modes
Configuration submode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
The range is from 256 to 4294967295.
Usage Guidelines
None.
Examples
The following example shows how to configure the SA to the egress hardware:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# interface fc 2/1 - 3
switch(config-if)# fcsp esp manual
switch(config-if-esp)# egress-sa 258
switch(config-if-esp)#
Related Commands
Command
Description
show fcsp interface
Displays FC-SP-related information for a specific interface.
Cisco MDS 9000 Family Command Reference
7-2
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
email-contact
email-contact
To configure an e-mail contact with the Call Home function, use the email-addr command in Call Home
configuration submode. To disable this feature, use the no form of the command.
email-addr email-address
no email-addr email-address
Syntax Description
email-address
Defaults
None.
Command Modes
Call Home configuration submode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Configures an e-mail address. Uses a standard e-mail address that does not
have any text size restrictions.
Usage Guidelines
None.
Examples
The following example shows how to configure e-mail contact in the Call Home configuration:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# email-contact [email protected]
Related Commands
Command
Description
callhome
Configures the Call Home function.
callhome test
Sends a dummy test message to the configured destination(s).
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-3
Chapter 7
E Commands
empty
empty
To remove all steps of the user-configured algorithm, use the empty command in configuration mode.
empty
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration Secure Erase algorithm submode
Command History
Release
Modification
6.2(1)
This command was deprecated.
3.3(1a)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to remove all steps of the user-configured algorithm:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# secure-erase module 2 algorithm 0
switch(config-se-algo)# empty
Related Commands
Command
Description
add-step dynamic
Adds a dynamic pattern step to a specific algorithm.
add-step static
Adds static pattern step to a specific algorithm.
Cisco MDS 9000 Family Command Reference
7-4
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
enable
enable
To turn on the privileged commands, use the enable command. To disable this feature, use the disable
command.
enable privilege-level
Syntax Description
privilege-level
Defaults
Enabled.
Command Modes
EXEC mode.
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Specifies privilege level. Default value is 15.
Usage Guidelines
None.
Examples
The following example shows how to turn on the privileged commands:
switch# enable 15
switch#
Related Commands
Command
Description
enable secret
Displays the secret for privilege escalation.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-5
Chapter 7
E Commands
enable (Call Home configuration submode)
enable (Call Home configuration submode)
To enable the Call Home function, use the enable command in Call Home configuration submode. To
disable this feature, use the disable command.
enable
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Call Home configuration submode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
To disable the Call Home function, use the disable command:
Examples
The following example shows how to enable the Call Home function.
switch# config terminal
Enter configuration commands, one per line.
switch(config)# callhome
switch(config-callhome)# enable
Related Commands
End with CNTL/Z.
Command
Description
callhome
Configures the Call Home function.
callhome test
Sends a dummy test message to the configured destination(s).
show callhome
Displays configured Call Home information.
Cisco MDS 9000 Family Command Reference
7-6
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
enable user-server-group
enable user-server-group
To enable or disable group validation, use the enable user-server-group command. To disable this
feature, use the no form of the command.
enable user-server-group
no enable user-server-group
Syntax Description-
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration submode.
Command History
Release
Modification
NX-OS 5.0
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable group validation:
switch(config-ldap)# enable user-server-group
switch(config-ldap)#
Related Commands
Command
Description
show ldap-server
groups
Displays the configured LDAP server groups.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-7
Chapter 7
E Commands
enable secret
enable secret
To create secret for privilege escalation, use the enable secret command. To disable this feature, use the
no form of the command.
enable secret {0 | 5} password [priv-lvl privilege-level]
no enable secret {0 | 5} password [priv-lvl privilege-level]
Syntax Description
0
Specifies that the secret that follows should be in clear text.
5
Specifies that the secret that follows should be encrypted.
password
Specifies that the secret for user privilege escalation.
priv-lvl
(Optional) Specifies the privilege level to which the secret belongs.
privilege-level
(Optional) Specifies the privilege level. Default value is 15.
Defaults
Enabled.
Command Modes
Global Configuration mode.
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to specifiy the secret that follows should be in clear text:
switch(config)# enable secret 0 admin priv-lvl 4
switch(config)#
The following example shows how to specify the secret that follows should be encrypted:
switch(config)# enable secret 5 admin priv-lvl 4
switch(config)#
Cisco MDS 9000 Family Command Reference
7-8
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
enable cert-DN-match
enable cert-DN-match
To enable or disable cert DN matching, use the enable cert-DN-match command. To disable this
feature, use the no form of the command.
enable cert-DN-match
no enable cert-DN-match
Syntax Description-
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration submode.
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
Examples
If Cert-DN match is configured, user will be allowed to login only if the user profile lists the subject-DN of
the user certificate as authorized for logging in.
The following example shows how to enable cert DN match:
switch(config-ldap)# enable cert-dn-match
switch(config-ldap)#
Related Commands
Command
Description
show ldap-server
groups
Displays the configured LDAP server groups.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-9
Chapter 7
E Commands
encryption
encryption
To configure an encryption algorithm for an IKE protocol policy, use the encryption command. To revert
to the default, use the no form of the command.
encryption {3des | aes | des}
no encryption
Syntax Description
3des
Specifies 168-bit DES (3DES).
aes
Specifies 128-bit AES-CBC.
des
Specifies 56-bit DES-CBS.
Defaults
3des
Command Modes
IKE policy configuration submode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
To use this command, the IKE protocol must be enabled using the crypto ike enable command.
Examples
The following example shows how to configure the encryption algorithm for the IKE protocol:
switch# config terminal
switch(config)# crypto ike domain ipsec
switch(config-ike-ipsec)# policy 1
switch(config-ike-ipsec-policy)# encryption 3des
Related Commands
Command
Description
crypto ike domain ipsec
Enters IKE configuration mode.
crypto ike enable
Enables the IKE protocol.
policy
Configures IKE policy parameters.
show crypto ike domain ipsec
Displays IKE information for the IPsec domain.
Cisco MDS 9000 Family Command Reference
7-10
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
end
end
To exit any of the configuration modes and return to EXEC mode, use the end command in configuration
mode.
end
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
4.1(1b)
Modified the command output.
1.0(2)
This command was introduced.
Usage Guidelines
You can also press Ctrl-Z to exit configuration mode.
Examples
The following example shows how to exit from configure mode:
switch(config-port-monitor)# end
switch#
The following example changes the name to george. Entering the end command causes the system to
exit configuration mode and return to EXEC mode.
switch(config)# hostname george
george(config)# end
switch#
Related Commands
Command
Description
exit
Exits configuration mode, or any of the configuration modes.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-11
Chapter 7
E Commands
enrollment terminal
enrollment terminal
To enable manual cut-and-paste certificate enrollment through the switch console, use the enrollment
terminal command in trust point configuration submode. To revert to the default certificate enrollment
process, use the no form of the command.
enrollment terminal
no enrollment terminal
Syntax Description
This command has no arguments or keywords.
Defaults
The default enrollment method is manual cut-and-paste, which is the only enrollment method that the
MDS switch currently supports.
Command Modes
Trust point configuration submode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure trust point enrollment through the switch console:
switch# config terminal
switch(config)# crypto ca trustpoint admin-ca
switch(config-trustpoint)# enrollment terminal
The following example shows how to discard a trust point enrollment through the switch console:
switch(config)# crypto ca trustpoint admin-ca
switch(config-trustpoint)# no enrollment terminal
Related Commands
Command
Description
crypto ca authenticate Authenticates the certificate of the certificate authority.
Cisco MDS 9000 Family Command Reference
7-12
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
errdisable detect cause link-down
errdisable detect cause link-down
To error-disable and bring down a port on a link failure, use the errdisable detect cause link-down
command in the interface configuration submode. To disable this feature, use the no form of the
command.
errdisable detect cause link-down num-times count duration sec
no errdisable detect cause link-down num-times count duration sec
Syntax Description
num-times
Specifies the flap number.
count
Specifies the count. The range is from 1 to 1023.
duration
Specifies the time in seconds.
sec
The range is from 1 to 2000000.
Defaults
None.
Command Modes
Interface Configuration submode.
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
The port guard feature is used in environments where the system and application does not adapt quickly
and efficiently to a port going down and back up or to a port rapidly cycling up and down which can
happen in some failure modes. For example, if the port is going up and down once a second, and the
system takes five seconds to stabilize after the port goes down, this situation might cause a more severe
failure in the fabric.
The port guard feature gives the SAN administrator the ability to prevent this issue from occurring in
environments that are vulnerable to these problems. The port can be configured to stay down after the
first failure, or after a specified number of failures in a specified time period. This allows the SAN
administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to configure the port as down when the link flaps once:
Switch# configure terminal
Switch (config)# interface fc1/1
Switch (config-if)# errdisable detect cause link-down
The following example shows how to configure the port as down when the link flaps 5 times in 30
seconds:
Switch# configure terminal
Switch (config)# interface fc1/1
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-13
Chapter 7
E Commands
errdisable detect cause link-down
Switch (config-if)# errdisable detect cause link-down num-times 5 duration 30
The following example shows how to remove the port guard feature on the interface:
Switch# config t
Switch (config)# interface fc1/1
Switch (config-if)# no errdisable detect cause link-down
switch(config)#
Related Commands
Command
Description
show interface
Displays the interface status information.
show running-config
interface
Displays the running configuration on the interface.
show interface status
err-disabled
Displays the Ethernet interface error status information.
Cisco MDS 9000 Family Command Reference
7-14
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
errdisable detect cause bit-errors
errdisable detect cause bit-errors
To enable error-disable detection on bit errors, use the errdisable detect cause bit-errors command in
the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause bit-errors num-times count duration sec
no errdisable detect cause bit-errors num-times count duration sec
Syntax Description
num-times
Specifies the number of flaps.
count
Specifies the count. The range is from 1 to 1023.
duration
Specifies the time in seconds.
sec
The range is from 1 to 2000000.
Defaults
None.
Command Modes
Interface Configuration submode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
The port guard feature is used in environments where the system and application does not adapt quickly
and efficiently to a port going down and back up or to a port rapidly cycling up and down which can
happen in some failure modes. For example, if the port is going up and down once a second, and the
system takes five seconds to stabilize after the port goes down, this situation might cause a more severe
failure in the fabric.
The port guard feature gives the SAN administrator the ability to prevent this issue from occurring in
environments that are vulnerable to these problems. The port can be configured to stay down after the
first failure, or after a specified number of failures in a specified time period. This allows the SAN
administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable detection on bit errors:
Switch# configure terminal
Switch (config)# interface fc1/1
Switch (config-if)# errdisable detect cause bit-errors num-times 5 duration 30
Switch (config-if)#
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-15
Chapter 7
E Commands
errdisable detect cause bit-errors
Related Commands
Command
Description
show interface
Displays the interface status information.
show running-config
interface
Displays the running configuration on the interface.
show interface status
err-disabled
Displays the Ethernet interface error status information.
Cisco MDS 9000 Family Command Reference
7-16
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
errdisable detect cause credit-loss
errdisable detect cause credit-loss
To enable error-disable detection on a credit loss, use the errdisable detect cause credit-loss command
in the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause credit-loss num-times count duration sec
no errdisable detect cause credit-loss num-times count duration sec
Syntax Description
num-times
Specifies the flap number.
count
Specifies the count. The range is from 1 to 1023.
duration
Specifies the time in seconds.
sec
The range is from 1 to 2000000.
Defaults
None.
Command Modes
Interface Configuration submode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
The port guard feature is used in the environments where the system and application does not adapt
quickly and efficiently to a port going down and back up or to a port rapidly cycling up and down which
can happen in some failure modes. For example, if the port is going up and down once a second, and the
system takes five seconds to stabilize after the port goes down, this situation might cause a more severe
failure in the fabric.
The port guard feature gives the SAN administrator the ability to prevent this issue from occurring in
environments that are vulnerable to these problems. The port can be configured to stay down after the
first failure, or after a specified number of failures in a specified time period. This allows the SAN
administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable detection on a credit loss:
Switch# configure terminal
Switch (config)# interface fc1/1
Switch (config-if)# errdisable detect cause credit-loss num-times 5 duration 30
Switch (config-if)#
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-17
Chapter 7
E Commands
errdisable detect cause credit-loss
Related Commands
Command
Description
show interface
Displays the interface status information.
show running-config
interface
Displays the running configuration on the interface.
show interface status
err-disabled
Displays the Ethernet interface error status information.
Cisco MDS 9000 Family Command Reference
7-18
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
errdisable detect cause link-reset
errdisable detect cause link-reset
To enable error-disable detection on a link reset, use the errdisable detect cause link-reset command
in the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause link-reset num-times count duration sec
no errdisable detect cause link-reset num-times count duration sec
Syntax Description
num-times
Specifies the flap number.
count
Specifies the count. The range is from 1 to 1023.
duration
Specifies the time in seconds.
sec
The range is from 1 to 2000000.
Defaults
None.
Command Modes
Interface Configuration submode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
The port guard feature is used in environments where the system and application does not adapt quickly
and efficiently to a port going down and back up or to a port rapidly cycling up and down which can
happen in some failure modes. For example, if the port is going up and down once a second, and the
system takes five seconds to stabilize after the port goes down, this situation might cause a more severe
failure in the fabric.
The port guard feature gives the SAN administrator the ability to prevent this issue from occurring in
environments that are vulnerable to these problems. The port can be configured to stay down after the
first failure, or after a specified number of failures in a specified time period. This allows the SAN
administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable detection on a link reset:
Switch# configure terminal
Switch (config)# interface fc1/1
Switch (config-if)# errdisable detect cause link-reset num-times 5 duration 30
Switch (config-if)#
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-19
Chapter 7
E Commands
errdisable detect cause link-reset
Related Commands
Command
Description
show interface
Displays the interface status information.
show running-config
interface
Displays the running configuration on the interface.
show interface status
err-disabled
Displays the Ethernet interface error status information.
Cisco MDS 9000 Family Command Reference
7-20
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
errdisable detect cause signal-loss
errdisable detect cause signal-loss
To enable error-disable detection on a signal loss, use the errdiable detect cause signal-loss command
in the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause signal-loss num-times count duration sec
no errdisable detect cause signal-loss num-times count duration sec
Syntax Description
num-times
Specifies the flap number.
count
Specifies the count. The range is from 1 to 1023.
duration
Specifies the time in seconds.
sec
The range is from 1 to 2000000.
Defaults
None.
Command Modes
Interface Configuration submode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
The port guard feature is used in the environments where the system and application does not adapt
quickly and efficiently to a port going down and back up or to a port rapidly cycling up and down which
can happen in some failure modes. For example, if the port is going up and down once a second, and the
system takes five seconds to stabilize after the port goes down, this situation might cause a more severe
failure in the fabric.
The port guard feature gives the SAN administrator the ability to prevent this issue from occurring in
environments that are vulnerable to these problems. The port can be configured to stay down after the
first failure, or after a specified number of failures in a specified time period. This allows the SAN
administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable on a signal loss:
Switch# configure terminal
Switch (config)# interface fc1/1
Switch (config-if)# errdisable detect cause signal-loss num-times 5 duration 30
Switch (config-if)#
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-21
Chapter 7
E Commands
errdisable detect cause signal-loss
Related Commands
Command
Description
show interface
Displays the interface status information.
show running-config
interface
Displays the running configuration on the interface.
show interface status
err-disabled
Displays the Ethernet interface error status information.
Cisco MDS 9000 Family Command Reference
7-22
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
errdisable detect cause sync-loss
errdisable detect cause sync-loss
To enable error-disable detection on a sync loss, use the errdisable detect cause sync-loss command in
the interface configuration submode. To disable this feature, use the no form of the command.
errdisable detect cause sync-loss num-times count duration sec
no errdisable detect cause sync-loss num-times count duration sec
Syntax Description
num-times
Specifies the flap number.
count
Specifies the count. The range is from 1 to 1023.
duration
Specifies the time in seconds.
sec
The range is from 1 to 2000000.
Defaults
None.
Command Modes
Interface Configuration submode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
The port guard feature is used in environments where the system and application does not adapt quickly
and efficiently to a port going down and back up or to a port rapidly cycling up and down which can
happen in some failure modes. For example, if the port is going up and down once a second, and the
system takes five seconds to stabilize after the port goes down, this situation might cause a more severe
failure in the fabric.
The port guard feature gives the SAN administrator the ability to prevent this issue from occurring in
environments that are vulnerable to these problems. The port can be configured to stay down after the
first failure, or after a specified number of failures in a specified time period. This allows the SAN
administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable detection on a synchronized loss:
Switch# configure terminal
Switch (config)# interface fc1/1
Switch (config-if)# errdisable detect cause sync-loss num-times 5 duration 30
Switch (config-if)#
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-23
Chapter 7
E Commands
errdisable detect cause sync-loss
Related Commands
Command
Description
show interface
Displays the interface status information.
show running-config
interface
Displays the running configuration on the interface.
show interface status
err-disabled
Displays the Ethernet interface error status information.
Cisco MDS 9000 Family Command Reference
7-24
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
errdisable detect cause trustsec-violation
errdisable detect cause trustsec-violation
To enable error-disable detection on a trustsec violation, use the errdisable detect cause
trustsec-violation command in the interface configuration submode. To disable this feature, use the no
form of the command.
errdisable detect cause trustsec-violation num-times count duration sec
no errdisable detect cause trustsec-violation num-times count duration sec
Syntax Description
num-times
Specifies the flap number.
count
Specifies the count. The range is from 1 to 1023.
duration
Specifies the time in seconds.
sec
The range is from 1 to 2000000.
Defaults
None.
Command Modes
Interface Configuration submode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
The port guard feature is used in environments where the system and application does not adapt quickly
and efficiently to a port going down and back up or to a port rapidly cycling up and down which can
happen in some failure modes. For example, if the port is going up and down once a second, and the
system takes five seconds to stabilize after the port goes down, this situation might cause a more severe
failure in the fabric.
The port guard feature gives the SAN administrator the ability to prevent this issue from occurring in
environments that are vulnerable to these problems. The port can be configured to stay down after the
first failure, or after a specified number of failures in a specified time period. This allows the SAN
administration to intervene and control the recovery and avoiding any problems caused by the cycling.
Examples
The following example shows how to enable error-disable detection on a trustsec violation:
switch#(config-if)# errdisable detect cause trustsec-violation num-times 1 duration 1
switch#(config-if)#
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-25
Chapter 7
E Commands
errdisable detect cause trustsec-violation
Related Commands
Command
Description
show interface
Displays the interface status information.
show running-config
interface
Displays the running configuration on the interface.
show interface status
err-disabled
Displays the Ethernet interface error status information.
Cisco MDS 9000 Family Command Reference
7-26
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event cli
event cli
To configure a CLI command as an EEM applet trigger, use the event cli command. To delete the applet
trigger, use the no form of the command.
event cli [tag tagname] match expression [count countnum [time seconds]]
no event cli [tag tagname] match expression [count countnum [time seconds]]
Syntax Description
tag tagname
(Optional) Configures an event tag identifier.
tagname specifies a handle for combining multiple events and this handle
can be any string value of 1 to 29 characters.
match expression
Specifies the regular expression (regexp) used to match the CLI command.
The command must have been successfully parsed before a match is
attempted. The expression is compared to the fully expanded command and
must match exactly, not just part of the command. When the expression
contains embedded spaces enclose it in double quotes.
count countnum
(Optional) Specifies the number of matching occurrences before an
Embedded Event Manager event is triggered. When a number is not
specified, an Embedded Event Manager event is triggered after the first
match. This number must be an integer greater than 0.
time seconds
(Optional) Specifies the time interval during which one or more occurrences
must take place. When the keyword is not specified, no time period check
is applied.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
Examples
A cli event trigger allows control over CLI commands. By default, the triggering command is not
executed. This allows an applet to take action before or after a command runs, or even prevent it from
running. To run the triggering command, configure an event-default action at the stage in the applet
where the command should run.
The following example shows how to match the shutdown command as an applet trigger:
switch# configure terminal
switch(config)# event manager applet blockShutdownCmd
switch(config-applet)# event cli match “shutdown”
switch(config-applet)# end
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-27
Chapter 7
E Commands
event cli
The following example shows how to use spaces and regular expressions. Action 10 logs a syslog
message and action 20 allows the matching command to complete normally.
switch# configure terminal
switch(config)# event manager applet fcanalyserCheck
switch(config-applet)# event cli match "fcanalyzer * mgmt*"
switch(config-applet)# action 10 syslog priority emergencies msg fcanalyser command used
for mgmt interface
switch(config-applet)# action 20 event-default
switch(config-applet)# end
Related Commands
Command
Description
action
Configure EEM applet actions.
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
tag
Correlate multiple events in an EEM applet.
Cisco MDS 9000 Family Command Reference
7-28
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event counter
event counter
To configure a counter as an EEM applet trigger, use the event counter command. To delete the applet
trigger, use the no form of the command.
event counter [tag tagname] name name entry-val value entry-op operator [exit-val value exit-op
operator]
no event counter [tag tagname] name name entry-val value entry-op operator [exit-val value
exit-op operator]
Syntax Description
tag tagname
(Optional) Configures an event tag identifier.
tagname specifies a handle for combining multiple events and this handle
can be any string value of 1 to 29 characters.
name name
Configures the name of the counter to monitor.
name can be any string value of 1 to 28 characters.
entry-val value
Configures a value to compare the named counter against.The event resets
immediately unless an exit-val is specified.
value is an integer in the range from 0 to 2147483647.
entry-op operator
Specifies how to compare the current value of the named counter with the
specified value. The operator can be one of the following:
•
eq — Equal to
•
ge — Greater than or equal to
•
gt — Greater than
•
le — Less than or equal to
•
lt — Less than
•
ne — Not equal to
exit-val value
(Optional) Configures a value that the named counter must reach before
resetting the event.
value is an integer in the range from 0 to 2147483647.
exit-op operator
(Optional) Specifies how to compare the current value of the named counter
with the specified value. The operator can be one of the following:
•
eq — Equal to
•
ge — Greater than or equal to
•
gt — Greater than
•
le — Less than or equal to
•
lt — Less than
•
ne — Not equal to
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-29
Chapter 7
E Commands
event counter
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to trigger an EEM applet when a counter named 'test' has a value of 0:
switch# configure terminal
switch#(config)# event manager applet testCtrIsZero
switch#(config-applet)# event counter name test entry-val 0 entry-op eq
switch#(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
tag
Correlate multiple events in an EEM applet.
Cisco MDS 9000 Family Command Reference
7-30
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event fanabsent
event fanabsent
To configure a fan absence as an EEM applet trigger, use the event fanabsent command. To delete the
applet trigger, use the no form of the command.
fanabsent [fan fannumber] time seconds
no fanabsent [fan fannumber] time seconds
Syntax Description
fan fannumber
(Optional) Configures a chassis fan.
fannumber range is platform specific.
time seconds
Configures a time period.
seconds range is 10 to 64000.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
This event specification monitors if a fan is removed from the chassis for a particular period of time.
Embedded Event Manager takes an action based on the actions configured on the applet.
Examples
This example shows how to configure a an EEM applet to trigger after a fan absence of 300 seconds (5
minutes):
switch# configure terminal
switch#(config)# event manager applet fanGoneForFiveMins
switch#(config-applet)# event fanabsent fan 300
switch(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-31
Chapter 7
E Commands
event fanbad
event fanbad
To configure fanbad event specification, use the event fanbad command. To remove the fanbad event,
use the no form of the command.
event fanbad [fan fannumber] time seconds
no event fanbad [fan fannumber] time seconds
Syntax Description
fan fannumber
(Optional) Configures a chassis fan.
fannumber range is platform specific.
time seconds
Configures a time period.
seconds range is 10 to 64000.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
This event specification monitors for the failure of any chassis cooling fan and Embedded Event
Manager takes an action based on the actions configured on the applet.
Examples
This example shows how to configure an EEM applet to trigger after a fan failure of 10 seconds:
switch# configure terminal
switch#(config)# event manager applet applet1
switch#(config-applet)# event fanbad time 10
switch#(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
Cisco MDS 9000 Family Command Reference
7-32
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event fcns
event fcns
To change the maximum number of FC Name Server (FCNS) entries allowed on a switch, use the event
fcns command. You must override the default system policy __fcns_entries_max_per_switch with a
new policy to do this. To remove the FCNS event, use the no form of the command.
event fcns entries max-per-switch count
no event fcns entries max-per-switch count
Syntax Description
entries
Specifies FCNS Database entries.
max-per-switch count
Specifies an event to configure maximum FCNS database count per switch.
count specifies the maximum number of FCNS entries the switch will
register. count range is platform specific.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 6.2(11)
This command was introduced.
Usage Guidelines
The maximum number of name server entries that a switch can support is dependent on the platform.
Refer to the Cisco MDS NX-OS Release 6.2(13) Configuration Limits document for platform specific
limits.
Examples
This example shows how to configure an Embedded Event Manager event when the FCNS database
count per switch reaches a maximum:
switch# configure terminal
switch(config)# event manager applet fcns_policy override __fcns_entries_max_per_switch
switch(config-applet)# event fcns entries max-per-switch 9000
switch(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-33
Chapter 7
E Commands
event flogi
event flogi
To trigger an Embedded Event Manager (EEM) policy when certain fabric login (FLOGI) thresholds are
exceeded, use the event flogi command. To remove the FLOGI event detection from the EEM policy,
use the no form of the command.
event flogi {intf-max | module-max | switch-max} count
no event flogi {intf-max | module-max | switch-max} count
Syntax Description
intf-max
Triggers an event when the number of successful and pending FLOGIs for
any Fibre Channel interface exceeds the specified threshold.
module-max
Triggers an event when the number of successful and pending FLOGIs for
any module exceeds the specified threshold.
switch-max
Triggers an event when the number of successful and pending FLOGIs for
the switch exceeds the specified threshold.
count
Specifies the threshold value. The threshold value must be a positive
integer. The FLOGI limit range per interface, module, and switch is
platform specific. For more information on FLOGI limits for different
platforms, see the Cisco MDS NX-OS Configuration Limits document.
Defaults
None.
Command Modes
EEM applet configuration (config-applet)
Command History
Release
Modification
Cisco NX-OS
6.2(11)
This command was introduced.
Usage Guidelines
Examples
To use these FLOGI event triggers you must override the corresponding default system policies with a
new policy. The default system policies are:
event flogi
corresponding system policy
intf-max
__flogi_fcid_max_per_intf
module-max
__flogi_fcid_max_per_module
switch-max
__flogi_fcid_max_per_switch
This example shows an event trigger that occurs when the number of FLOGIs per interface exceeds the
threshold value of 156:
switch# configure terminal
Cisco MDS 9000 Family Command Reference
7-34
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event flogi
switch(config)# event manager applet flogiint override __flogi_fcids_max_per_intf
switch(config-applet)# event flogi intf-max 156
switch(config-applet)# end
This example shows an event trigger that occurs when the number of FLOGIs per module exceeds the
threshold value of 1024:
switch# configure terminal
switch(config)# event manager applet flogimod override __flogi_fcids_max_per_module
switch(config-applet)# event flogi module-max 1024
switch(config-applet)# end
This example shows an event trigger that occurs when the number of FLOGIs per switch exceeds the
threshold value of 2000:
switch# configure terminal
switch(config)# event manager applet flogiswitch override __flogi_fcids_max_per_switch
switch(config-applet)# event flogi switch-max 2000
switch(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show event manager
system-policy
Displays default system policies.
show running-config
eem
Displays all EEM applets.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-35
Chapter 7
E Commands
event gold
event gold
To create an online diagnostic test failure related event, use the event gold command. To remove the
online diagnostic test failure related event, use the no form of the command.
event gold module {number | all} test name [severity {minor | moderate | major}] testing-type
{scheduled | monitoring} consecutive-failure count
no event gold module {number | all} test name
Syntax Description
number
Specifies the module number.
all
Selects all the module IDs.
test name
Selects the diagnostic test.
name specifies the test name.
severity
Specifies the severity of the failure. It has the following values:
testing-type
•
minor - Minor failure
•
moderate - Moderate failure
•
major - Major failure
Specifies the type of testing. It has the following values:
consecutive-failure
count
•
scheduled - (Deprecated) Scheduled test
•
monitoring - Monitoring test
Specifies the consecutive number of times the failure has occurred.
count specifies the failure count and the value is between 1 to 1000.
DefaultsNone
None
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 6.2
This command was introduced.
Usage Guidelines
None
Examples
This example shows how to configure an EEM event when the GOLD ASICRegisterCheck test fails on
all modules 10 consecutive times.
switch# configure terminal
switch(config)# event manager applet gold
switch(config-applet)# event gold module all test ASICRegisterCheck testing-type
monitoring consecutive-failure 10
Cisco MDS 9000 Family Command Reference
7-36
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event gold
This example shows how to configure an EEM event when the GOLD PwrMgmtBus test fails on module
5 only 20 consecutive times.
switch# configure terminal
switch(config)# event manager applet gold
switch(config-applet)# event gold module 5 test PwrMgmtBus testing-type monitoring
consecutive-failure 20
Related Commands
Command
Description
show event manager
history events detail
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-37
Chapter 7
E Commands
event memory
event memory
To configure memory thresholds event specification, use the event memory command. To remove the
memory threshold event, use the no form of the command.
event memory {minor | severe | critical}
no event memory {minor | severe | critical}
Syntax Description
minor
Specifies minor alert.
severe
Specifies severe alert.
critical
Specifies critical alert.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
The event specification monitors the memory threshold specified in the applet and Embedded Event
Manager takes an action based on the actions configured on the applet.
Examples
This example shows how to configure memory threshold event specification:
switch# configure terminal
switch(config)# event manager applet bad-applet
switch(config-applet)# event memory critical
switch(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
show system internal
memory-alerts-log
Displays the log of memory alerts.
Cisco MDS 9000 Family Command Reference
7-38
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event module
event module
To configure the module event specification, use the event module command. To remove the module
event specification, use the no form of the command.
event module [tag tagname] status {online | offline | any} module {all | slot}
no event module [tag tagname] status {online | offline | any} module {all | slot}
Syntax Description
tag tagname
(Optional) Configures an event tag identifier.
tagname specifies a handle for combining multiple events and this handle
can be any string value of 1 to 29 characters.
status
Configures the status condition.
online
Specifies module status changed to online.
offline
Specifies module status changed to offline.
any
Specifies module status changed to online or offline.
module
Configures which modules to monitor.
all
Specifies all modules.
slot
Specifies a module number. The range is platform specific.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
This event specification monitors the module status change. Embedded Event Manager takes an action
based on the actions configured on the applet.
Examples
This example shows how to configure the module event specification in the device:
switch# configure terminal
switch(config)# event manager applet bad-applet
switch(config-applet)# event module status any module all
switch(config-applet)# action 1.0 syslog priority informational msg “module status
changed”
switch(config-applet)# end
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-39
Chapter 7
E Commands
event module
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
Cisco MDS 9000 Family Command Reference
7-40
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event module-failure
event module-failure
To create a module failure event specification, use the event module-failure command. To remove the
module failure event, use the no form of the command.
event module-failure [tag tagname] type failure-type module {all | slot} count count [time
seconds]
no event module-failure [tag tagname] type failure-type module {all | slot} count count [time
seconds]
Syntax Description
tag tagname
(Optional) Configures an event tag identifier.
tagname specifies a handle for combining multiple events and this handle
can be any string value of 1 to 29 characters.
type failure-type
Configures the failure type to monitor.
failure-type specifies whether one or all modules must be monitored.
failure-type specifies the type of failure conditions listed below:
module
•
addon-sequence-failure
Addon sequence failure
•
any
•
hitless-upgrade-diag-failure Runtime diag failure after hitless upgrade
•
hitless-upgrade-failure
•
hitless-upgrade-procmgr-notif LC software failure after hitless
upgrade
•
hitless-upgrade-reg-failure
Registration failure after hitless upgrade
•
hitless-upgrade-seq-timeout
Hitless upgrade sequence timeout
•
image-download-failed
Image download failure
•
image-upgrade-failed
Image upgrade failed
•
insertion-seq-failure
Insertion sequence failure
•
lc-failed
LC failed
•
lc-not-responding
LC not responding
•
lc-ready-timeout
LC ready timeout
•
lc-sw-failure
LC software failure
•
registration-failure
Registration failure
•
registration-timeout
Registration timeout
•
runtime-diag-failure
Runtime diag failure
•
runtime-diag-timeout
Runtime diag timeout
•
sequence-timeout
Sequence timeout
•
srg-info-resp-timeout
SRG info response timeout
•
unexpected-registration
Unexpected registration received
•
upgrade-srg-not-compatible Upgrade SRG not compatible
Hitless upgrade failure
Configures which modules to monitor.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-41
Chapter 7
E Commands
event module-failure
all
Specifies all modules.
slot
Specifies a module number. The range is platform specific.
count count
Configures the number of matching occurrences before an Embedded Event
Manager event is triggered.
count specifies the number of repeated occurrences and this number must
be an integer in the range 0 to 4294967295.
time seconds
(Optional) Configures a time period.
seconds is the period of module in failure state in seconds and this number
must be an integer in the range 0 to 10000000.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
None.
Examples
This example shows how to configure a module failure event specification:
switch# configure terminal
switch(config)# event manager applet modfailed
switch(config-applet)# event module-failure type lc-failed module all count 1
switch(config-applet)# action 1.0 syslog priority critical msg module failure detected
switch(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
tag
Correlate multiple events in an EEM applet.
Cisco MDS 9000 Family Command Reference
7-42
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event oir
event oir
To configure an Online Insertion Removal event specification, use the event oir command. To remove
the Online Insertion Removal event, use the no form of the command.
event oir [tag tagname] {fan | module | powersupply} {insert | remove | anyoir} [number]
no event oir [tag tagname] {fan | module | powersupply} {insert | remove | anyoir} [number]
Syntax Description
tag tagname
(Optional) Configures an event tag identifier.
tagname specifies a handle for combining multiple events and this handle
can be any string value of 1 to 29 characters.
fan
Specifies the system fans. Optionally, specifies an individual fan.
module
Specifies the system modules. Optionally, specifies an individual module.
powersupply
Specifies the system power supplies. Optionally, specifies an individual
power supply.
insert | remove | anyoir Specify the OIR event that triggers the Embedded Event Manager applet.
number
•
insert—OIR insert
•
remove—OIR remove
•
anyoir—Either OIR insert or OIR remove
(Optional) If you select fan, enter a fan number to monitor for an OIR event.
The range is platform specific. If you select module, enter a module number
to monitor an OIR event. The range is platform specific. If you select power
supply, enter a power supply number to monitor an OIR event. The range is
platform specific.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
This event specification monitors whenever there is insertion or removal of the following components:
fan, module, and power supply. Embedded Event Manager takes an action based on the actions
configured on the applet.
Examples
This example shows how to configure the Online Insertion Removal event specification:
switch# configure terminal
switch(config)# event manager applet moduleOir
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-43
Chapter 7
E Commands
event oir
switch(config-applet)# event oir module anyoir
switch(config-applet)# action 1.0 syslog priority informational msg a module was oir-ed
switch(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
tag
Correlate multiple events in an EEM applet.
Cisco MDS 9000 Family Command Reference
7-44
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event policy-default
event policy-default
To configure the event specification when the system policy is overridden, use the event policy-default
command. To remove the configuration, use the no form of the command.
event policy-default count count [time seconds]
no event policy-default count count [time seconds]
Syntax Description
count count
Configures the number of matching occurrences before an event is
triggered.
count specifies the number of repeated occurrences and this number must
be an integer in the range 0 to 65000.
time seconds
(Optional) Configures the time interval during which one or more
occurrences must take place. When this option is not specified no time limit
is applied.
seconds specifies the number of seconds and this number must be an integer
in the range 0 to 4294967295.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
None.
ExamplesNone.
This example shows how to configure an event configuration when the system policy is overridden:
switch# configure terminal
switch(config)# event manager applet applet1
switch(config-applet)# event policy-default count 1
switch(config-applet)# end
Related Commands
Command
Description
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-45
Chapter 7
E Commands
event poweroverbudget
event poweroverbudget
The power over-budget policy gets triggered when the available power capacity drops below zero and
the device is no longer able to keep the previously powered-up modules in the powered-up state. The
default action is to print a syslog to notify the user of the occurrence of power over budget. To change
the power over budget behavior, use the event poweroverbudget command. You must override the
default system policy __pfm_power_over_budget with a new policy to do this. To remove the power
over-budget event specification, use the no form of the command.
event poweroverbudget
no event poweroverbudget
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
None.
Examples
This example shows how to shut down modules starting from module 1 when the available power drops
below zero:
switch# configure terminal
switch(config)# event manager applet pobOverride override __pfm_power_over_budget
switch(config-applet)# event poweroverbudget
switch(config-applet)# action 4 overbudgetshut
switch(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
Cisco MDS 9000 Family Command Reference
7-46
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event snmp
event snmp
To configure an SNMP event, use the event snmp command. To remove the SNMP event, use the no form
of the command.
event snmp [tag tagname] oid oid get-type {exact| next} entry-op {gt | ge | eq | ne | lt | le}
entry-val value [{exit-comb {or| and} exit-op {gt | ge | eq | ne | lt | le} exit-val value exit-time
time} | {exit-op {gt | ge | eq | ne | lt | le} exit-val value}] poll-interval time
no event snmp [tag tagname] oid oid get-type {exact| next} entry-op {gt |ge |eq |ne |lt |le}
entry-val value [{exit-comb {or | and} exit-op {gt | ge | eq | ne | lt | le} exit-val value exit-time
time} | {exit-op {gt | ge | eq | ne | lt | le} exit-val value}] poll-interval time
Syntax Description
tag tagname
(Optional) Configures an event tag identifier.
tagname specifies a handle for combining multiple events and this handle
can be any string value of 1 to 29 characters.
oid oid
Configures the OID to monitor.
oid in dot notation.
get-type
Configures the type of SNMP get operation to be applied to the named OID.
exact
Retrieve the OID exactly as specified.
next
Retrieve the OID that is the alphanumeric successor to the named OID.
entry-op
Configures how to compare the value of the current OID with the specified
value.
Operator
A logical operator with the following meanings:
•
eq — Equal to
•
ge — Greater than or equal to
•
gt — Greater than
•
le — Less than or equal to
•
lt — Less than
•
ne — Not equal to
entry-val value
Configures a value to compare against the current OID.
value specifies a value and this number is an integer in the range from 0 to
2147483647.
exit-comb
(Optional) Configures a combination of exit conditions that must be met
before event monitor is re-enabled.
and
(Optional) Specifies that an exit OID value and an exit time value must be
reached.
or
(Optional) Specifies that an exit OID value or an exit time value must be
reached.
exit-op
Configures how to compare the value of the current OID with the exit value.
If there is a match an event is triggered and event monitoring is reenabled.
exit-val value
Configures the value with which the contents of the current OID are
compared to decide whether the exit criteria are met.
value specifies a value and this number is an integer in the range from 0 to
2147483647.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-47
Chapter 7
E Commands
event snmp
exit-time time
(Optional) Configures the time period after which the event monitoring is
reenabled. The timing starts after the event is triggered.
time is an integer in the range from 1 to 2147483647.
poll-interval
Configures the time interval between consecutive polls.
Defaults
None
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
An Embedded Event Manager event is triggered when one of the fields specified by an SNMP object ID
crosses a defined threshold. If multiple conditions exist, the SNMP event is triggered when all the
conditions are met.
Exit criteria are optional. If exit criteria are not specified, event monitoring will be re-enabled
immediately. If exit criteria are specified on the basis of values or time periods, the event monitoring is
not re-enabled until the criteria are met.
When the entry-op keyword is used and there is a match, an event is triggered and event monitoring is
disabled until the exit criteria are met.
When the exit-op keyword is used and there is a match, an event is triggered and event monitoring is
re-enabled.
The entry-type keyword triggers one of the following actions:
•
If the value keyword is specified, the entry-value is an actual value and an SNMP event is raised
whenever the absolute value occurs.
•
If the increment keyword is specified, the entry-value is an increment and an SNMP event is raised
whenever the incremental value is reached.
•
If the rate keyword is specified, the entry-value is a rate of change and an SNMP event is raised
whenever the rate of change value is reached.
When the optional exit-type keyword is used, the following conditions occur:
Examples
•
If the value keyword is specified, the exit value is an actual value and the event monitoring is
re-enabled whenever the absolute value occurs. This is the default.
•
If the increment keyword is specified, the exit value is an increment and the event monitoring is
re-enabled whenever the incremental value is reached.
•
If the rate keyword is specified, the exit value is a rate of change and the event monitoring is
re-enabled whenever the rate of change value is reached.
The following example shows how to monitor the CPU free memory OID and log a corresponding
syslog:
Cisco MDS 9000 Family Command Reference
7-48
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event snmp
switch# configure terminal
switch(config)# event manager applet snmp-applet
switch(config-applet)# event snmp oid 1.3.6.1.4.1.9.9.109.1.1.1.1.13.1 get-type exact
entry-op lt entry-val 100000 poll-interval 60
switch(config-applet)# action 1.0 syslog priority warnings msg free memory fell below 100
Mb
switch#(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
tag
Correlate multiple events in an EEM applet.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-49
Chapter 7
E Commands
event storm-control
event storm-control
By default, the packet storm feature takes limited action. The packet storm feature can be augmented with
further actions, such as disabling the affected interface or sending SNMP traps, by using an EEM applet. To
configure a packet storm event as an EEM applet trigger, use the event storm-control command. To delete
the applet trigger, use the no form of the command.
event storm-control
no event storm-control
Syntax Description
This command has no arguments or keywords.
Command Default
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
This command is only available on platforms that support the packet storm feature.
Examples
The following example show how to shutdown an interface that exceeds the packet storm feature thresholds:
switch# configure terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# event manager applet stormControlAction
switch(config-applet)# event storm-control
switch(config-applet)# action 10 cli configure terminal
switch(config-applet)# action 20 cli interface $interface
switch(config-applet)# action 30 cli shutdown
switch(config-applet)# action 40 cli end
switch(config-applet)# action 50 syslog priority notifications msg Storm control:
$interface shutdown due to $cause
switch(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
Cisco MDS 9000 Family Command Reference
7-50
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event storm-control
Command
Description
show running-config
eem
Displays all EEM applets.
storm-control
Configure packet storm thresholds on an interface.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-51
Chapter 7
E Commands
event syslog
event syslog
To specify event criteria for an Embeded Event Manager applet that is run by matching syslog messages,
use the event syslog command in the applet configuration mode. To remove the syslog message event
criteria, use the no form of the command.
event syslog [tag tagname] [occurs count] [period interval] [priority [0-7 | alerts | critical |
debugging | emergencies | errors | informational | notifications | warnings]] pattern
expression
no event syslog [tag tagname] [occurs count] [period interval] [priority [0-7 | alerts | critical |
debugging | emergencies | errors | informational | notifications | warnings]] pattern
expression
Syntax Description
tag tagname
(Optional) Configures an event tag identifier.
tagname specifies a handle for combining multiple events and this handle
can be any string value of 1 to 29 characters.
occurs count
(Optional) Specifies the number of occurrences of the matched syslog
messages to count before triggering the policy event.
count range is platform specific.
period interval
(Optional) Specifies the maximum time within which the timestamps of the
triggering messages must fall.
interval range is platform specific.
priority
(Optional) Specifies the number or name of the desired priority level at
which syslog messages are matched. Messages at or numerically lower than
the specified level are matched. The parameter for priority must be one of
the following:
• 0 | emergencies— Specifies syslog messages of emergency level (the
system is unusable).
• 1 | alerts— Specifies syslog messages of alert level (immediate action is
needed).
• 2 | critical— Specifies syslog messages of critical level (critical
conditions).
• 3 | errors— Specifies syslog messages of error level (error conditions).
• 4 | warnings— Specifies syslog messages of warning level (warning
conditions).
• 5 | notifications— Specifies syslog messages of notification level (normal
but significant conditions).
• 6 | informational— Specifies syslog messages of informational level
(informational messages).
• 7 | debugging— Specifies syslog messages of debugging level (debugging
messages).
pattern expression
Specifies a regular expression to match against syslog messages. The
pattern must be quoted with " " quotes.
expression maximum size is 256 characters.
Cisco MDS 9000 Family Command Reference
7-52
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event syslog
Defaults
If the occurs parameter is not specified, the default value of 1 is used.
If the period parameter is not specified, the default value of 0 is used.
If the priority parameter is not specified, the default value of informational is used.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
5.2(1)
This command was introduced.
Usage Guidelines
The syslog and Embedded Event Manager client processes run on each supervisor module in a system.
Therefore, in dual supervisor systems, an event syslog command will be matched on both the active and
standby supervisors. Both Embedded Event Manager clients will notify the Embedded Event Manager
master process on the active supervisor causing the applet to be triggered twice. Be sure to take this
potential double triggering in to account in the applet.
This command does not require a license.
Examples
This example shows how to configure an applet to trigger after 10 "authentication failed" syslog events:
switch# configure terminal
switch(config)# event manager applet auth-fails-applet
switch(config-applet)# event syslog occurs 10 pattern "authentication failed"
Configuration accepted successfully
This example shows how to configure an applet to tag module power up and standby online syslog
events:
switch# configure terminal
switch(config)# event manager applet mod-event-applet
switch(config-applet)# event syslog tag moduleEvent pattern "(powered up|is standby)"
Configuration accepted successfully
Related Commands
Command
Description
action syslog
Configures a syslog message to generate when an EEM applet is triggered.
show event manager
history events
Displays the history of EEM events.
tag
Correlate multiple events in an EEM applet.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-53
Chapter 7
E Commands
event sysmgr
event sysmgr
To override default system EEM policies, use the event sysmgr command. To remove the system
manager-related event specification, use the no form of the command.
event sysmgr {memory [module mod-number] major value minor value clear value | switchover
count count time seconds}
no event sysmgr {memory [module mod-number] major value minor value clear value |
switchover count count time seconds}
Syntax Description
memory
Configures memory alert thresholds.
module mod-number
(Optional) Configures for a module. Default is all modules.
mod-number specifies a module number and the range is platform specific.
major value
Configures the major memory alert threshold.
value specifies the amount of used memory as a percentage.
minor value
Configures the minor memory alert threshold.
value specifies the amount of used memory as a percentage.
clear value
Configures the threshold memory usage must fall below to exit memory
alert condition.
value specifies the amount of used memory as a percentage.
switchover count count Configures switchover rate alert threshold. Configures the number of
switchovers.
count range is from 1 to 65000.
time seconds
Configures the time interval during which the switchovers must take place
to trigger the event.
seconds specifies the time period and the range is from 1 to 4294967295
seconds.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following examples show the default system switchover EEM policy and override the default
triggering values with user defined values. The default action is retained.
switch# show event manager system-policy __sysmgr_swover_count_alert
Cisco MDS 9000 Family Command Reference
7-54
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event sysmgr
Name : __sysmgr_swover_count_alert
Description : Switchover count exceeded event. Default value: 20 switchovers within
1200 seconds. Default action: All linecards will be powered down.
Overridable : Yes
switch# configure terminal
switch(config)# event manager applet sup-so-override override __sysmgr_swover_count_alert
switch(config-applet)# event sysmgr switchover count 3 time 300
switch(config-applet)# action 1.0 policy-default
switch# show event manager system-policy __sysmgr_policy_mem_alert
Name : __sysmgr_policy_mem_alert
Description : service memory usage event
Overridable : Yes
switch# configure terminal
switch(config)# event manager applet sup-mem-override override __sysmgr_policy_mem_alert
switch(config-applet)# event sysmgr memory major 90 minor 80 clear 70
switch(config-applet)# action 1.0 policy-default
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
system-policy
Displays the default system EEM policies.
show event manager
history events
Displays the history of EEM events.
show running-config
eem
Displays all EEM applets.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-55
Chapter 7
E Commands
event temperature
event temperature
To specify an event criteria for an Embedded Event Manager (EEM) applet that is run on the basis of a
temperature event, use the event temperature command in the applet configuration mode. To remove
the temperature event criteria, use the no form of the command.
event temperature [module slot] [sensor number] threshold {major | minor | any}
no event temperature [module slot] [sensor number] threshold {major | minor | any}
Syntax Description
module slot
(Optional) Configures for particular modules.
slot specifies a ‘-‘ and ‘,’ delimited range of modules. The values are
platform specific.
sensor number
(Optional) Configures for particular sensors.
number specifies a ‘-‘ and ‘,’ delimited range of sensors and the values are
module specific.
threshold
Specifies the threshold event that triggers the Embedded Event Manager
applet.
major
Specifies a major event.
minor
Specifies a minor event.
any
Specifies any event.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
None.
Examples
This example shows the default system major temperature EEM policy and only performs the default
action for a major temperature alert for sensor #8 only.
switch# show event manager system __pfm_tempev_major
Name : __pfm_tempev_major
Description : TempSensor Major Threshold. Action: Shutdown
Overridable : Yes
switch# configure terminal
switch(config)# event manager applet majortemp_override override __pfm_tempev_major
switch(config-applet)# event temperature module 1-3 sensor 8 threshold major
switch(config-applet)# action 1.0 policy-default
Cisco MDS 9000 Family Command Reference
7-56
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event temperature
switch(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show event manager
policy
Displays the register EEM applets.
show event manager
system-policy
Displays the default system EEM applets.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-57
Chapter 7
E Commands
event zone
event zone
To change the maximum number of zone elements allowed on a switch, use the event zone command.
You must override the relevant default system policy with a new policy to do this. To remove the zone
event criteria, use the no form of the command.
event zone {zones max-per-switch | zonesets max-per-switch | zonemembers max-per-switch |
dbsize max-per-vsan} count
no event zone {zones max-per-switch | zonesets max-per-switch | zonemembers max-per-switch
| dbsize max-per-vsan }count
Syntax Description
zones
Specifies Zone count at which Embedded Event Manager event to be
triggered.
zonesets
Specifies the zoneset count at which Embedded Event Manager event to be
triggered.
zonemembers
Specifies the zone member count at which Embedded Event Manager event
to be triggered.
max-per-switch
Configures the maximum value for the switch.
dbsize
Specifies the zone database size at which Embedded Event Manager event
to be triggered.
max-per-vsan
Configures the maximum database limit size for the VSAN.
count
Specifies the maximum limit.
Defaults
None.
Command Modes
EEM applet configuration (config-applet).
Command History
Release
Modification
NX-OS 6.2(11)
This command was introduced.
Usage Guidelines
By default, the threshold controlled by the ‘zone’ events are set by the following system policies:
•
__zone_dbsize_max_per_vsan
•
__zone_members_max_per_sw
•
__zone_zones_max_per_sw
•
__zone_zonesets_max_per_sw
These policies log syslog messages when preconfigured thresholds are reached to alert the user of high
resource usage by the zone service. The thresholds and actions may be over ridden by the user or the
actions augmented by further actions (such as sending an SNMP trap).
Cisco MDS 9000 Family Command Reference
7-58
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event zone
Examples
This example shows the default system per VSAN maximum zone database size EEM policy and
overrides the database size. The default action is retained.
switch# show event manager system-policy __zone_dbsize_max_per_vsan
Name : __zone_dbsize_max_per_vsan
Description : Syslog warning when Zone database size exceeds the max limit of
4000000 bytes for a vsan.
Overridable : Yes
switch# configure terminal
switch(config)# event manager applet newzonedb override __zone_dbsize_max_per_vsan
switch(config-applet)# event zone dbsize max-per-vsan 1000000
switch(config-applet)# action 1.0 policy-default
switch(config-applet)# end
This example shows how to configure an EEM applet to override the maximum zone count on a system:
switch# configure terminal
switch(config-applet)# event manager applet zonemaxsw override __zone_zones_max_per_sw
switch(config-applet)# action 1.0 syslog priority informational msg "zone zonemaxswitch
override"
switch(config-applet)# end
This example shows how to configure an EEM applet to override the maximum zoneset count on a
system:
switch# configure terminal
switch#(config-applet)# event manager applet zonesetmaxsw override
__zone_zonesets_max_per_sw
switch#(config-applet)# action 1.0 syslog priority informational msg "zone
zonesetmaxswitch override"
switch(config-applet)# end
Related Commands
Command
Description
show event manager
event-types
Displays information about EEM event triggers.
show event manager
history events
Displays the history of EEM events.
show event manager
policy internal
Displays the register EEM applets.
show event manager
system-policy
Displays the default system EEM applets.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-59
Chapter 7
E Commands
event manager applet
event manager applet
To register an applet with the Embedded Event Manager (EEM) and to enter applet configuration mode,
use the event manager applet command. To unregister the applet, use the no form of the command.
event manager applet applet-name [override system-policy]
no event manager applet applet-name
Syntax Description
applet-name
The applet name can be any case-sensitive alphanumeric string up to 29
characters.
override system-policy
(Optional) Configures the applet to override an existing system policy.
system-policy specifies the name of the system policy to override.
Defaults
None.
Command Modes
Global configuration.
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
None.
Examples
This example shows how to register an applet with Embedded Event Manager and to enter applet
configuration mode:
switch# configure terminal
switch(config)# event manager applet eem-applet
switch(config-applet)# end
Related Commands
Command
Description
show event manager
history events
Displays the history of EEM events.
Cisco MDS 9000 Family Command Reference
7-60
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
event manager environment
event manager environment
To configure an Embedded Event Manager (EEM) environment variable, use the event manager
environment command. To disable an Embedded Event Manager environment variable, use the no form
of the command.
event manager environment environment-name environment-value
no event manager environment environment-name
Syntax Description
environment-name
Specifies the name of the EEM environment variable. The variable name
can be any case-sensitive alphanumeric string up to 29 characters.
environment-value
Specifies the value of the EEM environment. The variable name can be any
case-sensitive alphanumeric string up to 39 characters.
Defaults
None.
Command Modes
Global configuration.
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to set an Embedded Event Manager environment variable:
switch# configure terminal
switch(config)# event manager environment emailto “[email protected]”
switch(config)# end
Related Commands
Command
Description
show event manager
environment
Displays the name and value of the EEM.
show event manager
history events
Displays the history of EEM events.
show event manager
policy
Displays the register EEM applets.
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-61
Chapter 7
E Commands
event manager policy
event manager policy
To register and activate an Embedded Event Manager (EEM) script policy, use the event manager policy
command in the global configuration mode. To deactivate the script policy, use the no form of the
command.
event manager policy policy-script
no event manager policy policy-script
Syntax Description
policy-script
Defaults
None.
Command Modes
Global Configuration.
Command History
Release
Modification
NX-OS 4.1(3)
This command was introduced.
Usage Guidelines
Specifies the Embedded Event Manager policy script. This name becomes
the name of the Embedded Event Manager policy. The maximum size of the
name is 29 characters.
User policy scripts must be installed in the bootflash://eem/user_script_policies directory before they
can be used. If this directory does not exist, create this directory before the first use of this command and
install the policy scripts in it.
The Embedded Event Manager schedules and runs policies on the basis of an event specification that is
contained within the policy itself. When the event manager policy command is invoked, the Embedded
Event Manager examines the policy and registers it to be run when the specified event occurs.
Examples
The following example shows how to register a policy:
switch# configure terminal
switch(config)# event manager policy modulescript
switch(config)# end
Related Commands
Command
Description
show event manager
history events
Displays the history of EEM events.
event manager applet
Displays an applet with the EEM.
Cisco MDS 9000 Family Command Reference
7-62
OL-29295-03, Cisco MDS NX-OS Release 6.x
Chapter 7
E Commands
exit
exit
To exit any configuration mode or close an active terminal session and terminate the EXEC, use the exit
command at the system prompt.
exit
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
EXEC and configuration modes
Command History
Release
Modification
4.1(1b)
Modified the command output.
1.0(2)
This command was introduced.
Usage Guidelines
Note
Examples
Use the exit command at the EXEC levels to exit the EXEC mode. Use the exit command at the
configuration level to return to privileged EXEC mode. Use the exit command in interface configuration
mode to return to configuration mode. You also can press Ctrl-Z, or use the end command, from any
configuration mode to return to EXEC mode.
The exit command is associated with privilege level 0. If you configure AAA authorization for a
privilege level greater than 0, this command will not be included in the command set for that privilege
level.
The following example displays an exit from the submode:
switch(config-port-monitor)# exit
switch(config)#
The following example displays an exit from the interface configuration mode for VRRP to return to the
interface configuration mode:
switch(config-if-vrrp)# exit
switch(config-if)#
The following example displays an exit from the interface configuration mode to return to the
configuration mode:
switch(config-if)# exit
switch(config)#
The following example shows how to exit an active session (log-out):
Cisco MDS 9000 Family Command Reference
OL-29295-03, Cisco MDS NX-OS Release 6.x
7-63
Chapter 7
E Commands
exit
switch# exit
Related Commands
Command
Description
end
Returns you to EXEC mode.
Cisco MDS 9000 Family Command Reference
7-64
OL-29295-03, Cisco MDS NX-OS Release 6.x
CH A P T E R
8
F Commands
The commands in this chapter apply to the Cisco MDS 9000 Family of multilayer directors and fabric
switches. All commands are shown here in alphabetical order regardless of command mode. See “About
the CLI Command Modes” section on page 1-3 to determine the appropriate mode for each command.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-1
Chapter 8
F Commands
fabric
fabric
To add a fabric to the cluster, use the fabric command in the Cisco SME cluster configuration submode.
fabric fabric name
Syntax Description
fabric name
Defaults
None.
Command Modes
Cisco SME cluster configuration submode.
Command History
Release
Modification
3.2(2)
This command was introduced.
Specifies the fabric name. The maximum length is 32 characters.
Usage Guidelines
None.
Examples
The following example adds a fabric named sw-xyz to a cluster:
switch# config terminal
switch(config)# sme cluster c1
switch(config-sme-cl)# fabric sw-xyz
Related Commands
Command
Description
show sme cluster
Displays information about Cisco SME cluster.
Cisco MDS 9000 Family Command Reference
8-2
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fabric-binding activate
fabric-binding activate
To activate fabric binding in a VSAN, use the fabric-binding activate command in configuration mode.
To disable this feature, use the no form of the command.
fabric-binding activate vsan vsan-id [force]
no fabric-binding activate vsan vsan-id
Syntax Description
vsan vsan-id
Specifies the VSAN. The ID of the VSAN is from 1 to 4093.
force
(Optional) Forces fabric binding activation.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
3.0(1)
Extended support for fabric binding to Fibre Channel VSANs.
Usage Guidelines
Fabric binding is configured on a per-VSAN basis and can be implemented in both FICON VSANs and
Fibre Channel VSANs.
Examples
The following example activates the fabric binding database for the specified VSAN:
switch# config terminal
switch(config)# fabric-binding activate vsan 1
The following example deactivates the fabric binding database for the specified VSAN:
switch(config)# no fabric-binding activate vsan 10
The following example activates the fabric binding database for the specified VSAN forcefully, even if
the configuration is not acceptable:
switch(config)# fabric-binding activate vsan 3 force
The following example reverts to the previously, configured state or to the factory default (if no state is
configured):
switch(config)# no fabric-binding activate vsan 1 force
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-3
Chapter 8
F Commands
fabric-binding activate
Related Commands
Command
Description
fabric-binding database
Configures a fabric binding database.
fabric-binding enable
Enables fabric binding.
Cisco MDS 9000 Family Command Reference
8-4
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fabric-binding database copy
fabric-binding database copy
To copy from the active fabric binding database to the configuration fabric binding database, use the
fabric-binding database copy command in EXEC mode.
fabric-binding database copy vsan vsan-id
Syntax Description
vsan vsan-id
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
3.0(1)
Extended support for fabric binding to Fibre Channel VSANs.
Usage Guidelines
Specifies the VSAN. The ID of the VSAN is from 1 to 4093.
Fabric binding is configured on a per-VSAN basis and can be implemented in both FICON VSANs and
Fibre Channel VSANs.
If the configured database is empty, this command is not accepted.
Examples
The following example copies from the active database to the configuration database in VSAN 1:
switch# fabric-binding database copy vsan 1
Related Commands
Command
Description
fabric-binding diff
Provides the differences between the fabric binding databases.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-5
Chapter 8
F Commands
fabric-binding database diff
fabric-binding database diff
To view the differences between the active database and the configuration database in a VSAN, use the
fabric-binding database diff command in EXEC mode.
fabric-binding database diff {active | config} vsan vsan-id
Syntax Description
active
Provides information on the differences in the active database with respect to
the configuration database.
config
Provides information on the differences in the configuration database with
respect to the active database.
vsan vsan-id
Specifies the VSAN. The ID of the VSAN is from 1 to 4093.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
3.0(1)
Extended support of fabric binding to Fibre Channel VSANs.
Usage Guidelines
Fabric binding is configured on a per-VSAN basis and can be implemented in both FICON VSANs and
Fibre Channel VSANs.
Examples
The following example displays the differences between the active database and the configuration
database in VSAN 1:
switch# fabric-binding database diff active vsan 1
The following example displays information on the differences between the configuration database and
the active database:
switch# fabric-binding database diff config vsan 1
Related Commands
Command
Description
fabric-binding copy
Copies from the active to the configuration fabric binding database.
Cisco MDS 9000 Family Command Reference
8-6
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fabric-binding database vsan
fabric-binding database vsan
To configure a user-specified fabric binding list in a VSAN, use the fabric-binding database vsan
command in configuration mode. To disable an FC alias, use the no form of the command.
fabric-binding database vsan vsan-id swwn switch-wwn domain domain-id
no fabric-binding database vsan vsan-id swwn switch-wwn domain domain-id
Syntax Description
vsan-id
Specifies the VSAN. The ID of the VSAN is from 1 to 4093.
swwn switch-wwn
Configures the switch WWN in dotted hex format.
domain domain-id
Specifies the specified domain ID. The domain ID is a number from 1 to 239.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
3.0(1)
Extended support of fabric binding to Fibre Channel VSANs.
Usage Guidelines
Fabric binding is configured on a per-VSAN basis and can be implemented in both FICON VSANs and
Fibre Channel VSANs.
In a FICON VSAN, the fabric binding feature requires all sWWNs connected to a switch and their
persistent domain IDs to be part of the fabric binding active database. In a Fibre Channel VSAN, only
the sWWN is required; the domain ID is optional.
A user-specified fabric binding list contains a list of switch WWNs (sWWNs) within a fabric. If an
sWWN attempts to join the fabric, and that sWWN is not on the list or the sWWN is using a domain ID
that differs from the one specified in the allowed list, the ISL between the switch and the fabric is
automatically isolated in that VSAN and the switch is denied entry into the fabric.
The persistent domain ID must be specified along with the sWWN. Domain ID authorization is required
in FICON VSANs where the domains are statically configured and the end devices reject a domain ID
change in all switches in the fabric.
Note
Examples
All switches in a non-FICON VSAN must be running Cisco MDS SAN-OS Release 3.x or later.
The following example enters the fabric binding database submode and adds the sWWN and domain ID
of a switch to the configured database list:
switch# config terminal
switch(config)# fabric-binding database vsan 5
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-7
Chapter 8
F Commands
fabric-binding database vsan
switch(config-fabric-binding)# swwn 21:00:05:30:23:11:11:11 domain 102
The following example deletes a fabric binding database for the specified VSAN:
switch# config terminal
switch(config)# no fabric-binding database vsan 10
The following example deletes the sWWN and domain ID of a switch from the configured database list:
switch# config terminal
switch(config)# fabric-binding database vsan 5
switch(config-fabric-binding)# no swwn 21:00:15:30:23:1a:11:03 domain 101
Related Commands
Command
Description
fabric-binding activate
Activates fabric binding.
fabric-binding enable
Enables fabric binding.
Cisco MDS 9000 Family Command Reference
8-8
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fabric-binding enable
fabric-binding enable
To enable fabric binding in a VSAN, use the fabric-binding enable command. To disable fabric binding,
use the no form of the command.
fabric-binding enable
no fabric-binding enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
3.0(1)
Extended support of fabric binding to Fibre Channel VSANs.
NX-OS 4.1(1b)
This command was deprecated.
Usage Guidelines
Fabric binding is configured on a per-VSAN basis and can be implemented in both FICON VSANs and
Fibre Channel VSANs.
The fabric binding feature must be enabled in each switch in the fabric that participates in the fabric
binding.
Examples
The following example enables fabric binding on that switch:
switch# config t
switch(config)# fabric-binding enable
The following example disables fabric binding on that switch:
switch# config t
switch(config)# no fabric-binding enable
Related Commands
Command
Description
fabric-binding activate
Activates fabric binding.
fabric-binding database
Configures a fabric binding database.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-9
Chapter 8
F Commands
fabric-membership
fabric-membership
To configure a node to a fabric, use the fabric-membership command. To remove the node from the
fabric, use the no form of the command,
fabric-membership fabric name
no fabric-membership fabric name
Syntax Description
fabric name
Defaults
None.
Command Modes
Cisco SME cluster node configuration submode.
Command History
Release
Modification
3.2(2)
This command was introduced.
Specifies the fabric name. The maximum length is 32 characters.
Usage Guidelines
Use the fabric-membership command to put a node in a fabric.
This command has to be configured before the interface sme slot/port [force] can be accepted. It also
cannot be removed if the interface sme slot/port [force] command is enabled.
Examples
The following example specifies a fabric to which the node belongs:
switch# config t
switch(config)# sme cluster clustername1
switch(config-sme-cl)# node local
switch(config-sme-cl-node)# fabric-membership f1
Related Commands
Command
Description
interface sme
Configures the Cisco SME interface to a cluster.
shutdown
Enables or disables an interface.
show interface sme
Displays interface information.
Cisco MDS 9000 Family Command Reference
8-10
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcalias clone
fcalias clone
To clone a Fibre Channel alias, use the fcalias clone command.
fcalias clone origFcalias-Name cloneFcalias-Name vsan vsan-id
Syntax Description
origFcalias-Name
cloneFcalias-Name
Clones a Fibre Channel alias from the current name to a new name.
Maximum length of names is 64 characters.
vsan
Specifies the clone Fibre Channel alias is for a VSAN.
vsan-id
The ID of the VSAN is from 1 to 4093.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
2.1(1a)
This command was introduced.
Usage Guidelines
To disable an FC alias, use the no form of the fcalias name command.
Examples
The following examples show how to clone a fcalias named origAlias to cloneAlias on VSAN 45:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# fcalias clone origAlias cloneAlias vsan 45
Related Commands
Command
Description
show fcalias
Displays the member name information in a Fibre Channel alias (fcalias).
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-11
Chapter 8
F Commands
fcalias name
fcalias name
To configure an FC alias, use the fcalias name command. To disable an FC alias, use the no form of the
command.
fcalias name alias name vsan vsan-id
no fcalias name alias name vsan vsan-id
Syntax Description
alias-name
The name of the fcalias. Maximum length is 64 characters.
vsan
The fcalias is for a VSAN.
vsan-id
The ID of the VSAN is from 1 to 4093.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
To include multiple members in any alias, use the FCID, fWWN, or pWWN values.
Examples
The following examples show how to configure an fcalias called AliasSample on VSAN 3:
switch# config terminal
switch(config)# fcalias name AliasSample vsan 3
switch(config-fcalias)#
Related Commands
Command
Description
member (fcalias
configuration mode)
Configures alias member for a specified zone.
Cisco MDS 9000 Family Command Reference
8-12
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcalias rename
fcalias rename
To rename a Fibre Channel alias (fcalias), use the fcalias rename command.
fcalias rename current-name new-name vsan vsan-id
Syntax Description
current-name
Specifies the current fcalias name. The maximum length is 64.
new-name
Specifies the new fcalias name. The maximum length is 64.
vsan vsan-id
Specifies the VSAN ID. The range is 1 to 4093.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to rename an fcalias:
switch# config terminal
switch(config)# fcalias rename oldalias newalias vsan 10
Related Commands
Command
Description
fcalias name
Configures fcalias names.
show fcalias
Displays fcalias information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-13
Chapter 8
F Commands
fcanalyzer local
fcanalyzer local
To configure local Cisco Fabric Analyzer, use the fcanalyzer local command in EXEC mode.
fcanalyzer | ethanalyzer local [interface {inband | mgmt} [capture-filter expression] {[ brief ]
[[display-filter expression] [[limit-captured- frames number] [[limit-frame-size bytes]
[write uri2 ]]]]}|{[interface {inband | mgmt} [dump-pkt]]}]
Syntax Description
interface
(Optional) Begins live capture on following interface.
inband
(Optional) Specifies an inband interface (default interface to capture on).
mgmt
(Optional) Specifies an management interface.
capture-filter
(Optional) Filters frames using a capture filter expression.
expression
Specifies capture filter expression.
brief
(Optional) Displays the protocol summary in a brief.
display-filter
(Optional) Filters frames using display filter expression.
expression
Specifies display filter expression.
limit-captured-frames
number
(Optional) Limits the number of frames captured to 10. The range is 0 to
2147483647 frames. Use 0 if you do not want to limit the captured frames.
limit-frame-size bytes
(Optional) Limits the size of the frame captures. The range is 64 to 65536
bytes.
write
(Optional) Saves the captured frames to a specified file.
uri2
The filename to be written in (bootflash: or volatile:).
dump-pkt
Specifies Hex (ASCII) dumps packet, troubleshoot packet analyzer.
Defaults
Number of packets captured by default is changed from 100 to 10.
Command Modes
EXEC mode.
Command History
Release
Modification
NX-OS 4.1(1a)
Changed the display-filter syntax description.
NX-OS 4.2(2)
Moved local capture to EXEC mode, added support for capturing on mgmt
interface along with inband (fc-interface). Also addded capture-filter
support and support for hex dump of packets.
1.0(2)
This command was introduced.
Usage Guidelines
You can capture Fibre Channel control traffic from a switch and decode it without disrupting
connectivity and without having to be local to the point of analysis.
Cisco MDS 9000 Family Command Reference
8-14
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcanalyzer local
Examples
Note
When you capture on inband interface packets from the supervisor to the line card module are captured
and vice versa.
Note
Multiword capture and display filter expressions need to be either single-quoted or double-quoted
depending on what the expression itself contains.
Note
To stop capture at any time press Ctrl+C.
The following example shows how to display only protocol summary on VSAN1:
switch# fcanalyzer local interface inband brief
Capturing on inband interface
0.000000
ff.fa.01 -> ff.fa.01
FC OHMS(Cisco
0.001033
ff.fa.04 -> ff.fa.04
FC OHMS(Cisco
4.996424
ff.fa.01 -> ff.fa.01
FC OHMS(Cisco
4.997452
ff.fa.04 -> ff.fa.04
FC OHMS(Cisco
9.996536
ff.fa.01 -> ff.fa.01
FC OHMS(Cisco
9.997470
ff.fa.04 -> ff.fa.04
FC OHMS(Cisco
14.996572
ff.fa.01 -> ff.fa.01
FC OHMS(Cisco
14.997590
ff.fa.04 -> ff.fa.04
FC OHMS(Cisco
19.996463
ff.fa.01 -> ff.fa.01
FC OHMS(Cisco
19.997415
ff.fa.04 -> ff.fa.04
FC OHMS(Cisco
switch#
MDS)
MDS)
MDS)
MDS)
MDS)
MDS)
MDS)
MDS)
MDS)
MDS)
The following example shows how to display capture on inband interface:
switch# fcanalyzer local interface inband
Capturing on inband interface
Frame 1 (148 bytes on wire, 148 bytes captured)
Arrival Time: Apr 15, 2010 11:20:47.577355000
Time delta from previous packet: 0.000000000 seconds
Time since reference or first frame: 0.000000000 seconds
Frame Number: 1
Packet Length: 148 bytes
Capture Length: 148 bytes
Ethernet II, Src: 00:00:00:00:00:0a, Dst: 00:00:00:00:ee:00
Destination: 00:00:00:00:ee:00 (00:00:00:00:ee:00)
Source: 00:00:00:00:00:0a (00:00:00:00:00:0a)
Type: Unknown (0xfcfc)
MDS Header(Unknown(0)/Unknown(0))
MDS Header
...0 0000 0111 0110 = Packet Len: 118
.... 0000 0000 00.. = Dst Index: 0x0000
.... ..01 0010 0000 = Src Index: 0x0120
.... 0000 0000 0001 = VSAN: 1
MDS Trailer
EOF: Unknown (0)
CRC: 0xdeadbeef
Fibre Channel
R_CTL: 0x20(Extended Link Services/0x0)
switch#
The following example shows how to display a hex dump of packets:
switch# fcanalyzer local interface inband dump-pkt
Warning: Couldn't obtain netmask info (eth2: no IPv4 address assigned).
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-15
Chapter 8
F Commands
fcanalyzer local
Capturing on eth2
0.000000
ff.fa.01 -> ff.fa.01
0000
0010
0020
0030
0040
0050
0060
0070
0080
00
00
fa
ff
00
00
09
00
86
00
72
01
ff
29
00
96
00
d2
00
ff
00
00
f6
00
00
01
8b
00
00
ff
00
1f
00
00
00
df
ee
01
fa
00
73
00
00
00
4e
00
20
01
00
d9
00
00
00
02
00
00
01
00
00
00
00
ff
0b
00
01
00
00
00
ff
00
ff
aa
00
00
00
00
00
fa
00
ff
aa
00
00
03
00
00
01
04
ff
aa
FC OHMS(Cisco MDS)
00
00
00
00
00
00
00
00
00
0a
10
00
00
00
ff
00
09
00
fc
01
00
03
00
fa
00
f5
de
fc
00
00
49
00
01
02
00
ad
81
20
ff
00
00
00
00
2b
be
00
ff
ff
00
00
00
00
99
ef
................
.r... ........ .
................
.............I..
.)..s...........
................
................
..............+.
....N...........
0.001112 80:57:00:00:cb:07 -> 81:00:00:72:e7:00 LLC I P, N(R) = 127, N(S) = 16
; DSAP NULL LSAP Group, SSAP 68 Command
0000
0010
0020
0030
0040
0050
0060
0070
0080
81
20
ff
00
00
00
00
2b
4d
00
ff
ff
00
00
00
00
99
94
00
fa
ff
00
00
09
00
86
0.001763
0000
0010
0020
0030
0040
0050
0060
0070
0080
0090
00a0
00b0
00
00
fa
ff
00
00
09
00
99
18
3a
de
00
96
04
ff
29
00
96
00
87
96
49
ad
72
01
ff
29
00
96
00
d2
e7
00
00
f6
00
00
01
8b
00
ff
00
1f
00
00
00
df
80
fa
00
73
00
00
00
4e
57
01
00
d9
00
00
00
02
00
01
00
00
00
00
ff
0b
00
00
00
00
ff
00
ff
aa
cb
00
00
00
fa
00
ff
aa
ff.fa.04 -> ff.fa.04
00
ff
00
00
f6
00
00
06
01
0a
42
be
00
80
ff
00
1f
00
00
08
c8
43
ac
ef
ee
81
fa
00
fc
00
00
20
72
2f
2a
00
20
04
00
e2
00
00
00
e1
90
ef
00
00
01
00
00
00
00
06
ad
15
71
00
01
00
00
00
ff
00
08
c5
bb
ca
00
00
00
00
00
fa
00
20
a0
70
cd
00
00
00
00
00
04
00
00
dd
63
7a
07
03
00
29
01
04
ff
aa
00
00
00
f6
00
00
00
00
10
00
00
1f
ff
00
09
00
01
00
03
d4
fa
00
f5
de
68
00
49
00
01
02
00
ad
...r...W.......h
...............
...............I
...)..s....)....
................
................
................
+.....N.........
M.
FC OHMS(Cisco MDS)
00
00
00
00
00
00
00
00
09
bd
8e
0a
10
00
00
00
ff
00
30
c3
7b
a3
fc
01
00
03
00
fa
00
d1
d6
e1
a7
fc
00
00
49
00
04
01
00
2d
b3
e4
81
20
ff
00
00
00
00
f6
56
47
00
00
ff
ff
00
00
00
00
cc
8b
7a
00
................
..... ........ .
................
.............I..
.)..............
................
................
.... ... ..0....
....r........-V.
...C/...pc.{..Gz
:IB.*.q..z......
....
0.002248 81:20:00:01:cb:07 -> 81:00:00:96:ff:80 LLC I P, N(R) = 127, N(S) = 16
; DSAP NULL LSAP Group, SSAP NetWare Command
The following example shows how to use a display filter on inband interface and display its summary:
switch# fcanalyzer local interface inband brief display-filter 'mdshdr.vsan==0x1 &&
(fc.d_id == "ff.fa.01") || (fc.s_id == "ff.fa.04")'
Capturing on inband interface
0.000000
ff.fa.01 -> ff.fa.01
FC OHMS(Cisco MDS)
0.001782
ff.fa.04 -> ff.fa.04
FC OHMS(Cisco MDS)
4.996741
ff.fa.01 -> ff.fa.01
FC OHMS(Cisco MDS)
4.997725
ff.fa.04 -> ff.fa.04
FC OHMS(Cisco MDS)
9.996670
ff.fa.01 -> ff.fa.01
FC OHMS(Cisco MDS)
9.997483
ff.fa.04 -> ff.fa.04
FC OHMS(Cisco MDS)
14.996623
ff.fa.01 -> ff.fa.01
FC OHMS(Cisco MDS)
14.997642
ff.fa.04 -> ff.fa.04
FC OHMS(Cisco MDS)
19.996739
ff.fa.01 -> ff.fa.01
FC OHMS(Cisco MDS)
19.997554
ff.fa.04 -> ff.fa.04
FC OHMS(Cisco MDS)
switch#
The following example shows how to write captured packets in PCAP format and display captures on
the screen:
Cisco MDS 9000 Family Command Reference
8-16
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcanalyzer local
switch# fcanalyzer local interface inband display-filter 'mdshdr.vsan==0x1 && (fc.d_id ==
"ff.fa.01") || (fc.s_id == "ff.fa.04")' limit-captured-frames 2 write bootflash:fc_cap
Frame 2 (160 bytes on wire, 160 bytes captured)
Arrival Time: May 6, 2010 09:53:38.020767000
Time delta from previous packet: 0.000000000 seconds
Time since reference or first frame: 0.000000000 seconds
Frame Number: 2
Packet Length: 160 bytes
Capture Length: 160 bytes
Ethernet II, Src: 00:00:00:00:00:0a, Dst: 00:00:00:00:ee:00
Destination: 00:00:00:00:ee:00 (00:00:00:00:ee:00)
Source: 00:00:00:00:00:0a (00:00:00:00:00:0a)
Type: Unknown (0xfcfc)
MDS Header(Unknown(0)/Unknown(0))
MDS Header
...0 0000 1000 0010 = Packet Len: 130
.... 0000 0000 00.. = Dst Index: 0x0000
.... ..01 0010 0000 = Src Index: 0x0120
.... 0000 0000 0001 = VSAN: 1
MDS Trailer
EOF: Unknown (0)
CRC: 0xdeadbeef
Fibre Channel
R_CTL: 0x20(Extended Link Services/0x0)
Dest Addr: ff.fa.01
CS_CTL: 0x00
Src Addr: ff.fa.01
Type: Ext Link Svc (0x01)
F_CTL: 0x000000 Exchange Originator, Seq Initiator, CS_CTL, Last Data Frame
- No Info, ABTS - Abort/MS,
0... .... .... .... .... .... = ExgRpd: Exchange Originator
.0.. .... .... .... .... .... = SeqRec: Seq Initiator
..0. .... .... .... .... .... = ExgFst: NOT exchg first
...0 .... .... .... .... .... = ExgLst: NOT exchg last
.... 0... .... .... .... .... = SeqLst: NOT seq last
.... ..0. .... .... .... .... = Pri: CS_CTL
.... ...0 .... .... .... .... = TSI: NOT transfer seq initiative
.... .... 00.. .... .... .... = LDF: Last Data Frame - No Info (0x000000
)
.... .... ..00 .... .... .... = A01: no ack required (0x000000)
.... .... .... ..0. .... .... = RetSeq: NOT retransmitted sequence
.... .... .... .... ..00 .... = AA: ABTS - Cont (0x000000)
.... .... .... .... .... 0... = RelOff: rel offset NOT set
SEQ_ID: 0x00
DF_CTL: 0x00
SEQ_CNT: 0
OX_ID: 0xffff
RX_ID: 0xffff
Parameter: 0x00000000
Data (106 bytes)
0000 01
0010 00
0020 00
0030 00
0040 ff
0050 19
0060 ca
switch#
00
00
ff
00
ff
81
cd
00
00
fa
00
ff
9c
83
00
00
01
04
ff
d3
0e
00
00
00
00
00
6d
00
00
00
ff
00
1c
b2
00
04
00
fa
00
c0
58
de
1a
00
01
02
00
34
ad
00
00
00
00
c1
8a
be
00
00
00
00
24
30
ef
00
00
09
00
50
6a
34
00
96
00
6e
e6
19
00
00
01
4d
d6
a0
00
00
00
aa
cf
be
00
00
00
55
31
60
00
00
00
a6
ff
...........4...`
................
................
................
.........$PnM.U.
....m.X4.0j...1.
..........
The following example shows how to use capture filter on the mgmt interface and redirect the console
output to a file:
switch# fcanalyzer local interface mgmt capture-filter "arp" > mgmt_capture.txt
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-17
Chapter 8
F Commands
fcanalyzer local
Capturing on mgmt interface
switch#
Related Commands
Command
Description
show fcanalyzer
Displays the list of hosts configured for a remote capture.
Cisco MDS 9000 Family Command Reference
8-18
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcanalyzer remote
fcanalyzer remote
To configure remote Cisco Fabric Analyzer, use the fcanalyzer remote command in configuration mode.
To disable this command, use the no form of the command.
no fcanalyzer remote ip address [active [port-number]]
Syntax Description
ip-address
Maximum length is 1024 characters.
active
(Optional) Enables active mode (passive is the default) with the remote host.
port-number
(Optional) Specifies the port number.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
You can capture Fibre Channel control traffic from a switch and decode it without having to disrupt
connectivity and without having to be local to the point of analysis.
Examples
The following example shows how to configure remote Cisco Fabric analyzer:
switch(config)# fcanalyzer remote 1.1.1.1
switch(config)#
Related Commands
Command
Description
clear fcanalyzer
Clears the entire list of configured hosts.
show fcanalyzer
Displays the list of hosts configured for a remote capture.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-19
Chapter 8
F Commands
filter
filter
To specify the fields of the certificate map, use the filter command in configuration mode. The CA
certificate or certificate chain is assumed to already be available in Privacy Enhanced Mail (PEM)
(base-64) encoded format.
filter {altname-email email-id | altname-upn username | subject-name subject-name}
Syntax Description
altname-email email-id
Specifies an Email ID as an alternate name. The maximum size is 64
characters.
altname-upn username
Specifies user principal name as an alternate name. The maximum size
is 64 characters.
subject-name subject-name Specifies subject name of the certificate. The maximum size is 64
characters
Defaults
None.
Command Modes
Configuration submode.
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
%username% substitutes the user’s login name.
%hostname% substitute the peer hostname.
Note
Examples
Two maps currently can be configured for a given issuer name. The certificate will be filtered based on these
two configured maps. If a default configuration is provided then the certificates are filtered against the default
map in case if there is no map for that particular issuer name.
The following example shows how to configure an Email ID as an alternate name:
switch(config)# crypto certificatemap mapname map1
switch(config-certmap-filter)# filter subject-name cn=%username%,ou=PKI,o=Cisco
Systems,c=US
switch(config-certmap-filter)#
The following example shows how to configure the user principal as an alternate name:
switch(config-certmap-filter)# filter altname-email %username%@cisco.com
switch(config-certmap-filter)#
The following example shows how to configure the subject name as an certificate:
switch(config-certmap-filter)# filter
altname-upn%username%@%hostname%
Cisco MDS 9000 Family Command Reference
8-20
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
filter
switch(config-certmap-filter)#
Related Commands
Command
Description
show crypto
ssh-auth-map
Displays mapping filters applied for SSH authentication.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-21
Chapter 8
F Commands
fcc enable
fcc enable
To enable Fibre Channel Congestion Control (FCC), use the fcc enable command in configuration mode.
To disable this feature, use the no form of the command.
fcc enable
no fcc enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 5.0(1a)
This command was deprecated.
1.0(2)
This command was introduced.
Usage Guidelines
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
Examples
The following example shows how to enable FCC:
switch# config terminal
switch(config)# fcc enable
The following example shows how to disable FCC:
switch# config terminal
switch(config)# no fcc enable
Related Commands
Command
Description
show fcc
Displays FCC settings.
Cisco MDS 9000 Family Command Reference
8-22
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fc-management database
fc-management database
To configure the Fibre Channel Common Transport (FC-CT) Management Security database, use the
fc-management database command.
fc-management database vsan vsan-id
Syntax Description
vsan
Specifies the VSAN.
vsan-id
Specifies the VSAN ID. The range is from 1 to 4093.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 6.2(9)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure the management security database:
switch(config)# fc-management database vsan 1
switch(config-fc-mgmt)#
Related Commands
Command
Description
fc-management enable Enables the FC-CT Management Security.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-23
Chapter 8
F Commands
fc-management enable
fc-management enable
To enable the Fibre Channel Common Transport (FC-CT) Management Security, use the
fc-management enable command. To disable this feature command, use the no form of the command.
fc-management enable
no fc-management enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 6.2(9)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable the FC-CT management security:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# fc-management enable
switch(config)#
Related Commands
Command
Description
show fc-management
Displays the FC-CT management security information.
Cisco MDS 9000 Family Command Reference
8-24
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcc priority
fcc priority
To assign the FCC priority to the entire switch, use the fcc priority command in configuration mode. To
revert to the default, use the no form of the command.
fcc priority number
no fcc priority number
Syntax Description
number
Defaults
The default priority is 4.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
5.0(1a)
This command was deprecated.
Usage Guidelines
Note
Examples
The FCC priority threshold. The range is 0 to 7, where 0 is the lowest priority
and 7 the highest priority.
FCC reduces the congestion in the traffic without interfering with the standard Fibre Channel protocol.
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example shows how to configure the FCC priority threshold as 2:
switch# config terminal
switch(config)# fcc priority 2
Related Commands
Command
Description
show fcc
Displays FCC settings.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-25
Chapter 8
F Commands
fcdomain
fcdomain
To configure the Fibre Channel domain feature, use the fcdomain command. To disable the FC
domain, use the no form of the command.
fcdomain {allowed domain vsan vsan-id | auto-reconfigure vsan vsan-id |
contiguous-allocation vsan vsan-id | domain id {preferred | static} vsan vsan-id |
fabric-name name vsan vsan-id |
fcid {database | persistent vsan vsan-id} | optimize all vsan vsan-id | optimize fast-restart
vsan vsan-id | optimize scale-restart vsan van-id | optimize selective-restart vsan vasn-id |
priority value vsan vsan-id | restart [disruptive] vsan vsan-id | vsan vsan-id}
no fcdomain {allowed domain vsan vsan-id | auto-reconfigure vsan vsan-id |
contiguous-allocation vsan vsan-id | domain id {preferred | static} vsan vsan-id |
fabric-name name vsan vsan-id | fcid persistent vsan vsan-id | optimize all vsan vsan-id |
optimize fast-restart vsan vsan-id | optimize scale-restart vsan van-id | optimize
selective-restart vsan vasn-id | priority value vsan vsan-id | vsan vsan-id}
Syntax Description
allowed domain
Configures the allowed domain ID list ranging from 1 to 239.
vsan vsan-id
Specifies a VSAN ID. The range is 1 to 4093.
auto-reconfigure
Configures autoreconfigure.
contiguous-allocation
Configures contiguous allocation.
domain id
Configures the domain ID and its type. The range is 0 to 239.
preferred
Configures the domain ID as preferred. By default, the local switch accepts
the domain ID assigned by the principal switch and the assigned domain ID
becomes the runtime domain ID.
static
Configures the domain ID as static. The assigned domain ID is discarded,
all local interfaces are isolated, and the local switch assigns itself the configured domain ID, which becomes the runtime domain ID.
fabric-name name
Specifies the fabric name. The name format is hh:hh:hh:hh:hh:hh:hh:hh.
fcid
Configures FC domain persistent FC IDs.
database
Enters persistent FC IDs submode.
persistent
Enables or disables FC domain persistent FC IDs.
optimize all
Enables a domain manager all optimization on a specified VSAN.
optimize fast-restart
Enables a domain manager fast restart on a specified VSAN.
optimize scale-restart
Enables a domain manager scale restart on a specified VSAN.
optimize selective-restart
Enables a domain manager selective restart on a specified VSAN.
priority value
Specifies the FC domain priority. The range is 1 to 254.
restart
Starts a disruptive or nondisruptive reconfiguration.
disruptive
Forces the disruptive fabric reconfiguration.
Cisco MDS 9000 Family Command Reference
8-26
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcdomain
Defaults
Enabled.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(9)
5.x
Added the optimize all and scale-restart keywords to the syntax description.
disruptive keyword is hidden from fcdomain restart command.
Usage Guidelines
1.1(1)
This command was introduced.
2.0(1)
The global-enable keyword was deprecated.
3.0(2)
Added the optimize fast-restart option.
You can use this command to select the principal switch, configure domain ID distribution, reconfigure
the fabric, and allocate FC IDs.
We recommend using the optimize fast-restart option on most fabrics, especially those with a large
number of logical ports (3200 or more), where a logical port is an instance of a physical port in a
VSAN.
It is not recommended to use disruptive restart followed by VSAN suspend / no-suspend, since it is
used only for recovery purpose when normal restart does not solve the problem.
Examples
The following examples show how to configure the Fibre Channel domain feature:
switch# config terminal
switch(config)# fcdomain domain 3 preferred vsan 87
switch(config)# no fcdomain domain 3 preferred vsan 87
switch(config)# fcdomain domain 2 static vsan 237
switch(config)# no fcdomain domain 2 static vsan 237
switch(config)# fcdomain restart vsan 1
switch(config)# fcdomain restart disruptive vsan 1
switch(config)# fcdomain optimize all vsan 3
switch(config)# fcdomain optimize all vsan 7 - 10
switch(config)# fcdomain optimize fast-restart vsan 3
switch(config)# fcdomain optimize fast-restart vsan 7 - 10
switch(config)# fcdomain optimize scale-restart vsan 3
switch(config)# fcdomain optimize scale-restart vsan 7 - 10
switch(config)# fcdomain optimize selective-restart vsan 3
switch(config)# fcdomain optimize selective-restart vsan 7 - 10
switch(config)# fcdomain priority 25 VSAN 99
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-27
Chapter 8
F Commands
fcdomain
switch(config)# no fcdomain priority 25 VSAN 99
switch(config)# fcdomain auto-reconfigure vsan 10
switch(config)# fcdomain contiguous-allocation vsan 81-83
switch(config)# no fcdomain contiguous-allocation vsan 1030
switch(config)# fcdomain fabric-name 20:1:ac:16:5e:0:21:01 vsan 3
switch(config)# no fcdomain fabric-name 20:1:ac:16:5e:0:21:01 vsan 3010
switch(config)# fcdomain allowed 50-110 vsan 4
switch(config)# no fcdomain allowed 50-110 vsan 5
Related Commands
Command
Description
show fcdomain
Displays global information about the FC domain configurations.
Cisco MDS 9000 Family Command Reference
8-28
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcdomain abort vsan
fcdomain abort vsan
To flush cached data without committing and to release the lock, use the fcdomain abort vsan
command.
fcdomain abort vsan vsan-id
Syntax Description
vsan-id
Defaults
Enabled.
Command Modes
Configuration mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Specifies a VSAN ID. The range is 1 to 4093.
Usage Guidelines
None.
Examples
The following examples show how to flush cached data:
switch# config terminal
switch(config)# fcdomain abort vsan 10
Related Commands
Command
Description
fcdomain
Configures Fibre Channel domain features.
fcdomain commit vsan Commits cached data and releases the lock.
show fcdomain
Displays global information about the FC domain configurations.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-29
Chapter 8
F Commands
fcdomain commit vsan
fcdomain commit vsan
To commit cached data and release the lock, use the fcdomain commit vsan command.
fcdomain commit vsan vsan-id
Syntax Description
vsan-id
Defaults
Enabled.
Command Modes
Configuration mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Note
Examples
Specifies a VSAN ID. The range is 1 to 4093.
None.
After the FC domain commit is completed the running configuration has been modified on all switches
participating in the FCd omain distribution. You can then use the copy running-config startup-config
fabric command to save the running configuration to the startup configuration on all the switches in the
fabric.
The following example shows how to commit cached data:
switch# config terminal
switch(config)# fcdomain commit vsan 10
Related Commands
Command
Description
fcdomain
Configures Fibre Channel domain features.
fcdomain abort vsan
Flushes cached data without committing and releases the lock.
show fcdomain
Displays global information about the FC domain configurations.
Cisco MDS 9000 Family Command Reference
8-30
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcdomain distribute
fcdomain distribute
To enable fabric distribution using Cisco Fabric Services (CFS), use the fcdomain distribute command.
To disable fabric distribution using CFS, us the no form of the command.
fcdomain distribute
no fcdomain distribute
Syntax Description
This command has no arguments or keywords
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example enables fabric distribution using CFS:
switch# config terminal
switch(config)# fcdomain distribute
The following example disables fabric distribution using CFS:
switch(config)# no fcdomain distribute
Related Commands
Command
Description
fcdomain
Configures Fibre Channel domain features.
show fcdomain
Displays global information about the FC domain configurations.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-31
Chapter 8
F Commands
fcdomain rcf-reject
fcdomain rcf-reject
To enable the RCF reject flag for a Fibre Channel or FCIP interface, use the fcdomain option. To disable
this feature, use the no form of the command.
fcdomain rcf-reject vsan number
no fcdomain rcf-reject vsan number
Syntax Description
vsan vsan-id
Defaults
Enabled.
Command Modes
Interface configuration submode.
Command History
Release
Modification
1.1(1a)
This command was introduced.
Usage Guidelines
Specifies a VSAN ID. The range is 1 to 4093.
Access this command from the switch(config-if)# submode.
Use this option to configure the RCF reject option for the selected Fibre Channel or FCIP interface.
Examples
The following example shows how to configure the FCIP RCF reject fcdomain feature:
switch# config terminal
switch(config)# interface fcip 1
switch(config-if)# fcdomain rcf-reject vsan 1
Related Commands
Command
Description
show fcdomain
Displays global information about the FC domain configurations.
show interface fcip
Displays an interface configuration for a specified FCIP interface.
Cisco MDS 9000 Family Command Reference
8-32
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcdroplatency
fcdroplatency
To configure the network and switch FC drop latency time, use the fcdroplatency command in
configuration mode. To disable the FC latency time, use the no form of the command.
fcdroplatency {network milliseconds [vsan vsan-id] | switch milliseconds}
no fcdroplatency {network milliseconds [vsan vsan-id] | switch milliseconds
Syntax Description
Defaults
network milliseconds
Specifies network latency. The range is 500 to 60000.
vsan vsan-id
Specifies a VSAN ID. The range is 1 to 4093.
switch milliseconds
Specifies switch latency. The range is 0 to 60000 milliseconds.
2000 millisecond network latency.
500 millisecond switch latency.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure the network latency to 5000 milliseconds:
switch# config terminal
switch(config)#
switch(config)# fcdroplatency network 5000
switch(config)#
The following example shows how to revert to the default network latency:
switch(config)# no fcdroplatency network 5000
switch(config)#
The following example shows how to configure the switch latency to 4000 milliseconds:
switch(config)# fcdroplatency switch 4000
switch(config)#
The following example shows how to revert to the default switch latency:
switch(config)# no fcdroplatency switch 4000
switch(config)#
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-33
Chapter 8
F Commands
fcdroplatency
Related Commands
Command
Description
show fcdroplatency
Displays the configured FC drop latency parameters.
Cisco MDS 9000 Family Command Reference
8-34
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcflow stats
fcflow stats
To configure FC flow statistics, use the fcflow stats command in configuration mode. To disable the
counter, use the no form of the command.
fcflow stats {aggregated module module-number index flow-number vsan vsan-id | module
module-number index flow-number destination-fcid source-fcid netmask vsan vsan-id}
no fcflow stats {aggregated module module-number index flow-number | module module-number
index flow-number}
Syntax Description
aggregated
Configures aggregated FC flow statistics.
module module-number Configures FC flow statistics on a module.
index flow-number
Specifies a flow index. The range is 1 to 2147483647.
vsan vsan-id
Specifies a VSAN ID. The range is 1 to 4093.
destination-fcid
The destination FCID in hexadecimal format.
source-fcid
The source FCID in hexadecimal format.
netmask
The mask for the source and destination FCID (restricted to 6 hexadecimal
characters ranging from 0xff0000 to 0xffffff).
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
If you enable flow counters, you can enable a maximum of I K entries for aggregate flow and flow
statistics. Be sure to assign an unused flow index to a module for each new flow. Flow indexes can be
repeated across modules. The number space for flow index is shared between the aggregate flow
statistics and the flow statistics.
Examples
The following example shows how to configure aggregated fcflow statistics for module 1:
switch-config# fcflow stats aggregated module 1
switch-config#
The following example enables the aggregated flow counter.
switch(config)# fcflow stats aggregated module 1 index 1005 vsan 1
The following example disables the aggregated flow counter.
switch(config)# no fcflow stats aggregated module 1 index 1005
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-35
Chapter 8
F Commands
fcflow stats
The following example enables the flow counter for module 1:
switch(config)# fcflow stats module 1 index 1 0x145601 0x5601 0xffffff vsan 1
The following example disables the flow counter for module 1.
switch(config)# no fcflow stats module 2 index 1001
Related Commands
Command
Description
show fcflow stats
Displays the configured FC drop latency parameters.
Cisco MDS 9000 Family Command Reference
8-36
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcid-allocation
fcid-allocation
Use the fcid-allocation command to manually add a FCID to the default area company ID list. Use the
no form of the command to remove a FCID from the default area company ID list.
fcid-allocation area company-id company-id
no fcid-allocation area company-id company-id
Syntax Description
area
Modifies the auto area list of company IDs.
company-id
company-id
Configures the company IDs.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0
This command was introduced.
Usage Guidelines
Fibre Channel standards require a unique FCID to be allocated to an N port attached to a Fx port in any
switch. To conserve the number of FCIDs used, Cisco MDS 9000 Family switches use a special
allocation scheme.
Some HBAs do not discover targets that have FCIDs with the same domain and area. Prior to Cisco
MDS SAN-OS Release 2.0, the Cisco MDS SAN-OS software maintained a list of tested company ID
(also know as Organizational Unit Identifier, or OUI) which do not exhibit this behavior. These Host Bus
Adapters (HBAs) were allocated with single FCIDs, and for others a full area was allocated.
The FCID allocation scheme available in Release 1.3 and earlier, allocates a full area to these HBAs.
This allocation isolates them to that area and are listed with their pWWN during a fabric login. The
allocated FCIDs are cached persistently and are still available in Cisco MDS SAN-OS Release 2.0 (see
the “FCID Allocation for HBAs” section on page 38-22).
As of Cisco MDS SAN-OS Release 2.0, to allow further scalability for switches with numerous ports,
the Cisco MDS SAN-OS software is maintaining a list of HBAs exhibiting this behavior. Each HBA is
identified by its company ID used in the pWWN during a fabric log in. A full area is allocated to the N
ports with company IDs that are listed and for the others a single FCID is allocated. Irrespective of the
kind (whole area or single) of FCID allocated, the FCID entries remain persistent.
Examples
The following example adds a new company ID to the default area company ID list:
switch# config terminal
switch(config)# fcid-allocation area company-id 0x003223
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-37
Chapter 8
F Commands
fcid-allocation
Related Commands
Command
Description
show fcid-allocation
Displays the configured company IDs.
Cisco MDS 9000 Family Command Reference
8-38
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcid-last-byte
fcid-last-byte
Use the fcid-last-byte command to allocate the last byte FCID for the fabric address. To disable the
configuration or to revert to factory defaults, use the no form of the command.
fcid-last-byte last-byte-id
no fcid-last-byte last-byte-id
Syntax Description
last-byte-fcid
Defaults
None.
Command Modes
FICON configuration submode.
Command History
Release
Specifies the last-byte FCID range from 0 to 250.
Modification
1.3(1)
This command was introduced.
3.0(1)
This command was deprecated.
Usage Guidelines
This is an optional configuration. If you are not sure of the EBCDIC format to be used, we recommend
retaining the us-canada (default) option.
Examples
The following example assigns the last byte FCID for the fabric address:
switch# config terminal
switch(config)# ficon vsan 2
switch(config-ficon)# fcid-last-byte 12
The following example removes the configured last byte FCID for the fabric address and reverts to the
default:
switch# config terminal
switch(config)# ficon vsan 2
switch(config-ficon)# no fcid-last-byte 3
Related Commands
Command
Description
ficon vsan vsan-id
Enables FICON on the specified VSAN.
show ficon
Displays configured FICON details.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-39
Chapter 8
F Commands
fcinterop fcid-allocation
fcinterop fcid-allocation
To allocate FCIDs on the switch, use the fcinterop fcid-allocation command in configuration mode. To
disable FCIDs on the switch, use the no form of the command.
fcinterop fcid-allocation {auto | flat | none}
no fcinterop fcid-allocation {auto | flat | none}
Syntax Description
auto
Assigns single FCID to compatible HBAs.
flat
Assigns single FCID.
none
Assigns FCID range.
Defaults
The default is fcinterop fcid-allocation auto.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
This command defines how the switch assigns FCIDs.
Examples
The following example shows how to allocate FCIDs on the switch:
switch# config terminal
switch(config)# fcinterop fcid-allocation none
switch(config)# fcinterop fcid-allocation flat
switch(config)# fcinterop fcid-allocation auto
Related Commands
Command
Description
show flogi database
Displays the fabric login (FLOGI) table.
Cisco MDS 9000 Family Command Reference
8-40
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcinterop loop-monitor
fcinterop loop-monitor
To monitor removal of discs from a loop port, use the fcinterop loop-monitor command in configuration
mode. To disable loop monitoring, use the no form of the command.
fcinterop loop-monitor
no fcinterop loop-monitor
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
This command detects devices that are removed from a looped port:
Examples
The following example shows how to enable monitoring of NL ports in a loop:
switch# config terminal
switch(config)# fcinterop loop-monitor
The following example shows how to disable monitoring of NL ports in a loop:
switch# config terminal
switch(config)# no fcinterop loop-monitor
Related Commands
Command
Description
show flogi database
Verifies if a storage device is displayed in the Fabric login (FLOGI) table.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-41
Chapter 8
F Commands
fcip enable
fcip enable
To enable the FCIP feature in any switch in the Cisco MDS 9000 Family, use the fcip enable command.
fcip enable
no fcip enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
NX-OS 4.1(1b)
This command was deprecated.
Usage Guidelines
Note
Examples
The configuration and verification commands for the iSCSI feature are only available when FCIP is
enabled on a switch. When you disable this feature, all related configurations are automatically
discarded.
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following command enables the FCIP feature:
switch(config)# fcip enable
The following command disables the FCIP feature (default):
switch(config)# no fcip enable
Related Commands
Command
Description
show fcip
Displays FCIP information.
Cisco MDS 9000 Family Command Reference
8-42
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcip profile
fcip profile
To create and configure an FCIP profile, use the fcip profile command. To remove an FCIP profile, use
the no form of the command.
fcip profile profile-id
no fcip profile profile-id
Syntax Description
profile-id
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
1.1(1)
This command was introduced.
Usage Guidelines
Note
Examples
Specifies a ID range from 1 to 255.
When you perform this command, the CLI enters FCIP profile configuration mode.
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example shows how to configure an FCIP profile:
switch## config terminal
switch(config)# fcip profile 5
switch(config-profile)#
Related Commands
Command
Description
interface fcip
interface_number
use-profile profile-id
Configures the interface using an existing profile ID from 1 to 255.
show fcip profile
Displays information about the FCIP profile.
show interface fcip
Displays an interface configuration for a specified FCIP interface.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-43
Chapter 8
F Commands
fcns bulk-notify
fcns bulk-notify
To enable transmission of multiple name server entry change notifications in one Messaging and
Transaction Services (MTS) payload, use the fcns bulk-notify command. To disable bulk notify, use the
no form of this command.
fcns bulk-notify
no fcns bulk-notify
Syntax Description
This command has no keywords or arguments.
Defaults
Bulk notification from the name server is disabled by default. For 6.2(9) and later releases, bulk
notification from the name server is enabled by default.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(7)
This command was introduced.
6.2(9)
This command was deprecated.
Usage Guidelines
Note
Examples
Enabling the fcns bulk-notify command would improve the performance of the components like Zone,
IVR, QOS, IPS.
Run the show fcns internal info global command to determine if the bulk notification is enabled.
The following example shows how to enable transmission of multiple name server entry change
notifications in one MTS payload:
switch# config terminal
switch(config)# fcns bulk-notify
switch(config)#
Related Commands
Command
Description
show fcns internal info Displays the FCNS global configuration.
global
Cisco MDS 9000 Family Command Reference
8-44
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcns no-bulk-notify
fcns no-bulk-notify
To disable transmission of multiple name server entry change notifications in one MTS payload, use the
fcns no-bulk-notify command. To re-enable bulk notification once it is disabled, use the no form of this
command.
fcns no-bulk-notify
no fcns no-bulk-notify
Syntax Description
This command has no keywords or arguments.
Defaults
Bulk notification from the name server is disabled by default. For 6.2(9) and later releases, bulk
notification from the name server is enabled by default.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(9)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to disable transmission of multiple name server entry change
notifications in one MTS payload:
switch# config terminal
switch(config)# fcns no-bulk-notify
switch(config)#
The following example shows how to re-enable bulk notification once it has been disabled:
switch# config terminal
switch(config)# no fcns no-bulk-notify
switch(config)#
Related Commands
Command
Description
fcns bulk-notify
Available until Release 6.2(7) only. Enables transmission of multiple name
server entry change notifications in one MTS payload.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-45
Chapter 8
F Commands
fcns proxy-port
fcns proxy-port
To register a name server proxy, use the fcns proxy-port command in configuration mode.
fcns proxy-port wwn-id vsan vsan-id
no fcns proxy-port wwn-id vsan vsan-id
Syntax Description
wwn-id
Specifies the port WWN, with the format hh:hh:hh:hh:hh:hh:hh:hh.
vsan vsan-id
Specifies a VSAN ID. The range is 1 to 4093.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
One name server can be configured to proxy another name server and name server information can be
displayed using the CLI. The name server can be viewed using the CLI or Cisco Fabric Manager.
All name server registration requests come from the same port whose parameter is registered or changed.
If it does not, then the request is rejected.
Examples
The following example shows configuring a proxy port for VSAN 2:
switch# config terminal
switch(config)# fcns proxy-port 21:00:00:e0:8b:00:26:d vsan 2
Related Commands
Command
Description
show fcns
Displays the name server database and statistical information for a specified
VSAN or for all VSANs.
Cisco MDS 9000 Family Command Reference
8-46
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcns reject-duplicate-pwwn vsan
fcns reject-duplicate-pwwn vsan
To reject the same pwwn from logging in the different switch, use the fcns reject-duplicate-pwwn vsan
command in configuration mode.
fcns reject-duplicate-pwwn vsan vsan-id
no fcns reject-duplicate-pwwn vsan vsan-id
Syntax Description
vsan-id
Defaults
Enabled.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Specifies a VSAN ID. The range is 1 to 4093.
Usage Guidelines
None.
Examples
The following example rejects duplicate FCNS pWWNs for VSAN 2:
switch# configure terminal
switch(config)# fcns reject-duplicate-pwwn vsan 2
Related Commands
Command
Description
show fcns
Displays the name server database and statistical information for a specified
VSAN or for all VSANs.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-47
Chapter 8
F Commands
fcping
fcping
To ping an N port with a specified FCID, use the fcping fcid command in EXEC mode.
fcping {device-alias aliasname | fcid {fc-port | domain-controller-id} | pwwn pwwn-id} vsan
vsan-id [count number [timeout value [usr-priority priority]]]
Syntax Description
device-alias aliasname
Specifies the device alias name. Maximum length is 64 characters.
fcid
The FCID of the destination N port.
fc-port
The port FCID with the format 0xhhhhhh.
domain-controller-id
Verifies connection to the destination switch.
pwwn pwwn-id
Specifies the port WWN of the destination N port, with the format
hh:hh:hh:hh:hh:hh:hh:hh.
vsan vsan-id
Specifies the VSAN ID of the destination N port. The range is 1 to 4093.
count number
(Optional) Specifies the number of frames to send. A value of 0 sends
forever. The range is 0 to 2147483647.
timeout value
(Optional) Specifies the timeout value in seconds. The range is 1 to 10.
usr-priority priority
(Optional) Specifies the priority the frame receives in the switch fabric. The
range is 0 to 1.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
1.2(1)
Allowed the domain controller ID as an FCID.
2.0(x)
Added the device-alias aliasname option.
Usage Guidelines
To obtain the domain controller address, concatenate the domain ID with FFFC. For example, if the
domain ID is 0xda(218), the concatenated ID is 0xfffcda.
Examples
The following example shows a fcping operation for the specified pWWN or the FCID of the destination.
By default, five frames are sent.
switch# fcping
28 bytes from
28 bytes from
28 bytes from
28 bytes from
28 bytes from
fcid 0xd70000 vsan 1
0xd70000 time = 730
0xd70000 time = 165
0xd70000 time = 262
0xd70000 time = 219
0xd70000 time = 228
usec
usec
usec
usec
usec
Cisco MDS 9000 Family Command Reference
8-48
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcping
5 frames sent, 5 frames received, 0 timeouts
Round-trip min/avg/max = 165/270/730 usec
The following example shows the setting of the number of frames to be sent using the count option. The
range is from 0 through 2147483647. A value of 0 will ping forever.
switch# fcping
28 bytes from
28 bytes from
28 bytes from
28 bytes from
28 bytes from
28 bytes from
28 bytes from
28 bytes from
28 bytes from
28 bytes from
fcid 0xd70000 vsan 1
0xd70000 time = 730
0xd70000 time = 165
0xd70000 time = 262
0xd70000 time = 219
0xd70000 time = 228
0xd70000 time = 230
0xd70000 time = 230
0xd70000 time = 225
0xd70000 time = 229
0xd70000 time = 183
count 10
usec
usec
usec
usec
usec
usec
usec
usec
usec
usec
10 frames sent, 10 frames received, 0 timeouts
Round-trip min/avg/max = 165/270/730 usec
The following example shows the setting of the timeout value. The default period to wait is 5 seconds.
The range is from 1 through 10 seconds.
switch# fcping
28 bytes from
28 bytes from
28 bytes from
28 bytes from
28 bytes from
fcid 0xd500b4 vsan 1 timeout 10
0xd500b4 time = 1345 usec
0xd500b4 time = 417 usec
0xd500b4 time = 340 usec
0xd500b4 time = 451 usec
0xd500b4 time = 356 usec
5 frames sent, 5 frames received, 0 timeouts
Round-trip min/avg/max = 340/581/1345 usec
This command shows the No response from the N port message even when the N port or NL port is
active. This is due to resource exhaustion at the N port or NL port. Retry the command a few seconds
later.
switch# fcping fcid 0x010203 vsan 1
No response from the N port.
switch# fcping pwwn 21:00:00:20:37:6f:db:dd
28 bytes from 21:00:00:20:37:6f:db:dd time =
28 bytes from 21:00:00:20:37:6f:db:dd time =
28 bytes from 21:00:00:20:37:6f:db:dd time =
28 bytes from 21:00:00:20:37:6f:db:dd time =
28 bytes from 21:00:00:20:37:6f:db:dd time =
vsan 1
1454 usec
471 usec
372 usec
364 usec
1261 usec
5 frames sent, 5 frames received, 0 timeouts
Round-trip min/avg/max = 364/784/1454 usec
The following example displays fcping operation for the device alias of the specified destination:
switch# fcping device-alias x vsan 1
28 bytes from 21:01:00:e0:8b:2e:80:93 time = 358 usec
28 bytes from 21:01:00:e0:8b:2e:80:93 time = 226 usec
28 bytes from 21:01:00:e0:8b:2e:80:93 time = 372 usec
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-49
Chapter 8
F Commands
fc-redirect version2 enable
fc-redirect version2 enable
To enable FC redirect version2 mode, use the fc-redirect version2 enable command in configuration
mode. To disable this feature, use the no form of the command.
fc-redirect version2 enable
no fc-redirect version2 enable
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
AAM mode can be enabled in version1 mode also.
Examples
The following example shows how to enable FC redirect version2 mode:
switch# config terminal
switch(config)# fc-redirect version2 enable
Please make sure to read and understand the following implications
before proceeding further:
1) This is a Fabric wide configuration. All the switches in the
fabric will be configured in Version2 mode.Any new switches
added to the fabric will automatically be configured in version2
mode.
2) SanOS 3.2.x switches CANNOT be added to the Fabric after Version2
mode is enabled. If any 3.2.x switch is added when Version2 mode
is enabled, all further FC-Redirect Configuration changes will Fail
across the fabric. This could lead to traffic disruption for
applications like SME.
3) If enabled, Version2 mode CANNOT be disabled till all FC-Redirect
configurations are deleted. FC-Redirect configurations can be
deleted ONLY after all the relevant application configurations
are deleted. Please use the command 'show fc-redirect configs'
to see the list of applications that created FC-Redirect
configurations.
4) 'write erase' will NOT disable this command. After 'write erase'
on ANY switch in the fabric, the user needs to do:
Cisco MDS 9000 Family Command Reference
8-50
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fc-redirect version2 enable
on
to
in
to
'clear fc-redirect decommission-switch'
that that switch. Without that, if the user moves the switch
a different fabric it will try to convert all the switches
the fabric to Version2 mode automatically. This might lead
Error conditions and hence Traffic disruption.
Do you want to continue? (Yes/No) [No]
isola-77(config)#
The following example shows how to disable FC redirect version2 mode:
switch# config terminal
switch(config)# no fc-redirect version2 enable
WARNING: This command will disable Version2 mode throughout the fabric.
This is NOT a recommended step.
Do you want to continue? (Yes/No) [No]
switch(config)#
Related Commands
Command
Description
show fc-redirect-active Displays all active configurations on a switch.
configs
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-51
Chapter 8
F Commands
fc-redirect ivr-support enable
fc-redirect ivr-support enable
To enable FC redirect IVR support, use the fc-redirect ivr-support enable command in configuration
mode. To disable this feature, use the no form of the command.
fc-redirect ivr-support enable
no fc-redirect ivr-support enable
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
configuration mode.
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable FC redirect IVR support:
switch# config terminal
switch(config)# fc-redirect ivr-support enable
switch(config)#
The following example shows how to disable FC redirect IVR support:
switch# config terminal
switch(config)# no fc-redirect ivr-support enable
switch(config)#
Related Commands
Command
Description
show fc-redirect-active Displays all active configurations on a switch.
configs
Cisco MDS 9000 Family Command Reference
8-52
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcroute
fcroute
To configure Fibre Channel routes and to activate policy routing, use the fcroute command. To remove
a configuration or revert to factory defaults, use the no form of the command.
fcroute {fcid network-mask interface {fc slot/port | port-channel port} domain domain-id {metric
number | remote | vsan vsan-id} | policy fcroute-map vsan vsan-id [route-map-identifier]}
no fcroute {fcid network-mask interface {fc slot/port | port-channel port} domain domain-id
{metric number | remote | vsan vsan-id} | policy fcroute-map vsan vsan-id
[route-map-identifier]}
Syntax Description
fcid
Specifies the FC ID. The format is 0xhhhhhh.
network-mask
Specifies the network mask of the FC ID. The format is 0x0 to 0xffffff.
interface
Specifies an interface.
fc slot/port
Specifies a Fibre Channel interface.
port-channel port
Specifies a PortChannel interface.
domain domain-id
Specifies the route for the domain of the next hop switch. The range is 1 to
239.
metric number
Specifies the cost of the route. The range is 1 to 65535. Default cost is 10.
remote
Configures the static route for a destination switch remotely connected.
vsan vsan-id
Specifies a VSAN ID. The range is 1 to 4093.
policy fcroute-map
Activates policy routing.
route-map-identifier
(Optional) Specifies the route map identifier. The range is 1 to 65535.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(9)
This command was deprecated.
1.0(2)
This command was introduced.
3.0(3)
Added the policy option.
Usage Guidelines
Use this command to assign forwarding information to the switch and to activate a preferred path route
map.
Examples
The following example specifies the Fibre Channel interface and the route for the domain of the next hop
switch for VSAN 2:
switch# config terminal
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-53
Chapter 8
F Commands
fcroute
switch(config)# fcroute 0x111211 interface fc1/1 domain 3 vsan 2
The following example removes this configuration:
switch(config)# no fcroute 0x111211 interface fc1/1 domain 3 vsan 2
The following example specifies the PortChannel interface and the route for the domain of the next hop
switch for VSAN 4:
switch# config terminal
switch(config)# fcroute 0x111211 interface port-channel 1 domain 3 vsan 4
The following example removes this configuration:
switch(config)# no fcroute 0x111211 interface port-channel 1 domain 3 vsan 4
The following example specifies the Fibre Channel interface, the route for the domain of the next hop
switch, and the cost of the route for VSAN 1:
switch# config terminal
switch(config)# fcroute 0x031211 interface fc1/1 domain 3 metric 1 vsan 1
The following example removes this configuration:
switch(config)# no fcroute 0x031211 interface fc1/1 domain 3 metric 1 vsan 1
The following example specifies the Fibre Channel interface, the route for the domain of the next hop
switch, the cost of the route, and configures the static route for a destination switch remotely connected
for VSAN 3:
switch# config terminal
switch(config)# fcroute 0x111112 interface fc1/1 domain 3 metric 3 remote vsan 3
The following example removes this configuration:
switch(config)# no fcroute 0x111112 interface fc1/1 domain 3 metric 3 remote vsan 3
Related Commands
Command
Description
fcroute-map
Specifies a preferred path Fibre Channel route map.
fcroute policy
fcroute-map
Activates the preferred path Fibre Channel route map.
show fcroute
Displays Fibre Channel routes.
show fcroute-map
Displays the preferred path route map configuration and status.
Cisco MDS 9000 Family Command Reference
8-54
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcrxbbcredit extended enable
fcrxbbcredit extended enable
To enable Fibre Channel extended buffer-to-buffer credits (BB_credits), use the fcrxbbcredit extended
enable command in configuration mode. To disable the feature, use the no form of the command.
fcrxbbcredit extended enable
no fcrxbbcredit extended enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
Use the fcrxbbcredit extended enable command to enable the switchport fcrxbbcredit extended
command.
The fcrxbbcredit extended enable command is not supported on the following switches:
•
Cisco MDS 9124 Multilayer Fabric Switch
•
Cisco Fabric Switch for HP c-Class BladeSystem
•
Cisco Fabric Switch for IBM BladeCenter
•
Cisco MDS 9134 Multilayer Fabric Switch
•
Cisco MDS 9148 Multilayer Fabric Switch
•
Cisco MDS 9148S 16G Multilayer Fabric Switch
•
Cisco MDS 9250i Multiservice Fabric Switch
The following example shows how to enable Fibre Channel extended BB_credits:
switch# config terminal
switch(config)# fcrxbbcredit extended enable
The following example shows how to disable Fibre Channel extended BB_credits:
switch# config terminal
switch(config)# no fcrxbbcredit extended enable
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-55
Chapter 8
F Commands
fcrxbbcredit extended enable
Related Commands
Command
Description
show interface
Displays interface information and status.
switchport fcrxbbcredit extended Configures Fibre Channel extended BB_credits on an interface.
Cisco MDS 9000 Family Command Reference
8-56
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcs plat-check-global vsan
fcs plat-check-global vsan
To enable FCS platform and node name checking fabric-wide, use the fcs plat-check-global vsan
command in configuration mode. To disable this feature, use the no form of the command.
fcs plat-check-global vsan vsan-id
no fcs plat-check-global vsan vsan-id
Syntax Description
vsan-id
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Specifies the VSAN ID for platform checking, which is from 1 to 4096.
Usage Guidelines
None.
Examples
switch# config terminal
switch(config)# fcs plat-check-global vsan 2
Related Commands
Command
Description
show fcs
Displays fabric configuration server information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-57
Chapter 8
F Commands
fcs register
fcs register
To register FCS attributes, use the fcs register command in configuration mode. To disable this feature,
use the no form of the command.
fcs register platform name name vsan vsan-id
no fcs register platform name name vsan vsan-id
Syntax Description
platform name name
Specifies the name of the platform to register. Maximum size is 255
characters.
vsan vsan-id
Specifies the VSAN ID. The range is 1 to 4096.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to register FCS attributes:
switch# config terminal
switch(config)# fcs register
switch(config-fcs-register)# platform Platform1 vsan 10
Related Commands
Command
Description
show fcs
Displays fabric configuration server information.
Cisco MDS 9000 Family Command Reference
8-58
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcs virtual-device-add
fcs virtual-device-add
To include a virtual device in a query about zone information from an FCS, use the fcs
virtual-device-add command in configuration mode. To remove a virtual device, use the no form of the
command.
fcs virtual-device-add [vsan-ranges vsan-ids]
no fcs virtual-device-add [vsan-ranges vsan-ids]
Syntax Description
vsan-ranges vsan-ids
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
3.1(2)
This command was introduced.
(Optional) Specifies one or multiple ranges of VSANs. The range is 1 to
4093.
Usage Guidelines
VSAN ranges are entered as vsan-ids-vsan-ids. When you specify more than one range, separate each
range with a comma. If no range is specified, the command applies to all VSANs.
Examples
The following example shows how to add to one range of VSANs:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# fcs virtual-device-add vsan-ranges 2-4
The following example shows how to add to more than one range of VSANs:
switch# config t
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# fcs virtual-device-add vsan-ranges 2-4,5-8
Related Commands
Command
Description
show fcs
Displays fabric configuration server information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-59
Chapter 8
F Commands
fcsp
fcsp
To configure a Fibre Channel Security Protocol (FC-SP) authentication mode for a specific interface in
an FC-SP-enabled switch, use the fcsp command. To disable an FC-SP on the interface, use the no form
of the command.
fcsp {auto-active | auto-passive | esp manual | off | on} [timeout-period]
no fcsp {auto-active | auto-passive | esp manual | off | on} [timeout-period]
Syntax Description
auto-active
Configures the auto-active mode to authenticate the specified interface.
auto-passive
Configures the auto-passive mode to authenticate the specified interface.
esp
Configures the Encapsulating Security Payroll for an interface.
manual
Configures the Encapsulating Security Payroll in manual mode.
on
Configures the auto-active mode to authenticate the specified interface.
off
Configures the auto-active mode to authenticate the specified interface.
timeout-period
(Optional) Specifies the timeout period to reauthenticate the interface. The
time ranges from 0 (the default where no authentication is performed) to
100,000 minutes.
Defaults
Auto-passive.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(1)
Fibre Channel Security Protocol (FC-SP) is currently not supported on
MDS 9710, but targeted for a future release.
NX-OS 4.2(1)
Added esp keyword for the syntax description.
1.3(1)
This command was introduced.
Usage Guidelines
To use this command, FC-SP must be enabled using the feature fcsp command.
Examples
The following example shows how to configure the ESP in manual mode:
switch# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# interface fc 2/1 - 3
switch(config-if)# fcsp esp manual
switch(config-if-esp)#
The following example turns on the authentication mode for ports 1 to 3 in Fibre Channel interface 2:
switch# config terminal
Cisco MDS 9000 Family Command Reference
8-60
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcsp
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# interface fc 2/1 - 3
switch(config-if)# fcsp on
switch(config-if)#
The following example reverts to the factory default of auto-passive for these Fibre Channel interfaces:
switch(config-if)# no fcsp
The following example changes these Fibre Channel interfaces to initiate FC-SP authentication, but does
not permit reaunthentication:
switch(config-if)# fcsp auto-active 0
The following example changes these Fibre Channel interfaces to initiate FC-SP authentication and
permits reaunthentication within two hours (120 minutes) of the initial authentication attempt:
switch(config-if)# fcsp auto-active 120
Related Commands
Command
Description
fcsp enable
Enables FC-SP.
show fcsp interface
Displays FC-SP-related information for a specific interface.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-61
Chapter 8
F Commands
fcsp dhchap devicename
fcsp dhchap devicename
Asymmetric DHCHAP secrets may be used on FC-SP links. To populate the FC-SP DHCHAP secret
database on the local switch with the secrets used by remote switches use the fcsp dhchap devicename
command. To remove these entries use the no form of the command.
fcsp dhchap devicename remote-switch-wwn password [ 0 | 7 ] remote-secret
fcsp dhchap devicename remote-switch-wwn password [ 0 | 7 ] remote-secret
Syntax Description
remote-switch-wwn
Switch World Wide Name (WWN) of the remote device. The WWN format
is hh:hh:hh:hh:hh:hh:hh:hh.
password
Configures the DHCHAP secret for the remote device.
0
(Optional) Specifies that the secret is in cleartext.
7
(Optional) Specifies that the secret is in encrypted text. This is the default
value.
remote-secret
DHCHAP secret. Maximum of 64 alphanumeric characters.
Defaults
The default entry format for the secret is encrypted.
Command Modes
Global configuration (config).
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
The fcsp dhchap devicename command is available only when the FC-SP feature is enabled.
Examples
The following example shows how to configure an encrypted secret of a remote switch:
switch (config)# fcsp dhchap devicename 00:11:22:33:44:aa:bb:cc password mypassword
The following example shows how to remove the remote switch secret of the previous example from the
local switch DHCHAP secret
switch(config)# no fcsp dhchap devicename 00:11:22:33:44:aa:bb:cc password mypassword
The following example shows an asymmetric secret configuration for a link between the local switch and
a remote switch with switch WWN of 01:01:01:01:01:01:01:01. The secret on the local switch is
'local_secret' and the remote switch has a secret of 'far_secret'. The configuration is for the local switch
and the secrets:
switch(config)# fcsp dhchap password 0 local_secret 01:01:01:01:01:01:01:01
switch(config)# fcsp dhchap devicename 01:01:01:01:01:01:01:01 password 0 far_secret
Cisco MDS 9000 Family Command Reference
8-62
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcsp dhchap devicename
Related Commands
Command
Description
fcsp enable
Enables FC-SP.
fcsp dhchap dhgroup
Configure FC-SP group priority list.
fcsp dhchap hash
Configure FC-SP hash priority list.
fcsp dhchap password Configure FC-SP link secrets.
show fcsp
Displays configured FC-SP information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-63
Chapter 8
F Commands
fcsp dhchap dhgroup
fcsp dhchap dhgroup
To change the FC-SP DHCHAP group priority list, use the fcsp dhchap dhgroup command in global
configuration mode. To revert to the default group priority list, use the no form of this command.
fcsp dhchap dhgroup group-id [group-id [group-id [group-id [group-id]]]]
no fcsp dhchap dhgroup group-id [group-id [group-id [group-id [group-id]]]]
Syntax Description
group-id
Defaults
The default DH group priority list, from highest to lowest is 0 4 1 2 3.
Command Modes
Global configuration (config).
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
0|1|2|3|4 Specifies an FC-SP DHCHAP group priority list entry.
The fcsp dhchap dhgroup command is available only when the FC-SP feature is enabled.
There must be at least one member in the DH group priority list. Each group may only be specified once.
If you change the default FC-SP DH group priority list, ensure that you change it globally for all the
switches in the fabric.
The Table 8-1 maps the Cisco Group Number with the corresponding RFC Group Number and Modular
Exponentiation (MODP) Group:
Table 8-1
Examples
Cisco Group Number with Corresponding RFC Group Number and MODP Group
Cisco Group Number
RFC Group Number
MODP Group
0
null
null DH algorithm
1
2
1024
2
—
1280
3
5
1536
4
14
2048
The following example shows how to configure the used DH group list to only groups 2, 3, and 4, in the
same order of priority:
switch (config)# fcsp dhchap dhgroup 2 3 4
Cisco MDS 9000 Family Command Reference
8-64
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcsp dhchap dhgroup
The following example shows how to revert a previously configured DH group priority list of the 'null'
group only back to the default priority list:
switch(config)# no fcsp dhchap dhgroup 0
Related Commands
Command
Description
fcsp enable
Enables FC-SP.
fcsp dhchap
devicename
Configure FC-SP asymmetric secrets.
fcsp dhchap hash
Configure FC-SP hash priority list.
fcsp dhchap password Configure FC-SP link secrets.
show fcsp
Displays configured FC-SP information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-65
Chapter 8
F Commands
fcsp dhchap hash
fcsp dhchap hash
To configure the hash algorithm priority list for FC-SP DHCHAP authentication use the fcsp dhchap
hash command. To return to the default hash algorithm priority list use the no form of the command.
fcsp dhchap hash{md5 [sha1] | sha1 [md5]}
no fcsp dhchap hash{md5 [sha1] | sha1 [md5]}
Syntax Description
Defaults
md5
(Optional) Specifies the MD5 hash algorithm.
sha1
(Optional) Specifies the SHA-1 hash algorithm.
The default FC-SP DHCHAP hash algorithm priority list has the following order:
•
MD5
•
SHA-1
Command Modes
Global configuration (config).
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
The fcsp dhchap hash command is available only when the FC-SP feature is enabled.
If you change the default hash algorithm list order, then change it in all switches in the fabric.
Warning
Examples
If FC-SP DHCHAP authentication via AAA is enabled, the MD5 hash algorithm must be set if the AAA
authentication uses RADIUS or TACACS+. This is because RADIUS and TACACS+ applications do not
support other hash algorithms.
The following example shows how to configure the DHCHAP authentication hash priority list to be
SHA-1 followed by MD5:
switch (config)# fcsp dhchap hash sha1 md5
The following example shows how to configure the use of the SHA-1 hash algorithm only:
switch(config)# fcsp dhchap hash sha1
The following example shows how to revert the previous example to the default priority list:
switch(config)# no fcsp dhchap hash sha1
Cisco MDS 9000 Family Command Reference
8-66
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcsp dhchap hash
Related Commands
Command
Description
fcsp enable
Enables FC-SP.
fcsp dhchap
devicename
Configure FC-SP asymmetric secrets.
fcsp dhchap dhgroup
Configure FC-SP group priority list.
fcsp dhchap password Configure FC-SP link secrets.
show fcsp
Displays configured FC-SP information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-67
Chapter 8
F Commands
fcsp dhchap password
fcsp dhchap password
To configure the FC-SP DHCHAP secret database used for FC-SP peer switch link authentication via
DHCHAP use the fcsp dhchap password command. To remove secrets from the FC-SP DHCHAP
database use the no form of the command.
fcsp dhchap password [0 | 7] secret [remote-switch-wwn]
no fcsp dhchap password [0 | 7] secret [remote-switch-wwn]
Syntax Description
secret
DHCHAP secret. Maximum of 64 alphanumeric characters.
remote-switch-wwn
(Optional) Switch World Wide Name of the remote switch to use this secret
with. The WWN format is hh:hh:hh:hh:hh:hh:hh:hh.
Defaults
The default entry format for the secret is encrypted.
Command Modes
Global configuration (config).
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
The fcsp dhchap password command is available only when the FC-SP feature is enabled.
Be sure to configure an FC-SP DHCHAP database on each switch in the fabric when this facility is being
used.
To configure a fabric-wide global FC-SP DHCHAP secret use the command without any switch WWN
specifier. There can be only a single global FC-SP DHCHAP secret in a fabric. Additionally, switch
specific secrets may be configured. To configure these specify the switch WWN.
Examples
The following example show how to configure the global FC-SP DHCHAP secret in cleartext:
switch (config)# fcsp dhchap password 0 mypassword
The following example show how to configure a secret to be used with the specified peer switch in
cleartext:
switch(config)# fcsp dhchap password 0 mypassword 30:11:bb:cc:dd:33:11:22
The following example show how to remove a secret to be used with the specified peer switch by entering
the secret in cleartext, even though the configuration is stored in the configuration in encrypted form:
switch(config)# no fcsp dhchap password 0 mypassword 30:11:bb:cc:dd:33:11:22
Cisco MDS 9000 Family Command Reference
8-68
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcsp dhchap password
The following example shows how to configure symmetric secrets on a link between switch1 with
sWWN of 01:01:01:01:01:01:01:01 and switch2 with sWWN of 02:02:02:02:02:02:02:02. The FC-SP
DHCHAP secret is in cleartext format:
switch1(config)# fcsp dhchap password 0 very_secret 02:02:02:02:02:02:02:02
switch2(config)# fcsp dhchap password 0 very_secret 01:01:01:01:01:01:01:01
Related Commands
Command
Description
fcsp enable
Enables FC-SP.
fcsp dhchap
devicename
Configure FC-SP asymmetric secrets.
fcsp dhchap dhgroup
Configure FC-SP group priority list.
fcsp dhchap hash
Configure FC-SP hash priority list.
show fcsp
Displays configured FC-SP information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-69
Chapter 8
F Commands
fcsp enable
fcsp enable
To enable the Fibre Channel Security Protocol (FC-SP) in a switch, use the fcsp enable command in
configuration mode. Additional FC-SP commands are available when the FC-SP feature is enabled. To
disable FC-SP, use the no form of the command.
fcsp enable
no fcsp enable
Syntax Descriptionf
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
NX-OS 4.1(1b)
This command was deprecated.
Usage Guidelines
None.
Examples
The following example enables FC-SP:
switch# config terminal
switch(config)# fcsp enable
switch(config)#
Related Commands
Command
Description
show fcsp
Displays configured FC-SP information.
Cisco MDS 9000 Family Command Reference
8-70
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fcsp esp sa
fcsp esp sa
To configure the parameters for the Security Association (SA), use the fcsp esp sa command. To delete
the SA between the switches, use the no form of the command.
fcsp esp sa {spi-number}
no fcsp esp sa {spi-number}
Syntax Description
spi-number
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Configures the Security Protocol Interface (SPI) of the Security
Association. The range is from 256 to 4294967295.
Modification
NX-OS 5.2(1)
The spi-number range has been reduced from 256 4294967295 to 256 65536.
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to configure the command for ESP:
switch(config)# fcsp esp sa 257
This is a Early Field Trial (EFT) feature.
on environment. Continue Y/N ? [no] y
switch(config-sa)#
Related Commands
Please do not use this in a producti
Command
Description
fcsp enable
Enables FC-SP.
show fcsp interface
Displays FC-SP related information for a specific interface.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-71
Chapter 8
F Commands
fcsp timeout
fcsp timeout
To configure the timeout value for FC-SP message, use the fcsp timeout command in configuration
mode. Use the no form of the command to revert to factory defaults.
fcsp timeout timeout-period
no fcsp timeout timeout-period
Syntax Description
timeout-period
Defaults
30 seconds.
Command Modes
Configuration mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
Specifies the timeout period. The time ranges from 20 to 100 seconds. The
default is 30 seconds.
Usage Guidelines
You can only see the fcsp timeout command if you enter the fcsp enable command.
Examples
The following example configures the FCSP timeout value:
switch# config terminal
switch(config)# fcsp enable
switch(config)# fcsp timeout 60
Related Commands
Command
Description
fcsp enable
Enables FC-SP.
show fcsp
Displays configured FC-SP information.
Cisco MDS 9000 Family Command Reference
8-72
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fctimer
fctimer
To change the default Fibre Channel timers, use the fctimer command in configuration mode. To revert
to the default values, use the no form of the command.
fctimer {d_s_tov milliseconds [vsan vsan-id] | e_d_tov milliseconds [vsan vsan-id] | r_a_tov
milliseconds [vsan vsan-id]}
no fctimer {d_s_tov milliseconds [vsan vsan-id] | e_d_tov milliseconds [vsan vsan-id] | r_a_tov
milliseconds [vsan vsan-id]}
Syntax Description
d_s_tov milliseconds
Specifies the distributed services time out value. The range is 5000 to 10,000
milliseconds, with a default of 5000.
vsan vsan-id
(Optional) Specifies the VSAN ID. The range is 1 to 4096.
e_d_tov milliseconds
Specifies the error detect time out value. The range is 1000 to 4,000
milliseconds, with a default of 2000.
r_a_tov milliseconds
Specifies the resolution allocation time out value. The range is 5000 to
10,000 milliseconds, with a default of 10,000.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
The Cisco MDS 9000, Brocade, and McData FC Error Detect (ED_TOV) and Resource Allocation
(RA_TOV) timers default to the same values. They can be changed if needed. In accordance with the
FC-SW2 standard, these values must be the same on each switch within the fabric.
Use the vsan option to configure different TOV values for VSANs with special types of links such as FC
or IP tunnels.
Examples
The following example shows how to change the default Fibre Channel timers:
switch# config terminal
switch(config)# fctimer e_d_tov 3000
switch(config)# fctimer r_a_tov 7000
Related Commands
Command
Description
show fctimer
Displays the configured Fibre Channel timer values.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-73
Chapter 8
F Commands
fctimer abort
fctimer abort
To discard a Fibre Channel timer (fctimer) Cisco Fabric Services (CFS) distribution session in progress,
use the fctimer abort command in configuration mode.
fctimer abort
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to discard a CFS distribution session in progress:
switch# config terminal
switch(config)# fctimer abort
Related Commands
Command
Description
fctimer distribute
Enables CFS distribution for fctimer.
show fctimer
Displays fctimer information.
Cisco MDS 9000 Family Command Reference
8-74
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fctimer commit
fctimer commit
To apply the pending configuration pertaining to the Fibre Channel timer (fctimer) Cisco Fabric Services
(CFS) distribution session in progress in the fabric, use the fctimer commit command in configuration
mode.
fctimer commit
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
2.0(x)
This command was introduced.
Usage Guidelines
Note
Examples
None.
After the FC timer commit is completed the running configuration has been modified on all switches
participating in fctimer distribution. You can then use the copy running-config startup-config fabric
command to save the running configuration to the startup configuration on all the switches in the
fabric.
The following example shows how to commit changes to the active Fibre Channel timer configuration:
switch# config terminal
switch(config)# fctimer commit
Related Commands
Command
Description
fctimer distribute
Enables CFS distribution for fctimer.
show fctimer
Displays fctimer information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-75
Chapter 8
F Commands
fctimer distribute
fctimer distribute
To enable Cisco Fabric Services (CFS) distribution for Fibre Channel timer (fctimer), use the fctimer
distribute command. To disable this feature, use the no form of the command.
fctimer distribute
no fctimer distribute
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
Before distributing the Fibre Channel timer changes to the fabric, the temporary changes to the
configuration must be committed to the active configuration using the fctimer commit command.
Examples
The following example shows how to change the default Fibre Channel timers:
switch# config terminal
switch(config)# fctimer distribute
Related Commands
Command
Description
fctimer commit
Commits the Fibre Channel timer configuration changes to the active
configuration.
show fctimer
Displays fctimer information.
Cisco MDS 9000 Family Command Reference
8-76
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fctrace
fctrace
To trace the route to an N port, use the fctrace command in EXEC mode.
fctrace {device-alias aliasname | fcid fcid vsan vsan-id [timeout value] | pwwn pwwn-id [timeout
seconds]}
Syntax Description
device-alias aliasname
Specifies the device alias name. Maximum length is 64 characters.
fcid fcid
The FCID of the destination N port, with the format 0xhhhhhh
vsan vsan-id
Specifies a VSAN ID. The range is 1 to 4093.
timeout value
(Optional) Configures the timeout value. The range is 1 to 10.
pwwn pwwn-id
The PWWN of the destination N port, with the format
hh:hh:hh:hh:hh:hh:hh:hh.
Defaults
By default, the period to wait before timing out is 5 seconds.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
2.0(x)
Added the device-alias aliasname option.
Usage Guidelines
None.
Examples
The following example traces a route to the specified fcid in VSAN 1:
switch# fctrace fcid 0x660000 vsan 1
Route present for : 0x660000
20:00:00:05:30:00:5f:1e(0xfffc65)
Latency: 0 msec
20:00:00:05:30:00:61:5e(0xfffc66)
Latency: 0 msec
20:00:00:05:30:00:61:5e(0xfffc66)
The following example traces a route to the specified device alias in VSAN 1:
switch# fctrace device-alias x vsan 1
Route present for : 21:01:00:e0:8b:2e:80:93
20:00:00:05:30:00:4a:e2(0xfffc67)
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-77
Chapter 8
F Commands
fc-tunnel
fc-tunnel
To terminate a Fibre Channel tunnel in a destination switch, use the fc-tunnel command. To remove a
configuration or revert it to factory defaults, use the no form of the command.
fc-tunnel {enable | explicit-path name [next-address ip-address {loose | strict}] | tunnel-id-map
tunnel-id interface fc slot-number}
no fc-tunnel {enable | explicit-path name | tunnel-id-map tunnel-id}
Syntax Description
enable
Enables the FC tunnel feature.
explicit-path name
Specifies an explicit path. Maximum length is 16 characters.
next-address ip-address
(Optional) Specifies the IP address of the next hop switch.
loose
Specifies that a direct connection to the next hop is not required.
strict
Specifies that a direct connection to the next hop is required.
tunnel-id-map tunnel-id
Specifies FC tunnel ID to an outgoing interface. The range is 1 to 255.
interface fc slot/port
Configures the Fiber Channel interface in the destination switch.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
6.2(5)
All the fc-tunnel commands are not supported in Cisco MDS 9250i
Multiservice Fabric Switch.
6.2(1)
Added the output for remote span configuration on local and remote
switches.
1.2(1)
This command was introduced.
Usage Guidelines
All VSANs with RSPAN traffic must be enabled. If a VSAN containing RSPAN traffic is not enabled, it
will be dropped.
The FC tunnel can only be configured in the same subnet as the VSAN interface.
The Fibre Channel tunnel feature must be enabled (the interface fc-tunnel command) on each switch in
the end-to-end path of the Fibre Channel fabric in which RSPAN is to be implemented.
Note
Examples
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example enables the FC tunnel feature:
Cisco MDS 9000 Family Command Reference
8-78
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fc-tunnel
switch# config terminal
switchS(config)# fc-tunnel enable
The following example displays remote SPAN configuration on a local switch:
switch(config)#
switch(config)#
switch(config)#
switch(config)#
fc-tunnel enable
interface vsan 1
ip address 10.10.10.66 255.255.254.0
no shut
switch(config)#
switch(config)#
switch(config)#
switch(config)#
interface fc-tunnel 102
source 10.10.10.66
destination 10.10.10.77
no shut
The following example displays remote SPAN Configuration on a remote switch:
switch(config)#
switch(config)#
switch(config)#
switch(config)#
switch(config)#
switch(config)#
switch(config)#
fc-tunnel enable
interface vsan 1
ip address 10.10.10.77 255.255.254.0
no shut
interface fc1/16
switchport mode sd
fc-tunnel tunnel-id-map 102 interface fc1/16
The following example places you at the explicit path prompt for the path named Path and specifies that
the next hop VSAN interface IP addresses:
switch# config terminal
switchS(config)# fc-tunnel explicit-path Path1
switchS(config-explicit-path)# next-address 209.165.200.226
switchS(config-explicit-path)# next-address 209.165.200.227
switchS(config-explicit-path)# next-address 209.165.200.228
The following example places you at the explicit path prompt for the path named Path and configures a
minimum cost path in which this IP address exists:
switchS(config)# fc-tunnel explicit-path Path3
switchS(config-explicit-path)# next-address 209.165.200.226 loose
The following example configures the FC tunnel (100) in the destination switch (switch D):
switchD(config)# fc-tunnel tunnel-id-map 100 interface fc2/1
The following example creates two explicit paths and configures the next hop addresses for each path in
the source switch (switch S):
switchS# config t
switchS(config)# fc-tunnel explicit-path Path1
switchS(config-explicit-path)# next-address 209.165.200.226
switchS(config-explicit-path)# next-address 209.165.200.227
switchS(config-explicit-path)# next-address 209.165.200.228
switchS(config-explicit-path)# exit
switchS(config)# fc-tunnel explicit-path Path3
switchS(config-explicit-path)# next-address 209.165.200.226 loose
The following example references the configured path in the source switch (switch S):
switchS# config t
switchS(config)# interface fc-tunnel 100
switchS(config)# explicit-path Path1
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-79
Chapter 8
F Commands
feature
feature
To enable a feature or service on the switch, use the feature command. To disable a feature or service
on the switch, use the no form of the command.
feature {cimserver | cluster | crypto {ike | ipsec} dpvm | fport-channel-trunk | fabric-binding
| fcip | fcrxbbcredit {extended} fcsp | ficon |fport-channel-trunk | http-server | ioa | iscsi |
ivr | npiv| npv | port-security | privilege | port-track | san-ext-turner | scheduler | sdv | sme
| ssh | tacacs+ | telnet}
no feature {cimserver | cluster | crypto {ike | ipsec} dpvm | fport-channel-trunk| fabric-binding
| fcip | fcrxbbcredit {extended} fcsp | ficon | fport-channel-trunk | http-server | ioa | iscsi |
ivr | npiv | npv | port-security | privilege | port-track | san-ext-turner | scheduler | sdv | sme
| ssh | tacacs+ | telnet}
Syntax Description
cimserver
Enables or disables CIM server.
cluster
Enables or disables cluster.
crypto
Sets crypto settings.
ike
Enables or disables IKE.
ipsec
Enables or disables IPsec.
dpvm
Enables or disables the Dynamic Port VSAN Membership.
fport-channel-trunk
Enables or disables the F port channel trunking feature.
fabric-binding
Enables or disables fabric binding.
fcip
Enables or disables FCIP.
fcrxbbcredit
Enables or disables the extended rx b2b credit configuration.
extended
Sets extended settings.
fcsp
Enables or disables FCSP.
ficon
Enables or disables the FICON.
http-server
Enables or disables the HTTP server.
ioa
Enables or disables I/O Accelerator.
iscsi
Enables or disables ISCSI.
ivr
Enables or disables inter-VSAN routing.
npiv
Enables or disables the NX port ID virtualization.
npv
Enables or disables the Fibre Channel N port virtualizer.
port-security
Enables or disables the port security.
privilege
Enables or disables Cisco IOS type privilege level support.
port-track
Enables or disables the port track feature.
san-ext-turner
Enables or disables the SAN Extension Turner Tool.
scheduler
Enables or disables scheduler.
sdv
Enables or disables the SAN Device Virtualization.
sme
Enables or disables the Storage Media Encryption.
ssh
Enables or disables SSH.
Cisco MDS 9000 Family Command Reference
8-80
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
feature
tacacs+
Enables or disables TACACS+.
telnet
Enables or disables Telnet.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
NX-OS 5.0(1a)
Added keyword privilege to the syntax description.
NX-OS 4.2(1)
Added keyword ioa to the syntax description.
NX-OS 4.1(3)
Added features fport-channel-trunk, npiv and npv to the syntax
description.
NX-OS 4.1(1b)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable a feature on the switch:
switch(config)#
switch(config)#
switch(config)#
switch(config)#
switch(config)#
switch(config)#
switch(config)#
switch(config)#
switch(config)#
switch(config)#
switch(config)#
switch(config)#
Related Commands
feature
feature
feature
feature
feature
feature
feature
feature
feature
feature
feature
feature
privilege
fcip
cluster
ioa
fcsp
sdv
cimserver
scheduler
fport-channel-trunk
http-server
npv
npiv
Command
Description
show fcip
Displays FCIP information.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-81
Chapter 8
F Commands
ficon enable
ficon enable
To enable the FICON feature on a switch, use the ficon enable command in configuration mode. To
disable the feature or to revert to factory defaults, use the no form of the command.
ficon enable
no ficon enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
NX-OS 4.1(1b)
This command was deprecated.
Usage Guidelines
The effects of enabling the FICON feature in a Cisco MDS switch are as follows:
•
You cannot disable in-order delivery for the FICON-enabled VSAN.
•
You cannot disable fabric binding or static domain ID configurations for the FICON-enabled VSAN.
•
The load balancing scheme is changed to Source ID (SID)—Destination ID (DID). You cannot
change it back to SID—DID—OXID.
•
The IPL configuration file is automatically created.
When FICON is enabled on a VSAN, it is implicitly enabled everywhere. However, when FICON is
disabled on a VSAN, it remains globally enabled. You must explicitly disable FICON to disable it
throughout the fabric.
Note
Examples
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example enables FICON on the switch:
switch(config)# ficon enable
The following example disables FICON on the switch:
switch(config)# no ficon enable
Cisco MDS 9000 Family Command Reference
8-82
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
ficon enable
Related Commands
Command
Description
show ficon
Displays configured FICON details.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-83
Chapter 8
F Commands
ficon logical-port assign port-numbers
ficon logical-port assign port-numbers
To reserve FICON port numbers for logical interfaces on the switch, use the ficon logical-port assign
port-numbers command in configuration mode. To release the port numbers, use the no form of the
command.
ficon logical-port assign port-numbers [port-numbers]
no ficon logical-port assign port-numbers [port-numbers]
Syntax Description
port-numbers
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
(Optional) Specifies the range of port numbers to assign. The range can be
0 through 153 or 0x0 through 0x99.
You must reserve port numbers for logical interfaces, such as FCIP and PortChannels, if you plan to use
them.
You cannot change or release port numbers for interfaces that are active. You must disable the interfaces
using the shutdown command.
Note
Examples
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example reserves port numbers 230 through 249 for FCIP and PortChannel interfaces:
switch(config)# ficon logical-port assign port-numbers 230-249
The following example reserves port numbers 0xe6 through 0xf9 for FCIP and PortChannel interfaces:
switch(config)# ficon logical-port assign port-numbers 0xe6-0xf9
The following example releases the port numbers:
switch(config)# no ficon logical-port assign port-numbers 230-249
Related Commands
Command
Description
show ficon
Displays configured FICON details.
Cisco MDS 9000 Family Command Reference
8-84
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
ficon port default-state prohibit-all
ficon port default-state prohibit-all
To set the FICON port default state to prohibit all, use the ficon port default-state prohibit-all
command in configuration mode. To disable the feature or to revert to factory defaults, use the no form
of the command.
ficon port default-state prohibit-all
no ficon port default-state prohibit-all
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Release
Modification
3.0(2)
This command was introduced.
Usage Guidelines
Note
Examples
You can change the default port prohibiting state to enabled in VSANs that you create and then
selectively disable port prohibiting on implemented ports, if desired. Only the FICON configuration files
created after you change the default have the new default setting.
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example enables port prohibiting as the default for all implemented interfaces on the
switch:
switch(config)# ficon port default-state prohibit-all
The following example disables port prohibiting as the default for all implemented interfaces on the
switch:
switch(config)# no port default-state prohibit-all
Related Commands
Command
Description
show ficon port
default-state
Displays default FICON port prohibit state.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-85
Chapter 8
F Commands
ficon slot assign port-numbers
ficon slot assign port-numbers
To reserve FICON port numbers for a slot on the switch, use the ficon slot assign port-numbers
command in configuration mode. To release the port numbers, use the no form of the command.
ficon slot slot assign port-numbers [port-numbers]
no ficon slot slot assign port-numbers [port-numbers]
Syntax Description
slot
Specifies the slot number, 1 through 6.
port-numbers
Specifies the range of port numbers to assign. The range can be 0 through
153, or 0x0 through 0x99. For 9513, the port numbers can be between 0
through 249, or 0x0 through 0xf9.
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
A range of 255 port numbers are available for you to assign to all the ports on a switch. You can have
more than 255 physical ports on a switch and the excess ports do not have ports numbers in the default
numbering scheme. When you have more than 255 physical ports on your switch, you can assign
unimplemented port numbers to the ports, or assign duplicate port numbers if they are not used in the
same FICON VSAN. For example, you can configure port number 1 on interface fc1/1 in FICON VSAN
10 and fc10/1 in FICON VSAN 20.
FICON port numbers are not changed for ports that are active. You must first disable the interfaces using
the shutdown command.
You can configure port numbers even when no module is installed in the slot, and before FICON is
enabled on any VSAN.
Note
Examples
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example reserves FICON port numbers 0 through 15 and 48 through 63 for up to 32
interfaces in slot 3:
swich# config terminal
Enter configuration commands, one per line. End with CNTL/Z.
switch(config)# ficon slot 3 assign port-numbers 0-15, 48-63
Cisco MDS 9000 Family Command Reference
8-86
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
ficon slot assign port-numbers
The following example reserves FICON port numbers 0 through 15 for the first 16 interfaces and 0
through 15 for the second 32 interfaces in slot 3:
switch(config)# ficon slot 3 assign port-numbers 0-15, 0-15
The following example changes the reserved FICON port numbers for up to 24 interfaces in slot 3:
switch(config)# ficon slot 3 assign port-numbers 0-15, 56-63
The following example releases the port numbers:
switch(config)# no ficon slot 3 assign port-numbers 0-15, 56-63
The following example shows the switch output when there are duplicate port numbers:
switch(config)
switch(config)# no ficon slot 1 assign port-numbers
switch(config)# ficon slot 1 assign port-numbers 0-14, 0
WARNING: fc1/16 and fc1/1 have duplicated port-number 0 in port VSAN 99
Related Commands
Command
Description
show ficon
Displays configured FICON details.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-87
Chapter 8
F Commands
ficon swap
ficon swap
To enable the FICON feature in a specified VSAN, use the ficon swap command in configuration mode.
ficon swap {interface fc slot fc slot | portnumber port-number port-number} [after swap noshut]
Syntax Description
interface
Configures the interfaces to be swapped.
fc
Specifies the Fibre Channel interface.
slot
Specifies the slot number, 1 through 6.
portnumber
Configures the FICON port number for this interface.
port-number
Specifies the port numbers that must be swapped
after swap noshut
(Optional) Initializes the port shut down after the ports are swapped.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
3.0(1)
Added the interface option.
Usage Guidelines
The ficon swap portnumber old-port-number new port-number command causes all configuration
associated with old-port-number and new port-number to be swapped, including VSAN configurations.
This command is only associated with the two ports in concerned. You must enter this
VSAN-independent command from the EXEC mode.
If you specify the ficon swap portnumber after swap noshut command, the ports are automatically
initialized.
The ficon swap interface old-interface new-interface command allows you to swap physical Fibre
Channel ports, including port numbers, when there are duplicate port numbers on the switch.
If you specify the ficon swap interface old-interface new-interface after swap noshut command, the
ports are automatically initialized.
Note
Examples
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example swaps the contents of ports 3 with port 15, shuts them down, and automatically
initializes both ports:
switch# ficon swap portnumber 3 15 after swap noshut
Cisco MDS 9000 Family Command Reference
8-88
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
ficon swap
The following example swaps the contents of ports 3 with port 15 and shuts them down:
switch# ficon swap portnumber 3 15
The following example swaps port 1 with port 6:
switch# ficon swap interface fc1/1 fc1/6
Related Commands
Command
Description
show ficon
Displays configured FICON details.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-89
Chapter 8
F Commands
ficon-tape-read-accelerator
ficon-tape-read-accelerator
To enable FICON tape read acceleration for the FCIP interface, use the ficon-tape-read-accelerator
command in interface configuration submode. To disable FICON tape read acceleration for the FCIP
interface, use the no form of the command.
ficon-tape-read-accelerator
no ficon-tape-read-accelerator
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Interface configuration submode.
Command History
Release
Modification
NX-OS 5.0(1a)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to enable FICON tape read acceleration on the FCIP interface:
switch# config terminal
switch(config)# interface fcip 2
switch(config-if)# ficon-tape-read-accelerator
switch(config-if)#
The following example shows how to disable FICON tape read acceleration on the FCIP interface:
switch# config terminal
switch(config)# interface fcip 2
switch(config-if)# no ficon-tape-read-accelerator
switch(config-if)#
Related Commands
Command
Description
show fcip
Displays FCIP profile information.
Cisco MDS 9000 Family Command Reference
8-90
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
ficon-tape-accelerator vsan
ficon-tape-accelerator vsan
To enable FICON tape acceleration for the FCIP interface, use the ficon-tape-accelerator vsan
command in interface configuration submode. To disable FICON tape acceleration for the FCIP
interface, use the no form of the command.
ficon-tape-accelerator vsan vsan-id
no ficon-tape-accelerator vsan vsan-id
Syntax Description
vsan-id
Defaults
Disabled.
Command Modes
Interface configuration submode.
Command History
Release
Modification
3.0(1)
This command was introduced.
Usage Guidelines
Specifies the VSAN ID. The range is 1 to 4093.
Cisco MDS NX-OS software provides acceleration for FICON tape write operations over FCIP for the
IBM VTS and tape libraries that support the 3490 command set. FICON tape read acceleration over FCIP
is not supported.
FICON tape acceleration will not work if multiple inter-switch links (ISLs) are present in the VSAN.
FICON write acceleration and tape acceleration can be enabled at the same time on the FCIP interface.
Note
Examples
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example enables FICON tape acceleration on the FCIP interface:
switch# config terminal
switch(config)# interface fcip 2
switch(config-if)# ficon-tape-accelerator vsan 100
This configuration change will disrupt all traffic on the FCIP interface in all
VSANs. Do you wish to continue? [no] y
The following example disables FICON tape acceleration on the FCIP interface:
switch(config-if)# no ficon-tape-accelerator vsan 100
This configuration change will disrupt all traffic on the FCIP interface in all
VSANs. Do you wish to continue? [no] y
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-91
Chapter 8
F Commands
ficon-tape-accelerator vsan
Related Commands
Command
Description
show fcip
Displays FCIP profile information.
write-accelerator
Enables write acceleration and tape acceleration for the FCIP interface.
Cisco MDS 9000 Family Command Reference
8-92
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
ficon vsan (EXEC mode)
ficon vsan (EXEC mode)
To configure FICON related parameters in EXEC mode, use the ficon vsan command. To remove the
configuration or revert to the default values, use the no form of the command.
ficon vsan vsan-id | apply file file-name | copy file old-file-name new-file-name | offline | online}
None.
vsan-id
The FICON configuration mode for the specified VSAN (from 1 to 4096).
apply file file-name
Specifies the existing FICON configuration file-name after switch
initialization. Maximum length is 80 characters.
copy file
Copies of the specified FICON configuration file.
old-file-name
Specifies the old (existing) FICON configuration file name.
new-file-name
Specifies the new name for the copied file.
offline
Logs out all ports in the VSAN that needs to be suspended.
online
Removes the offline condition to allow ports to log on again.
Command Modes
EXEC mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
When an MDS switch is booting up with saved configuration, if FICON is enabled on a VSAN, the IPL
configuration file is applied automatically by the NX-OS software after the switch initialization is
completed.
Use the ficon vsan vsan-id copy file exiting-file-name save-as-file-name command to copy an existing
FICON configuration file. You can see the list of existing configuration files by issuing the show ficon
vsan vsan-id command.
Note
Examples
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example applies the configuration from the saved files to the running configuration:
switch# ficon vsan 2 apply file SampleFile
The following example copies an existing FICON configuration file called IPL and renames it to IPL3.
switch# ficon vsan 20 copy file IPL IPL3
Related Commands
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-93
Chapter 8
F Commands
ficon vsan (EXEC mode)
Command
Description
show ficon
Displays configured FICON details.
Cisco MDS 9000 Family Command Reference
8-94
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
ficon vsan (configuration mode)
ficon vsan (configuration mode)
To enable the FICON feature in a specified VSAN, use the ficon vsan command in configuration mode.
To disable the feature or to revert to factory defaults, use the no form of the command.
ficon vsan vsan-id
no ficon vsan vsan-id
Syntax Description
vsan vsan-id
Defaults
None.
Command Modes
Configuration mode.
Command History
Release
Modification
1.3(1)
This command was introduced.
Usage Guidelines
Enters the FICON configuration mode for the specified VSAN (from 1 to 4096).
An IPL configuration file is automatically created:
Once you enable FICON, you cannot disable in-order delivery, fabric binding, or static domain ID
configurations.
When you disable FICON, the FICON configuration file is also deleted.
Note
Examples
This command is not supported on the Cisco MDS 9124 switch, the Cisco Fabric Switch for HP c-Class
BladeSystem, and the Cisco Fabric Switch for IBM BladeCenter.
The following example enables FICON on VSAN 2:
switch(config)# ficon vsan 2
The following example disables FICON on VSAN 6:
switch(config)# no ficon vsan 6
Related Commands
Command
Description
show ficon
Displays configured FICON details.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-95
Chapter 8
F Commands
file
file
To access FICON configuration files in a specified VSAN, use the file command. To disable the feature
or to revert to factory defaults, use the no form of the command.
file file-name
no file file-name
Syntax Description
file-name
Defaults
None.
Command Modes
FICON configuration submode.
Command History
Release
Modification
1.3(1)
This command was introduced.
The FICON configuration file in the specified VSAN
Usage Guidelines
The configuration file submode allows you to create and edit FICON configuration files. If a specified
file does not exist, it is created. Up to 16 files can be saved. Each file name is restricted to 8 alphanumeric
characters.
Examples
The following example accesses the FICON configuration file called IplFile1 for VSAN 2. If this file
does not exist, it is created:
switch# config terminal
switch(config)# ficon vsan 2
switch(config-ficon)# file IplFile1
switch(config-ficon-file)#
The following example deletes a previously created FICON configuration file:
switch(config-ficon)# no file IplFileA
Related Commands
Command
Description
ficon vsan
Enables FICON for a VSAN.
show ficon
Displays configured FICON details.
Cisco MDS 9000 Family Command Reference
8-96
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
find
find
To display a list of files on a file system, use the find command in EXEC mode.
find filename
Syntax Description
filename
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Specifies a search string to match to the files in the default directory.
Maximum length is 64 characters.
Usage Guidelines
Use the find (Flash file system) command to display more details about the files in a particular file
system.
Examples
The following example is sample output of all files that begin with the letter a:
switch# find a
./accountingd
./acl
./ascii_cfg_server
./arping
Related Commands
Command
Description
cd
Changes the default directory or file system.
dir
Displays all files in a given file system.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-97
Chapter 8
F Commands
flex-attach virtual-pwwn
flex-attach virtual-pwwn
To map the real port WWN (pWWN) and a user-specific virtual pWWN, use the flex-attach
virtual-pwwn command. To disable the mapping, use the no form of the command.
flex-attach virtual-pwwn vpwwn pwwn pwwn
no flex-attach virtual-pwwn vpwwn pwwn pwwn
Syntax Description
vpwwn
Specifies the virtual pWWN chosen by the user.
pwwn pwwn
Specifies the pWWN to be mapped to the user-specific virtual pWWN.
Note
pWWN must not be logged in.
Defaults
None.
Command Modes
Configuration mode
Command History
Release
Modification
3.3(1a)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to map the real pWWN and a user-specific virtual pWWN on an
interface:
switch# config
Enter configuration commands, one per line. End with CNTL/Z.
switch# (config) flex-attach virtual-pwwn 20:04:00:a0:b8:16:92:18 pwwn
21:03:00:a0:b9:16:92:16
Related Commands
Command
Description
flex-attach
virtual-pwwn auto
Enables the FlexAttach virtual pWWN on a specific interface.
flex-attach
virtual-pwwn
interface
Sets the user-specific FlexAttach virtual pWWN.
Cisco MDS 9000 Family Command Reference
8-98
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
flex-attach virtual-pwwn auto
flex-attach virtual-pwwn auto
To enable the FlexAttach virtual port WWN (pWWN) on a specific interface, use the flex-attach
virtual-pwwn auto command. To disable the virtual pWWN, use the no form of the command.
flex-attach virtual-pwwn auto [interface auto interface-list]
no flex-attach virtual-pwwn auto [interface auto interface-list]
Syntax Description
interface auto
interface-list
Specifies the interface list on which FlexAttach virtual pWWN should be
enabled.
Note
All interfaces in the interface-list value must be in the shut mode. If
the interface-list value is not provided, then all ports must be in the
shut mode.
Defaults
None.
Command Modes
Configuration mode
Command History
Release
Modification
3.3(1a)
This command was introduced.
Usage Guidelines
The NPV switch assigns the virtual pWWNs to the interface on which FlexAttach is enabled.
Examples
The following example shows how to enable FlexAttach virtual pWWN on a interface:
switch# config
Enter configuration commands, one per line. End with CNTL/Z.
switch#(config)# flex-attach virtual-pwwn auto interface fc 1/1
Related Commands
Command
Description
flex-attach
virtual-pwwn
interface
Sets the user-specific FlexAttach virtual pWWN.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-99
Chapter 8
F Commands
flex-attach virtual-pwwn interface
flex-attach virtual-pwwn interface
To set the user-specific FlexAttach virtual port WWN (pWWN) on an interface, use the flex-attach
virtual-pwwn interface command. To disable the virtual pWWN, use the no form of the command.
flex-attach virtual-pwwn vpwwn interface interface [vsan vsan]
no flex-attach virtual-pwwn vpwwn interface interface [vsan vsan]
Syntax Description
vpwwn
Specifies the virtual pWWN chosen by the user.
interface
Specifies the interface on which the FlexAttach virtual port has to be
enabled.
Note
vsan vsan
The interface must be in the shut state.
(Optional) Specifies the VSAN on which FlexAttach should be enabled.
Defaults
None.
Command Modes
Configuration mode
Command History
Release
Modification
3.3(1a)
This command was introduced.
Usage Guidelines
None.
Examples
The following example shows how to set the user-specific virtual pWWN on an interface:
switch# config
Enter configuration commands, one per line.
Related Commandss
End with CNTL/Z.
Command
Description
flex-attach
virtual-pwwn auto
Enables the FlexAttach virtual pWWN on a specific interface.
Cisco MDS 9000 Family Command Reference
8-100
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
flowgroup
flowgroup
To configure an IOA flow group, use the flowgroup command.
flowgroup {name}
no flowgroup {name}
Syntax Description
name
Defaults
None.
Command Modes
Configuration submode.
Command History
Release
Modification
NX-OS 4.2(1)
This command was introduced.
Usage Guidelines
Examples
Specifies an IOA flow group name. The maximum size is 31 characters.
None.
The following example shows how to configure the IOA flow group:
switch# conf t
Enter configuration commands, one per line.
switch(config)# ioa cluster tape_vault
switch(config-ioa-cl)# flowgroup tsm
switch(config-ioa-cl)#
Related Commands
End with CNTL/Z.
Command
Description
interface ioa
Configures the IOA interface.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-101
Chapter 8
F Commands
format
format
To erase all the information on a module, use the format command in EXEC mode.
format {bootflash: | logflash: | slot0: | usb1: | usb2:}
Syntax Description
bootflash:
Specifies bootflash: memory.
logflash:
Specifies logflash: memory.
slot0:
Specifies the flash device in slot 0.
usb1:
Specifies the USB memory in host1.
usb2:
Specifies the USB memory in host 2.
Defaults
None.
Command Modes
EXEC mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
3.3(1a)
Added the USB1 and USB 2 parameters.
Usage Guidelines
The SAN-OS and NX-OS software supports Cisco-certified CompactFlash devices that are formatted
using Cisco MDS 9000 switches. Using uncertified CompactFlash devices may result in unpredictable
consequences; formatting CompactFlash devices using other platforms may result in errors.
Examples
The following example erases all information on the bootflash memory.
switch# format bootflash:
This command is going to erase the contents of your bootflash:.
Do you want to continue? (y/n) [n]
The following example erases all information on the logflash memory.
switch# format logflash:
This command is going to erase the contents of your logflash:.
Do you want to continue? (y/n) [n]
The following example erases all information on slot0.
switch# format slot0:
This command is going to erase the contents of your slot0:
Do you want to continue? (y/n) [n]
The following example erases all information on usb1:
switch# format usb1:
This command is going to erase the contents of your usb1:.
Do you want to continue? (y/n) [n]
Cisco MDS 9000 Family Command Reference
8-102
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
format
The following example erases all information on usb2:.
switch# format usb2:
This command is going to erase the contents of your usb2:.
Do you want to continue? (y/n) [n]
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-103
Chapter 8
F Commands
fspf config vsan
fspf config vsan
To configure an FSPF feature for the entire VSAN, use the fspf config vsan command in configuration
mode. To delete FSPF configuration for the entire VSAN, use the no form of the command.
fspf config vsan vsan-id min-ls-arrival ls-arrival-time min-ls-interval ls-interval-time region
region-id spf {hold-time spf-holdtime | static}
no fspf config vsan vsan-id min-ls-arrival min-ls-interval region spf {hold-time | static}
Syntax Description
vsan-id
Specifies a VSAN ID. The range is 1 to 4093.
min-ls-arrival ls-arrival-time Specifies the minimum time before a new link state update for a
domain will be accepted by switch. The parameter ls-arrival-time is an
integer specifying time in milliseconds. The range is 0 to 65535.
Defaults
min-ls-interval
ls-interval-time
Specifies the minimum time before a new link state update for a
domain will be generated by the switch. The parameter ls-interval-time
is an integer specifying time in milliseconds. The range is 0 to 65535.
region region-id
Specifies the autonomous region to which the switch belongs. The
backbone region has region-id=0. The parameter region-id is an
unsigned integer value ranging from 0 to 255.
spf
Specifies parameters related to SPF route computation.
hold-time spf-holdtime
Specifies the time between two consecutive SPF computations. If the
time is small then routing will react faster to changes but CPU usage
will be more. The parameter spf-holdtime is an integer specifying time
in milliseconds. The range is 0 to 65535.
static
Forces static SPF computation.
In the FSPF configuration mode, the default is dynamic.
If configuring spf hold-time, the default value for FSPF is 0.
If configuring min-ls-arrival, the default value for FSPF is 1000 msecs.
If configuring min-ls-interval, the default value for FSPF is 5000 msecs.
Command Modes
Configuration mode.
Command History
Release
Modification
1.0(2)
This command was introduced.
Usage Guidelines
This command configures FSPF on VSANs globally.
For the commands entered in FSPF configuration mode, you do not have to specify the VSAN number
every time. This prevents configuration errors that might result from specifying the wrong VSAN
number for these commands.
Cisco MDS 9000 Family Command Reference
8-104
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fspf config vsan
Examples
The following example configures FSPF globally in VSAN 1, deletes the FSPF configured in VSAN 3,
disables FSPF in VSAN 5, and enables FSPF in VSAN 7:
switch## config terminal
switch(config)# #
switch(config)# fspf config vsan 1
switch-config-(fspf-config)# spf static
switch-config-(fspf-config)# exit
switch(config)#
switch(config)# no fspf config vsan 3
switch(config)#
Related Commands
Command
Description
fspf cost
Configures the cost for the selected interface in the specified VSAN (from the
switch(config-if)# prompt).
fspf enable
Enables FSPF routing protocol in the specified VSAN (from the
switch(config-if)# prompt).
fspf hello-interval
Specifies the hello message interval to verify the health of a link in the VSAN
(from the switch(config-if)# prompt).
fspf passive
Disables the FSPF protocol for the specified interface in the specified VSAN
(from the switch(config-if)# prompt).
fspf retrasmit
Specifies the retransmit time interval for unacknowledged link state updates in
specified VSAN (from the switch(config-if)# prompt).
show fspf interface
Displays information for each selected interface.
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-105
Chapter 8
F Commands
fspf cost
fspf cost
To configure FSPF link cost for a Fibre Channel interface, use the fspf cost command. To revert to the
default value, use the no form of the command.
fspf cost link-cost vsan vsan-id
no fspf cost link-cost vsan vsan-id
Syntax Description
Defaults
link-cost
Enters FSPF link cost. The range is 1 to 30000.
vsan vsan-id
Specifies a VSAN ID. The range is 1 to 4093.
1000 for 1 Gbps
500 for 2 Gbps
250 for 4 Gbps
125 for 8 Gbps
100 for 10 Gbps
62 for 16 Gbps
Command Modes
Interface configuration submode.
Command History
Release
Modification
1.1(1)
This command was introduced.
Usage Guidelines
Access this command from the switch(config-if)# submode.
FSPF tracks the state of links on all switches in the fabric, associates a cost with each link in its database,
and then chooses the path with a minimal cost. The cost associated with an interface can be changed
using the fspf cost command to implement the FSPF route selection.
Examples
The following example configures the FSPF link cost on a Fibre Channel interface:
switch# config terminal
switch(config)# interface fcip 1
switch(config-if)# fspf cost 5000 vsan 1
Related Commands
Command
Description
show fspf interface
Displays information for each selected interface.
show interface fcip
Displays an interface configuration for a specified FCIP interface.
Cisco MDS 9000 Family Command Reference
8-106
OL-29295-04, Cisco MDS NX-OS Release 6.x
Chapter 8
F Commands
fspf cost
Cisco MDS 9000 Family Command Reference
OL-29295-04, Cisco MDS NX-OS Release 6.x
8-107
Chapter 8
F Commands
fspf dead-interval
fspf dead-interval
To set the maximum interval for which a hello message must be received before the neighbor is
considered lost, use the fspf dead-interval command. To revert to the default value, use the no form of
the command.
fspf dead-interval seconds vsan vsan-id
no fspf dead-interval seconds