-
Cisco MDS 9000 Family Command Reference, Release 3.x
-
New and Changed Information
-
Preface
-
CLI Overview
-
A Commands
-
Advanced Services Modules Commands
-
B Commands
-
C Commands
-
Caching Services Module Commands
-
D Commands
-
Debug Commands
-
E Commands
-
F Commands
-
G Commands
-
H Commands
-
I Commands
-
J Commands
-
K Commands
-
L Commands
-
M Commands
-
N Commands
-
O Commands
-
P Commands
-
Q Commands
-
R Commands
-
S Commands
-
Show Commands
-
T Commands
-
U Commands
-
V Commands
-
W Commands
-
Z Commands
-
Feedback
Table Of Contents
server (tacacs+ configuration)
set (IPsec crypto map configuration submode)
shutdown (interface configuration submode)
shutdown (Cisco SME cluster configuration submode)
snmp-server enable traps fcdomain
snmp-server enable traps link cisco
static (iSCSI initiator configuration and iSLB initiator configuration)
system default zone default-zone permit
system default zone distribute full
system default zone mode enhanced
system health (Configuration mode)
system health external-loopback
system health internal-loopback
system switchover (configuration mode)
S 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. For more information, refer to the Cisco MDS 9000 Family CLI Configuration Guide.
san-ext-tuner enable
To enable the IP Network Simulator to simulate a variety of data network conditions, use the san-ext-tuner enable command.
san-ext-tuner enable
Syntax Description
This command has no arguments or keywords.
Command Default
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
The IP Network Simulator tool is used for network simulation and is supported on the 8-port IP Storage Services (IPS-8) module and 4-port IP Storage Services (IPS-4) module only. You must also have either the SAN extension over IP package for IPS-8 modules (SAN_EXTN_OVER_IP) or SAN extension over IP package for IPS-4 modules (SAN_EXTN_OVER_IP_IPS4), so that you can enable the SAN Extension Tuner, a prerequisite for enabling and using the network simulator.
You must have a pair of Gigabit Ethernet ports dedicated for each Ethernet path requiring simulation; these ports cannot provide FCIP or iSCSI functionality while simulation occurs. The remaining ports that are not performing network simulations can run FCIP or iSCSI. Ports dedicated to network simulation must be adjacent, and always begin with an odd-numbered port. For example, GE 1/1 and GE 1/2 would be a valid pair, while GE 2/2 and GE 2/3 would not.
Note
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 the SAN Extension Tuner and enable a pair of ports for network simulation.
switch# config tswitch(config)#switch(config)# san-ext-tuner enableswitch(config)# exitswitch#switch# ips netsim enable interface gigabitethernet 2/3 gigabitethernet 2/4Related Commands
santap module
To configure the mapping between the Storage Services Module (SSM) and the VSAN where the appliance is configured, use the santap module command in configuration mode. To disable this feature, use the no form of the command.
santap module slot-number {appl-vsan vsan-id [cvt-name cvt-name] |
dvt target-pwwn target-pwwn target-vsan target-vsan-id dvt-name dvt-name dvt-vsan dvt-vsan-id [dvt-port port-number] [lun-size-handling enable/disable] [io-timeout timeout-value]}no santap module slot-number {appl-vsan vsan-id [cvt-name cvt-name] |
dvt target-pwwn target-pwwn}Syntax Description
Defaults
Disabled.
The IO-timeout is 10 seconds.
Lun-size-handling is Enabled.
Command Modes
Configuration mode.
Command History
2.1(1a)
This command was introduced.
3.0(1)
Added the following options: cvt-name, dvt, target-pwwn, target-vsan, dvt-name, dvt-vsan, dvt-port, lun-size-handling, and io-timeout.
Usage Guidelines
To access this command, you must first enable the SANTap feature on the SSM using the ssm enable feature command.
When the lun-size-handling option is set (enabled), the maximum logical block addressing (LBA) for DVT LUN is set to 2 TB. As a result, there is no issue with LUN resizing.
Note
Examples
The following example shows the configuration of the SSM where the SANTap feature is enabled and the VSAN used to communicate with the appliance.
switch# config terminalEnter configuration commands, one per line. End with CNTL/Z.switch(config)# santap module 1 appl-vsan 1Related Commands
ssm enable feature
Enables the SANTap feature on the SSM.
show santap module
Displays the configuration and statistics of the SANTap feature.
scheduler aaa-authentication
To use the command scheduler feature, a remote user must use the scheduler aaa-authentication command to specify an AAA authentication password.
scheduler aaa-authentication [username username] password [0 | 7] password
Syntax Description
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
This command is for remote users who need to use the scheduler feature.
Examples
The following example specifies a remote user's password.
switch# config tswitch(config)# scheduler aaa-authentication password newpwdThe following example specifies a remote user's password in clear text.
switch# config tswitch(config)# scheduler aaa-authentication password 0 newpwdThe following example specifies a remote user's encrypted password.
switch# config tswitch(config)# scheduler aaa-authentication password 7 newpwd2The following example specifies a remote user's name and AAA authentication password.
switch# config tsswitch(config)# scheduler aaa-authentication username admin1 password newpwd3Related Commands
scsi-flow distribute
To enable SCSI flow distribution through CFS, use the scsi-flow distribute command. To disable the SCSI flow distribution, use the no form of the command.
scsi-flow distribute
no scsi-flow distribute
Syntax Description
This command has no arguments or keywords.
Defaults
SCSI flow distribution is enabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
You must enable the SCSI flow feature on the Storage Services Module (SSM) before you can configure a SCSI flow. Use the ssm enable feature module slot-number command to enable the SCSI flow feature on the SSM.
Examples
The following example enables distribution of SCSI flow services using CFS.
switch# config terminalEnter configuration commands, one per line. End with CNTL/Z.switch(config)# scsi-flow distributeThe following example disables distribution of SCSI flow services.
switch(config)# no scsi-flow distributeRelated Commands
ssm enable feature
Enables the SCSI flow feature on the SSM.
show santap module
Displays SCSI flow configuration and status.
scsi-flow flow-id
To configure SCSI flow services, use the scsi-flow flow-id command. To disable the SCSI flow services, use the no form of the command.
scsi-flow flow-id flow-id {initiator-vsan vsan-id initiator-pwwn wwn target-vsan vsan-id target-pwwn wwn |
statistics |
write-acceleration [buffers count]}no scsi-flow flow-id flow-id [statistics | write-acceleration]
Syntax Description
Defaults
SCSI flow services are disabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
You must enable the SCSI flow feature on the Storage Services Module (SSM) before you can configure a SCSI flow. Use the ssm enable feature module slot-number command to enable the SCSI flow feature on the SSM.
Examples
The following example configures a SCSI flow with a flow identifier of 4 and the following attributes:
•
•
•
•
switch# config terminalswitch(config)# scsi-flow flow-id 4 initiator-vsan 101 initiator-pwwn 21:00:00:e0:8b:05:76:28 target-vsan 101 target-pwwn 21:00:00:20:37:38:67:cfThe following example disables a SCSI flow with a flow identifier of 4.
switch(config)# no scsi-flow flow-id 4The following example configures SCSI flow 4 to gather statistics about the SCSI flow.
switch(conf)# scsi-flow flow-id 4 statisticsThe following example disables the statistics gathering feature on SCSI flow 4.
switch(conf)# no scsi-flow flow-id 4 statisticsThe following example configures SCSI flow 4 with write acceleration.
switch(conf)# scsi-flow flow-id 4 write-accelerationThe following example configures SCSI flow 4 with write acceleration and buffers of 1024 credits.
switch(conf)# scsi-flow flow-id 4 write-acceleration buffer 1024The following example disables the write acceleration feature on SCSI flow 4.
switch(conf)# no scsi-flow flow-id 4 write-accelerationRelated Commands
ssm enable feature
Enables the SCSI flow feature on the SSM.
show scsi-flow
Displays SCSI flow configuration and status.
scsi-target
To configure SCSI target discovery, use the scsi-target command in configuration mode. To remove SCSI target discovery, use the no form of the command.
scsi-target {auto-poll [vsan vsan-id] | discovery | ns-poll [vsan vsan-id] | on-demand [vsan vsan-id]}
no scsi-target {auto-poll [vsan vsan-id] | discovery | ns-poll [vsan vsan-id] | on-demand [vsan vsan-id]}
Syntax Description
Defaults
SCSI target discovery for each option is on.
Command Modes
Configuration mode.
Command History
Usage Guidelines
Automatic global SCSI target discovery is on by default. Discovery can also be triggered for specific VSANs using on-demand, name server polling, or auto-polling options. All options are on by default. Use the no scsi-target discovery command to turn off all discovery options. You can also turn off specific options by using the no form of the command.
Examples
The following example configures SCSI target auto-polling discovery for VSAN 1.
switch# config tswitch(config)# scsi-target auto-poll vsan 1The following example removes SCSI target auto-polling discovery for VSAN 1.
switch# config tswitch(config)# no scsi-target auto-poll vsan 1The following example configures a SCSI target discovery.
switch# config tswitch(config)# scsi-target discoveryThe following example removes a SCSI target discovery.
switch# config tswitch(config)# no scsi-target discoveryThe following example configures SCSI target ns-polling discovery for VSAN 1.
switch# config tswitch(config)# scsi-target ns-poll vsan 1The following example removes SCSI target ns-polling discovery for VSAN 1.
switch# config tswitch(config)# no scsi-target ns-poll vsan 1The following example configures SCSI target on-demand discovery for VSAN 1.
switch# config tswitch(config)# scsi-target on-demand vsan 1The following example removes SCSI target on-demand discovery for VSAN 1.
switch# config tswitch(config)# no scsi-target on-demand vsan 1Related Commands
sdv abort vsan
To terminate an SDV configuration for a specified VSAN, use the sdv abort vsan command in configuration mode.
sdv abort vsan vsan-id
Syntax Description
abort
Terminates the SDV configuration.
vsan vsan-id
Specifies the number of the VSAN. The range is 1 to 4093.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
To use this command, you must enable SDV using the sdv enable command.
Examples
The following example shows how to terminate an SDV configuration for a specified VSAN.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# sdv abort vsan 2Related Commands
sdv commit vsan
To commit an SDV configuration to a specified VSAN, use the sdv commit vsan command in configuration mode. To remove the SDV configuration for a specified VSAN, use the no form of the command.
sdv commit vsan vsan-id
no sdv commit vsan vsan-id
Syntax Description
commit
Commits the SDV configuration.
vsan vsan-id
Specifies the number of the VSAN. The range is 1 to 4093.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
To use this command, you must enable SDV using the sdv enable command.
Examples
The following example shows how to commit an SDV configuration to a specified VSAN.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# sdv commit vsan 2The following example shows how to uncommit an SDV configuration from a specified VSAN.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# no sdv commit vsan 2Related Commands
sdv enable
To enable SDV on the switch, use the sdv enable command in configuration mode. To disable SDV, use the no form of the command.
sdv enable
no sdv enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to enable SDV.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# sdv enableThe following example shows how to disable SDV.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# no sdv enableRelated Commands
show sdv database
Displays the SDV database.
show vritual-device
Displays the virtual devices.
sdv virtual-device name
To create a virtual device name for a specified VSAN, use the sdv virtual-device name command in configuration mode. To remove the name, use the no form of the command.
sdv virtual-device name device-name vsan vsan-id
no sdv virtual-device name device-name vsan vsan-id
Syntax Description
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
To use this command, you must enable SDV using the sdv enable command.
No more than 1000 virtual targets can be created in a single VSAN.
No more than 128 devices can be defined as virtual devices.
Examples
The following example shows how to create a virtual device name for a VSAN, and then specify both the primary and secondary pWWNs.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# sdv virtual-device name vdev1 vsan 2switch(config-sdv-virt-dev)# pwwn 21:00:00:04:cf:cf:45:40 primaryswitch(config-sdv-virt-dev)# pwwn 21:00:00:04:cf:cf:38:d6
The following example shows how to remove the virtual device name.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# no sdv virtual-device name vdev1 vsan 2Related Commands
security-mode
To configure the Cisco SME security settings, use the security-mode command. To delete the security settings, use the no form of the command.
security-mode {basic | standard | advanced {schema threshold threshold total total }}
no security-mode {basic | standard | advanced {schema threshold threshold total total }
Syntax Description
Defaults
None.
Command Modes
Cisco SME cluster configuration submode.
Command History
Usage Guidelines
None.
Examples
The following example sets the security mode to basic:
switch# config tswitch(config)# sme cluster c1switch(config-sme-cl)# security-mode basicThe following example sets the security mode to advanced:
switch# config tswitch(config)# sme cluster c1switch(config-sme-cl)# security-mode advanced schema threshold 3 total 5Related Commands
send
To send a message to all active CLI users currently using the switch, use the send command in EXEC mode.
send message-text
Syntax Description
Defaults
None.
Command Modes
EXEC mode.
Command History
Usage Guidelines
This message is restricted to 80 alphanumeric characters with spaces.
Examples
The following 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.server
To add a server in an Internet Storage Name Service (iSNS) profile, use the server command in iSNS profile configuration submode. To delete a server from an iSNS profile, use the no form of the command.
server server-id
no server server-id
Syntax Description
Defaults
None.
Command Modes
iSNS profile configuration submode.
Command History
Usage Guidelines
An iSNS profile can have only one server address. To change the server address, you must delete the current server and add the new one.
Examples
The following example shows how to add a server address to an iSNS profile.
switch# config terminalswitch(config)# isns profile name UserProfileswitch(config-isns-profile)# server 10.1.1.1The following example shows how to delete a server address from an iSNS profile.
switch# config terminalswitch(config)# isns profile name AdminProfileswitch(config-isns-profile)# no server 10.2.2.2Related Commands
isns-server enable
Enables the iSNS server.
isns profile name
Creates iSNS profiles.
show isns
Displays iSNS information.
server (radius configuration)
To configure a RADIUS server, use the server command in RADIUS configuration submode. To discard the configuration, use the no form of the command.
server [ipv4-address | ipv6-address | dns-name]
no server [ipv4-address | ipv6-address | dns-name]
Syntax Description
Defaults
None.
Command Modes
RADIUS configuration submode.
Command History
Usage Guidelines
None.
Examples
The following example shows the server command in RADIUS configuration submode.
switch# config terminalswitch(config)# aaa group server radius testgroupswitch(config-radius)# server myserverRelated Commands
radius-server host
Configures RADIUS server parameters.
show radius-server
Displays RADIUS server configuration parameters.
server (tacacs+ configuration)
To configure a TACACS+ server, use the server command in TACACS+ configuration submode. To discard the configuration, use the no form of the command.
server [ipv4-address | ipv6-address | dns-name]
no server [ipv4-address | ipv6-address | dns-name]
Syntax Description
Defaults
None.
Command Modes
TACACS+ configuration submode.
Command History
Usage Guidelines
None.
Examples
The following example shows the server command in RADIUS configuration submode.
switch# config terminalswitch(config)# aaa group server tacacs+ testgroupswitch(config-tacacs+)# server myserverRelated Commands
tacacs-server host
Configures TACACS+ server parameters.
show tacacs-server
Displays TACACS+ server configuration parameters.
set (IPsec crypto map configuration submode)
To configure attributes for IPsec crypto map entries, use the set command in IPsec crytpo map configuration submode. To revert to the default values, use the no form of the command.
set {peer {ip-address | auto-peer} | pfs [group1 | group4 | group2 | group5] | security-association lifetime {gigabytes number | kilobytes number | megabytes number | seconds number} | transform-set {set-name | set-name-list}}
no set {peer {ip-address | auto-peer} | pfs | security-association lifetime {gigabytes | kilobytes | megabytes | seconds} | transform-set}
Syntax Description
Defaults
None.
PFS is disabled by default. When it is enabled without a group parameter, the default is group1.
The security association lifetime defaults to global setting configured by the crypto global domain ipsec security-association lifetime command.
Command Modes
IPsec crypto map configuration submode.
Command History
Usage Guidelines
To use this command, IPsec must be enabled using the crypto ipsec enable command.
Examples
The following example shows how to configure IPsec crypto map attributes.
switch# config terminalswitch(config)# crypto map domain ipsec x 1switch(config-crypto-map-ip)# set peer auto-peerRelated Commands
setup
To enter the switch setup mode, use the setup command in EXEC mode.
setup
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
EXEC mode.
Command History
Usage Guidelines
Refer to the Cisco MDS 9000 Family CLI Configuration Guide for more information on using the setup command.
The setup utility guides you through the basic configuration process. Type Ctrl-c at any prompt to skip the remaining configuration options and proceed with what is configured to that point.
If you do not want to answer a previously-configured question, or if you want to skip answers to any questions, press Enter. If a default answer is not available (for example switch name), the switch uses what is already configured, and skips to the next question.
Examples
The following example shows how to enter switch setup mode.
switch# setup---- Basic System Configuration Dialog ----This setup utility will guide you through the basic configuration ofthe system. Setup configures only enough connectivity for managementof the system.*Note: setup always assumes a predefined defaults irrespectiveof the current system configuration when invoked from CLI.Press Enter incase you want to skip any dialog. Use ctrl-c at anytimeto skip away remaining dialogs.Would you like to enter the basic configuration dialog (yes/no): yessetup
To run the basic setup facility, use the setup command.
setup | ficon | sme
Syntax Description
ficon
Run the basic FICON setup command facility.
sme
Run the basic Cisco SME setup command facility.
Defaults
None.
Command Modes
EXEC.
Command History
Usage Guidelines
Use the setup sme command to create the sme-admin and sme-recovery roles for Cisco SME.
Examples
The following example creates the sme-admin and sme-recovery roles:
switch# setup smeSet up two roles necessary for SME, sme-admin and sme-recovery? (yes/no) [no] ySME setup doneRelated Commands
setup ficon
To enter the automated FICON setup mode, use the setup ficon command in EXEC mode.
setup ficon
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
EXEC mode.
Command History
Usage Guidelines
Refer to the Cisco MDS 9000 Family CLI Configuration Guide for more information on using the setup ficon command.
The setup utility guides you through the basic configuration process. Type Ctrl-c at any prompt to skip the remaining configuration options and proceed with what is configured to that point.
If you do not want to answer a previously-configured question, or if you wish to skip answers to any questions, press Enter. If a default answer is not available (for example switch name), the switch uses what is already configured, and skips to the next question.
Examples
The following example shows how to enter switch setup mode.
switch# setup ficon---- Basic System Configuration Dialog ------- Ficon Configuration Dialog ---This setup utility will guide you through basic Ficon Configurationon the system.Press Enter if you want to skip any dialog. Use ctrl-c at anytimeto skip all remaining dialogs.Would you like to enter the basic configuration dialog (yes/no): yesshared-keymode
To configure the shared key mode, use the shared-keymode command. To specify the unique key mode, use the no form of the command.
shared-keymode
no shared-keymode
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Cisco SME cluster configuration submode.
Command History
Usage Guidelines
The shared-keymode command generates a single key that is used for a group of backup tapes.
The no shared-keymode generates unique or specific keys for each tape cartridge.
Note
Examples
The following example specifies the shared key mode:
switch# config tswitch(config)# sme cluster c1switch(config-sme-cl)# shared-keymodeThe following example specifies the shared unique keymode:
switch# config tswitch(config)# sme cluster c1switch(config-sme-cl)# no shared-keymodeRelated Commands
shutdown
To disable an interface, use the shutdown command. To enable an interface, use the no form of the command.
shutdown [force]
no shutdown [force]
Syntax Description
Defaults
None.
Command Modes
Interface configuration submode.
Command History
Usage Guidelines
The default state for interfaces is shutdown. Use the no shutdown command to enable an interface to carry traffic.
When you try to shutdown a management interface (mgmt0), a follow-up message confirms your action before performing the operation. Use the force option to bypass this confirmation, if required.
Examples
The following example shows how to enable an interface.
switch# config terminalswitch(config)# interface fc 1/2switch(config-if)# no shutdownThe following example shows how to disable an interface.
switch# config terminalswitch(config)# interface mgmt 0switch(config-if)# shutdownThe following example shows how to forcefully disable the mgmt 0 interface.
switch# config terminalswitch(config)# interface mgmt 0switch(config-if)# shutdown forceRelated Commands
interface
Specifies an interface and enters interface configuration submode.
show interface
Displays interface information.
shutdown (interface configuration submode)
To disable an Cisco SME interface, use the shutdown command. To enable the interface, use the no form of the command.
shutdown
no shutdown
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Interface configuration submode.
Command History
Usage Guidelines
The default state for Cisco SME interfaces is shutdown. Use the no shutdown command to enable the interface to carry traffic.
The show interface command shows that the Cisco SME interface is down until the interface is added to a cluster.
Examples
The following example enables a Cisco SME interface:
switch# config tswitch(config)# interface sme 4/1switch(config-if)# no shutdownThe following example disables a Cisco SME interface:
switch# config tswitch(config)# interface sme 4/1switch(config-if)# shutdownRelated Commands
shutdown (Cisco SME cluster configuration submode)
To disable a cluster for recovery, use the shutdown command. To enable the cluster for recovery, use the no form of the command.
shutdown
no shutdown
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Cisco SME cluster configuration submode.
Command History
Usage Guidelines
To disable operation of a cluster for the purpose of recovery, use the shutdown command. To enable the cluster for normal usage, use the no shutdown command.
The default state for clusters is no shutdown. Use the shutdown command for cluster recovery. See the SME Troubleshooting chapter for additional details about recovery scenarios.
Examples
The following example restarts the cluster after recovery is complete:
switch# config tswitch(config)# sme cluster c1switch(config-sme-cl)# no shutdownThe following example disables the cluster operation in order to start recovery:
switch# config tswitch(config))# sme cluster c1switch(config-switch(config-sme-cl)# shutdownRelated Commands
site-id
To configure the site ID with the Call Home function, use the site-id command in Call Home configuration submode. To disable this feature, use the no form of the command.
site-id {site-number}
no site-id {site-number}
Syntax Description
site-number
Identifies the unit to the outsourced throughput. Allows up to 256 alphanumeric characters in free format.
Defaults
None.
Command Modes
Call Home configuration submode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to configure the site ID in the Call Home configuration.
switch# config terminalEnter configuration commands, one per line. End with CNTL/Z.switch(config)# callhomeswitch(config-callhome)# site-id Site1ManhattanNYRelated Commands
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.
sleep
To delay an action by a specified number of seconds, use the sleep command.
sleep {seconds}
Syntax Description
Defaults
None.
Command Modes
EXEC mode.
Command History
Usage Guidelines
This command is useful within scripts.
Examples
The following example shows how to create a script called test-script.
switch# show file slot0:test-scriptdiscover scsi-target remotesleep 10show scsi-target diskswitch# run-script slot0:test-scriptWhen you execute the slot0:test-script, the switch executes the discover scsi-target remote command, and then waits for 10 seconds before executing the show scsi-target disk command.
The following example shows how to delay the switch prompt return.
switch# sleep 30You will see the switch prompt return after 30 seconds.
sme
To enable or disable the Cisco SME services, use the sme command.
sme {auto-save | cluster name | enable | transport pre-shared key key identifier cluster cluster }
Syntax Description
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
Cisco SME services must be enabled to take advantage of the encryption and security features.
To use this command, you must enable Cisco SME clustering using the cluster enable command.
Examples
The following example shows how to enable the Cisco SME service:
switch# config tswitch(config)# sme enableswitch(config)#The following example shows how to disable the Cisco SME service:
switch# config tswitch(config)# no sme enableswitch(config)#The following example shows how to enable automatic configuration save after the changes:
switch# config tswitch(config)# sme auto-saveswitch(config)The following example disables automatic configuration save after changes:
switch# config tswitch(config)# no sme auto-saveswitch(config)#The following example shows how to configure transport PSK:
switch# config tswitch(config)# sme transport pre-shared key keyname cluster clusternameRelated Commands
cluster enable
Enable Cisco SME clustering.
show sme cluster
Displays information about Cisco SME cluster.
snmp port
Use the snmp port command to enable SNMP control of FICON configurations. To disable the configuration or to revert to factory defaults, use the no form of the command.
snmp port control
no snmp port control
Syntax Description
This command has no arguments or keywords.
Defaults
SNMP control of FICON configurations is enabled.
Command Modes
FICON configuration submode.
Command History
Usage Guidelines
By default, SNMP users can configure FICON parameters through the Fabric Manager application. You can prohibit this access, if required, by issuing the no snmp port control command.
Examples
The following example prohibits SNMP users from configuring FICON parameters.
switch(config)# ficon vsan 2switch(config-ficon)# no snmp port controlThe following example allows SNMP users to configure FICON parameters (default).
switch(config-ficon)# snmp port controlRelated Commands
show ficon
Displays configured FICON details.
ficon vsan vsan-id
Enables FICON on the specified VSAN.
snmp-server
To configure the SNMP server information, switch location, and switch name, use the snmp-server command in configuration mode. To remove the system contact information, use the no form of the command.
snmp-server {community string [group group-name | ro | rw] | contact [name] | location [location]}
no snmp-server {community string [group group-name | ro | rw] | contact [name] | location [location]}
Syntax Description
Defaults
The default community access is read-only (ro).
Command Modes
Configuration mode
Command History
Usage Guidelines
None.
Examples
The following example sets the contact information, switch location, and switch name.
switch# config terminalswitch(config)# snmp-server contact NewUserswitch(config)# no snmp-server contact NewUserswitch(config)# snmp-server location SanJoseswitch(config)# no snmp-server location SanJoseRelated Commands
snmp-server contact
To modify system contact, use the snmp-server contact command in configuration mode. To remove the SNMP servere contact, use the no form of the command.
snmp-server contact [line]
no snmp-server contact [line]
Syntax Description
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to modify syscontact.
switch# config tswitch(config)# snmp-server contact lineswitch(config)#switch(config)# no snmp-server contact lineswitch(config)#Related Commands
snmp-server community
To set the SNMP server community string, use the snmp-server community command in configuration mode. To remove the SNMP servere community string, use the no form of the command.
snmp-server {community string [group group-name]}
no snmp-server {community string [group group-name]}
Syntax Description
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example sets the SNMP server community string.
switch# config tswitch(config)# snmp-server community public group network-operatorswitch(config)#switch(config)# no snmp-server community public group network-operatorswitch(config)#Related Commands
snmp-server enable traps
To enable SNMP server notifications (informs and traps), use the snmp-server enable traps command. To disable the SNMP server notifications, use the no form of the command.
snmp-server enable traps [entity [fru] | fcc | fcdomain | fcns | fdmi | fspf | license | link [cisco | ietf [cisco] | ietf-extended [cisco]] | port-security | rscn [els | ils] | snmp [authentication] | vrrp | zone [default-zone-behavior-change | merge-failure | merge-success | request-reject]
no snmp-server enable traps [entity [fru] | fcc | fcdomain | fcns | fdmi | fspf | license | link [cisco | ietf [cisco] | ietf-extended [cisco]] | port-security | rscn [els | ils] | snmp [authentication] | vrrp | zone [default-zone-behavior-change | merge-failure | merge-success | request-reject]
Syntax Description
Defaults
All the notifications listed in the Syntax Description table are disabled by default except for the following: entity fru, vrrp, license, link, and any notification not listed (including the generic notifications such as coldstart, warmstart, and linkupdown).
Command Modes
Configuration mode.
Command History
2.0(1b)
This command was introduced.
2.1(2)
•
•
•
Usage Guidelines
If the snmp-server enable traps command is entered without keywords, all notifications (informs and traps) are enabled.
As of Cisco MDS SAN-OS Release 2.1(2), you can configure the linkUp/linkDown notifications that you want to enable on the interfaces. You can enable the following types of linkUp/linkDown notifications:
•
•
•
•
•
Note
Examples
The following example enables all the SNMP notifications listed in the Syntax Description table.
switch# config terminalswitch(config)# snmp-server trapsThe following example enables all SNMP entity notifications.
switch# config terminalswitch(config)# snmp-server traps entityThe following example enables (default) only standard extended linkUp/linkDown notifications.switch# config t
switch(config)# snmp-server enable traps link
The following example enables only Cisco Systems defined cieLinkUp/cieLinkDown notifications.
switch# config terminal
switch(config)# snmp-server enable traps link cisco
Related Commands
show snmp
Displays SNMP information.
snmp-server host
Configures SNMP server host information.
snmp-server traps entity fru
To enable SNMP entity FRU trap, use the snmp-server traps entity fru command in configuration mode. To disable entity FRU trap, use the no form of the command.
snmp-server enable traps entityfru
no snmp-server enable traps entity fru
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to enable SNMP entity FRU trap.
switch# config tswitch(config)# snmp-server enable traps entity fruswitch(config)#Related Commands
snmp-server enable traps fcdomain
To enable SNMP FC domain traps, use the snmp-server enable traps fcdomain command in configuration mode. To disable FC domain trap, use the no form of the command.
snmp-server enable traps fcdomain
no snmp-server enable traps fcdomain
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to enable SNMP FC domain traps.
switch# config tswitch(config)# snmp-server enable traps fcdomainswitch(config)#switch(config)# no snmp-server enable traps fcdomainswitch(config)#Related Commands
snmp-server enable traps link cisco
To enable cisco cieLinkUp and cieLinkDown traps, use the snmp-server enable traps link cisco command in configuration mode. To disable cisco link trap, use the no form of the command.
snmp-server enable traps link cisco
no snmp-server enable traps link
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to enable SNMP FC domai n traps.
switch# config tswitch(config)# snmp-server enable traps link ciscoswitch(config)#switch(config)# no snmp-server enable traps linkswitch(config)#Related Commands
snmp-server enable traps zone
To enable SNMP zone traps, use the snmp-server enable traps zone command in configuration mode. To disable zone trap, use the no form of the command.
snmp-server enable traps zone
no snmp-server enable traps zone
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to enable SNMP zone traps.
switch# config tswitch(config)# snmp-server enable traps zoneswitch(config)#switch(config)# no snmp-server enable traps zoneswitch(config)#Related Commands
snmp-server globalEnforcePriv
To globally enforce privacy for all SNMP users, use the snmp-server globalEnforcePriv command in configuration mode. To disable global privacy, use the no form of the command.
snmp-server globalEnforcePriv
no snmp-globalEnforcePriv
Syntax Description
This command has no arguments or keywords.
Command Default
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example enables globally enforced privacy for all SNMP users.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# snmp-server globalEnforcePrivRelated Commands
snmp-server host
To specify the recipient of an SNMP notification, use the snmp-server host global configuration command. To remove the specified host, use the no form of the command.
snmp-server host host-address [traps | informs] [version {1 | 2c | 3 [auth | noauth | priv]}] community-string [udp-port port]
no snmp-server host host-address [traps | informs] [version {1 | 2c | 3 [auth | noauth | priv]}] community-string [udp-port port]
Syntax Description
Defaults
Sends SNMP traps.
Command Modes
Configuration mode.
Command History
Usage Guidelines
If you use the version keyword, one of the following must be specified: 1, 2c, or 3.
Examples
The following example specify the recipient of an SNMP notification.
switch# config terminalswitch(config)# snmp-server host 10.1.1.1 traps version 2c abcddsfsf udp-port 500Related Commands
show snmp
Displays SNMP information.
snmp-server host
Configures SNMP server host information.
snmp-server location
To modify system location, use snmp-server location command. To remove the SNMP server location,use the no form of the command.
snmp-server location
no snmp-server location
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example sets the SNMP server community string:
switch# config tswitch(config)# snmp-server location lineswitch(config)#Related Commands
snmp-server tcp-session
To enable one time authentication for SNMP over a TCP session, use the snmp-server tcp-session command in configuration mode. To disable one time authentication for SNMP over a TCP session, use the no form of the command.
snmp-server tcp-session [auth]
no snmp-server tcp-session [auth]
Syntax Description
Command Default
One time authentication for SNMP over a TCP session is on.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example enables one time authentication for SNMP over a TCP session.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# snmp-server tcp-session authRelated Commands
snmp-server user
To configure SNMP user information, use the snmp-server user command in configuration mode. To disable the configuration or to revert to factory defaults, use the no form of the command.
snmp-server user username [group-name] [auth {md5 | sha} password [priv [password [auto | localizedkey [auto]]] | aes-128 password [auto | localizedkey [auto] | auto | localizedkey [auto]]] | [enforcePriv]
no snmp-server user name [group-name | auth {md5 | sha} password [priv [password [auto | localizedkey [auto]]] | aes-128 password [auto | localizedkey [auto] | auto | localizedkey [auto]]] | [enforcePriv]
Syntax Description
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
The localized keys are not portable across devices as they contain information on the engine ID of the device. If a configuration file is copied into the device, the passwords may not be set correctly if the configuration file was generated at a different device. We recommend that passwords be explicitly configured to the desired passwords after copying the configuration into the device.
SNMP Version 3 is the most secure model, as it allows packet encryption with the priv keyword.
To assign multiple roles to a user, perform multiple snmp-server user username group-name commands. The group-name argument is defined by the role name command.
Examples
The following example sets the user authentication and SNMP engine ID for a notification target user:
switch# config terminalswitch(config)# snmp-server user notifUser network-admin auth sha abcd1234 engineID00:12:00:00:09:03:00:05:48:00:74:30The following example sets the user information.
switch# config terminalswitch(config)# snmp-server user joe network-admin auth sha abcd1234switch(config)# snmp-server user sam network-admin auth md5 abcdefghswitch(config)# snmp-server user Bill network-admin auth sha abcd1234 priv abcdefghswitch(config)# no snmp-server user usernameAswitch(config)# snmp-server user user1 network-admin auth md5 0xab0211gh priv 0x45abf342 localizedkeyRelated Commands
role name
Configures role profiles.
show snmp
Displays SNMP information.
snmp-server host
Configures SNMP server host information.
source
To configure a switched port analyzer (SPAN) source, use the source command in SPAN session configuration submode. To disable this feature, use the no form of the command.
source {
filter vsan vsan-id |
interface {
fc slot/port [rx [traffic-type {initiator | mgmt | target}] | tx [traffic-type {initiator | mgmt | target}] | traffic-type {initiator | mgmt | target}] |
fcip fcip-id |
fv slot/dpp-number/fv-port |
iscsi slot/port [rx [traffic-type {initiator | mgmt | target}] | tx [traffic-type {initiator | mgmt | target}] | traffic-type {initiator | mgmt | target}]|
port-channel channel-number [rx [traffic-type {initiator | mgmt | target}] | tx [traffic-type {initiator | mgmt | target}] | traffic-type {initiator | mgmt | target}] |
sup-fc number [rx [traffic-type {initiator | mgmt | target}] | tx [traffic-type {initiator | mgmt | target}] | traffic-type {initiator | mgmt | target}]} |
vsan vsan-id}no source {
filter vsan vsan-id |
interface {
fc slot/port [rx [traffic-type {initiator | mgmt | target}] | tx [traffic-type {initiator | mgmt | target}] | traffic-type {initiator | mgmt | target}] |
fcip fcip-id |
fv slot/dpp-number/fv-port |
iscsi slot/port [rx [traffic-type {initiator | mgmt | target}] | tx [traffic-type {initiator | mgmt | target}] | traffic-type {initiator | mgmt | target}]|
port-channel channel-number [rx [traffic-type {initiator | mgmt | target}] | tx [traffic-type {initiator | mgmt | target}] | traffic-type {initiator | mgmt | target}] |
sup-fc number [rx [traffic-type {initiator | mgmt | target}] | tx [traffic-type {initiator | mgmt | target}] | traffic-type {initiator | mgmt | target}]} |
vsan vsan-id}
Note
interface {bay port | ext port}Syntax Description
Defaults
Disabled.
Command Modes
SPAN session configuration submode.
Command History
1.0(2)
This command was introduced.
3.1(2)
Added the interface bay | ext option.
Usage Guidelines
None.
Examples
The following example shows how to create a SPAN session, then configures the SPAN traffic at all sources in VSAN 1.
switch# config terminalEnter configuration commands, one per line. End with CNTL/Z.switch(config)# span session 1switch(config-span)# source vsan 1The following example shows how to configure the SPAN source interface as PortChannel 1.
switch(config-span)# source interface port-channel 1The following example shows how to configure the SPAN source interface as FC 9/1 with an egress filter for VSAN 1.
switch(config-span)# source interface fc9/1 tx filter vsan 1The following example shows how to configure the SPAN source interface as FCIP 51.
switch(config-span)# source interface fcip 51The following example shows how to configure the SPAN source interface as iSCSI interface 4/1.
switch(config-span)# source interface iscsi 4/1The following example shows how to disable configure the SPAN source interface as FC 9/1 with an egress filter for VSAN 1.
switch(config-span)# no source interface fc9/1 tx filter vsan 1Related Commands
span max-queued-packets
To configure the SPAN max-queued-packets, use the span max-queued-packets command in configuration mode.To disable the SPAN drop-threshold, use the no form of the command.
span max-queued-packets id
Syntax Description
Defaults
15.
Command Modes
Configuration mode
Command History
Usage Guidelines
This command is supported only on a ISOLA platform.
Examples
The following example shows how to configure the SPAN max-queued-packets.
switch#configEnter configuration commands, one per line. End with CNTL/Z.switch(config)# span max-queued-packets 1Related Commands
show span max-queued-packets
Displays the SPAN max-queued-packets.
show span drop-counters
Displays the SPAN drop-counters.
span session
To configure a SPAN session, use the span session command. To remove a configured SPAN feature or revert it to factory defaults, use the no form of the command.
span session {session-id}
no span session {session-id}
Syntax Description
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to configure a SPAN session.
switch# config terminalswitch(config)# span session 1switch(config-span)#The following example shows how to delete a SPAN session.
switch(config)# no span session 1Related Commands
span session source interface
To configure the SPAN traffic in both ingress (rx) and egress (tx) directions, use the span session source interface command in Configuration mode.
span session session-id source interface interface type
Syntax Description
session-id
Specifies the SPAN session ID.
interface type
Specifies the destination interface mapped to a Fiber Channel or FC tunnel.
Defaults
None.
Command Modes
Configuration mode
Command History
1.0(x)
This command was introduced.
3.3(1a)
Enabled SPAN traffic in both ingress (rx) and egress (tx) directions for Generation 2 Fabric Switches.
Usage Guidelines
None.
Examples
The following example shows how to configure the SPAN traffic in both ingress and egress directions.
switch#configEnter configuration commands, one per line. End with CNTL/Z.switch(config)# span session 1switch(config-span)# source interface fc 1/5 rxswitch(config-span)# source interface fc 1/5 txswitch(config-span)# destination interface fc 1/5Related Commands
show span session
Displays specific information about a Switched Port Analyzer (SPAN) session.
special-frame
To enable or disable special frames for the FCIP interface, use the special-frame command. To disable the passive mode for the FCIP interface, use the no form of the command.
special-frame peer-wwn pwwn-id [profile-id profile-number]
no special-frame peer-wwn pwwn-id
Syntax Description
peer-wwn pwwn-id
Specifies the peer WWN ID for special frames.
profile-id profile-number
Specifies the peer profile ID. The range is 1 to 255.
Defaults
Disabled.
Command Modes
Interface configuration submode.
Command History
Usage Guidelines
Access this command from the switch(config-if)# submode.
When a new TCP connection is established, an FCIP special frame (if enabled) makes one round trip from the FCIP profile and initiates the TCP connect operation to the FCIP profile receiving the TCP connect request and back. Use these frames to identify the FCIP link endpoints, to learn about the critical parameters shared by Fibre Channel and FCIP profile pairs involved in the FCIP link, and to perform configuration discovery.
Examples
The following example configures the special frames.
switch# config terminalswitch(config)# interface fcip 1switch(config)# special-frame peer-pwwn 11:11:11:11:11:11:11:11switch(config)# special-frame peer-pwwn 22:22:22:22:22:22:22:22 profile-id 10Related Commands
show interface fcip
Displays an interface configuration for a specified FCIP interface.
ssh
To initiate a Secure Shell (SSH) session, use the ssh command in EXEC mode.
ssh {hostname | userid@hostname}
Syntax Description
hostname
Specifies the name or IP address of the host to access.
userid
Specifies a user name on a host.
Defaults
The default user name is admin.
Command Modes
EXEC mode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to initiate an SSH session using a host name.
switch# ssh host1admin@1host1's password:The following example shows how to initiate an SSH session using a host IP address.
switch# ssh 10.2.2.2admin@10.1.1.1's password:The following example shows how to initiate an SSH session using a user name host name.
switch# ssh user1@host1user1@1host1's password:Related Commands
show ssh key
Displays SSH key information.
ssh server enable
Enables SSH server.
ssh key
To generate an SSH key, use the ssh key command in configuration mode. To delete the SSH keys, use the no form of the command.
ssh key {dsa [bits] | rsa [bits] | rsa1 [bits]} [force]
no ssh key
Syntax Description
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to generate an SSH key.
switch# config terminalswitch(config)# ssh key rsa1 1024generating rsa1 key.....generated rsa1 keyswitch(config)#switch(config)# ssh key dsa 1024generating dsa key.....generated dsa keyswitch(config)#switch(config)# ssh key rsa 1024generating rsa key.....generated rsa keyswitch(config)#switch(config)# no ssh keycleared RSA keysswitch(config)#Related Commands
show ssh key
Displays SSH key information.
ssh server enable
Enables SSH server.
ssh server enable
To enable the SSH server, use the ssh server enable command in configuration mode. To disable the SSH service, use the no form of the command.
ssh server enable
no ssh server enable
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example enables the SSH server.
switch# config terminalswitch(config)# ssh server enableupdatedThe following example disables the SSH server.
switch# config terminalswitch(config)# no ssh server enableupdatedRelated Commands
ssl
To configure Secure Sockets Layer (SSL), use the ssl command. Use the no form of this command to disable this feature.
ssl kmc
no ssl kmc
Syntax Description
Defaults
None.
Command Modes
Cisco SME cluster configuration mode submode.
Command History
Usage Guidelines
None.
Examples
The following example enables SSL:
switch# config tswitch(config)# sme cluster c1switch(config-sme-cl)# ssl kmcssm enable feature
To enable a feature on the Storage Services Module (SSM), use the ssm enable feature command. To disable the feature on the module, use the no form of the command.
ssm enable feature {
invista {bootflash: uri | force module slot-number | modflash: uri | module slot-number | slot0: uri} |
nasb {force module slot-number | interface fc slot/port-port} | module slot-number} |
nsp {bootflash: uri | force module slot-number | modflash: uri | module slot-number |
slot0: uri} |
santap {force module slot-number | interface fc slot/port-port | module slot-number} |
scsi-flow {force module slot-number | interface fc slot/port-port | module slot-number}}no ssm enable feature {
invista {bootflash: uri | force module slot-number | modflash: uri | module slot-number | slot0: uri} |
nasb {force module slot-number | interface fc slot/port-port} | module slot-number} |
nsp {bootflash: uri | force module slot-number | modflash: uri | module slot-number |
slot0: uri} |
santap {force module slot-number | interface fc slot/port-port | module slot-number} |
scsi-flow {force module slot-number | interface fc slot/port-port | module slot-number}}Syntax Description
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
2.0(2b)
This command was introduced.
2.1(1a)
Added emcsr, nasb, and santap options.
3.0(1)
Changed the name of the emcsr option to invista.
Usage Guidelines
Use the ssm enable feature scsi-flow command to enable the SCSI flow feature on an SSM.
The features invista and nsp can only be provisioned on a module basis. The features nasb, santap, and scsi-flow can be provisioned on either a module or a range of interfaces.
The image must be specified when configuring the invista and nsp features.
Caution
For Release 2.1 and later images, intelligent services can be configured on a range of interfaces with the following restrictions:
•
•
•
Examples
The following example enables the Invista feature on the SSM in slot 4.
switch# config terminalEnter configuration commands, one per line. End with CNTL/Z.switch(config) ssm enable feature invista module 4The following example enables the Invista feature using the bootflash image name.
switch(config) ssm enable feature invista bootflash:image_nameThe following example enables the Invista feature using the image name found on the PC card Flash module in slot0.
switch(config) ssm enable feature invista slot0:image_nameThe following example disables the Invista feature on the SSM in slot 4.
switch(config) no ssm enable feature invista force module 4The following example enables the NASB feature on the SSM in slot 4.
switch(config) ssm enable feature nasb module 4The following example enables the NASB feature on the specific Fibre Channel interface range 1 to 4.
switch(config) ssm enable feature nasb interface fc 4/1-4The following example enables the NSP feature on the SSM in slot 4.
switch(config) ssm enable feature nsp module 4The following example enables the SANTap feature on the SSM in slot 4.
switch(config) ssm enable feature santap module 4The following example enables the SCSI flow feature on the SSM in slot 4.
switch(config) ssm enable feature scsi-flow module 4Related Commands
scsi-flow distribute
Configures the SCSI flow services.
show scsi-flow
Displays SCSI flow configuration and status.
static (iSCSI initiator configuration and iSLB initiator configuration)
To assign persistent WWNs to an iSCSI initiator or iSLB initiator, use the static command in iSCSI initiator configuration submode or iSLB initiator configuration submode. To disable this feature, use the no form of the command.
static {nwwn | pwwn} {wwn-id | system-assign}
no static {nwwn | pwwn} {wwn-id | system-assign}
Syntax Description
nwwn
Configures the initiator node WWN hex value.
pwwn
Configures the peer WWN for special frames.
wwn-id
Specifies the pWWN or nWWN ID.
system-assign
Generates the pWWN or nWWN value automatically.
Defaults
None.
Command Modes
iSCSI initiator configuration submode.
iSLB initiator configuration submode.
Command History
1.3(2)
This command was introduced.
3.0(1)
Added iSLB initiator configuration submode.
Usage Guidelines
We recommend using the system-assign option. If you manually assign a WWN, you must ensure its uniqueness. You should not use any previously-assigned WWN.
If you use system-assign option to configure WWNs for an iSLB initiator, when the configuration is saved to an ASCII file, the system-assigned WWNs are also saved. If you subsequently perform a write erase, you must manually delete the WWN configuration from the ASCII file. Failing to do so can cause duplicate WWN assignments if the ASCII configuration file is reapplied on the switch.
Examples
The following example uses the switch WWN pool to allocate the nWWN for this iSCSI initiator and to keep it persistent.
switch# config terminalEnter configuration commands, one per line. End with CNTL/Z.switch(config)# iscsi initiator name iqn.1987-02.com.cisco.initiatorswitch(config-iscsi-init)# static nWWN system-assignThe following example uses the switch WWN pool to allocate two pWWNs for this iSCSI initiator and to keep it persistent.
switch(config-iscsi-init)# static pWWN system-assign 2The following example shows a system-assigned pWWN for an iSLB initiator.
switch# config tswitch(config)# islb initiator ip-address 100.10.10.10switch(config-islb-init)# static pwwn system-assign 4
The following example removes the system-assigned pWWN for the iSLB initiator.
switch (config-islb-init)# no static pwwn system-assign 4Related Commands
stop
To stop SCSI commands in progress on a SAN tuner extension N port, use the stop command.
stop {all | command-id cmd-id}
Syntax Description
all
Stops all SCSI commands.
command-id cmd-id
Stops a specific SCSI command identified by the command number. The range is 0 to 2147483647.
Defaults
None.
Command Modes
SAN extension N port configuration submode.
Command History
Usage Guidelines
None.
Examples
The following example stops all SCSI command on a SAN extension tuner N port.
switch# san-ext-tunerswitch(san-ext)# nWWN 10:00:00:00:00:00:00:00switch(san-ext)# nport pwwn 12:00:00:00:00:00:00:56 vsan 13 interface gigabitethernet 1/2switch(san-ext-nport)# stop allThe following example stops a specific SCSI command on a SAN extension tuner N port.
switch# san-ext-tunerswitch(san-ext)# nWWN 10:00:00:00:00:00:00:00switch(san-ext)# nport pwwn 12:00:00:00:00:00:00:56 vsan 13 interface gigabitethernet 1/2switch(san-ext-nport)# stop command-id 100Related Commands
streetaddress
To configure the street address with the Call Home function, use the streetaddress command in Call Home configuration submode. To disable this feature, use the no form of the command.
streetaddress {street-address}
no streetaddress {street-address}
Syntax Description
street-address
Specifies the customer's street address where the equipment is located. Allows up to 256 alphanumeric characters in free format for the street number, city, state, and zip (combined).
Defaults
None.
Command Modes
Call Home configuration submode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to configure the street address in the Call Home configuration.
switch# config terminalEnter configuration commands, one per line. End with CNTL/Z.switch(config)# callhomeswitch(config-callhome)# streetaddress 1234 Picaboo Street, AnyCity, AnyState, 12345Related Commands
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.
suspend
To suspend a switched port analyzer (SPAN) session, use the suspend command in SPAN session configuration submode. To disable the suspension, use the no form of the command.
suspend
no suspend
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled.
Command Modes
SPAN session configuration submode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to suspend a SPAN session.
switch# config terminalEnter configuration commands, one per line. End with CNTL/Z.switch(config)# span session 1switch(config-span)# suspendswitch(config-span)# do show span session 1Session 1 (admin suspended)Destination is not configuredNo session filters configuredIngress (rx) sources arefc3/13,Egress (tx) sources arefc3/13,switch(config-span)#The following example shows how to disable the suspension of the SPAN session.
switch(config-span)# no suspendRelated Commands
switch-priority
To configure the switch priority with the Call Home function, use the switch-priority command in Call Home configuration submode. To disable this feature, use the no form of the command.
switch-priority {priority-value}
no switch-priority {priority-value}
Syntax Description
Defaults
None.
Command Modes
Call Home configuration submode.
Command History
Usage Guidelines
None.
Examples
The following example shows how to configure the switch priority in the Call Home configuration.
switch# config terminalEnter configuration commands, one per line. End with CNTL/Z.switch(config)# callhomeswitch(config-callhome)# switch-priority 0Related Commands
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.
switch-wwn
To configure a switch WWN in an autonomous fabric ID (AFID) database, use the switch-wwn command in AFID database configuration submode. To disable this feature, use the no form of this command.
switch-wwn wwn-id {autonomous-fabric-id fabric-id vsan-ranges vsan-range | default-autonomous-fabric-id fabric-id vsan-ranges vsan-range}
no switch-wwn wwn-id {autonomous-fabric-id fabric-id vsan-ranges vsan-range | default-autonomous-fabric-id fabric-id vsan-ranges vsan-range}
Syntax Description
Defaults
Disabled.
Command Modes
AFID database configuration submode.
Command History
Usage Guidelines
Using the default-autonomous-fabric-id keyword configures the default AFID for all VSANs not explicitly associated with an AFID.
Examples
The following example adds a switch WWN, an AFID, and a range of VSANs to the AFID database.
switch# config terminalEnter configuration commands, one per line. End with CNTL/Z.switch(config)# ivr vsan-topology autoswitch(config)# autonomous-fabric-id databaseswitch(config-afid-db)# switch-wwn 28:1d:00:05:30:00:06:ea autonomous-fabric-id 14 vsan-ranges 1-4The following example adds a switch WWN and the default AFID to the AFID database.
switch(config-afid-db)# switch-wwn 28:1d:00:05:30:00:06:ea default-autonomous-fabric-id 16Related Commands
autonomous-fabric-id-
databaseEnters AFID database configuration submode.
show autonomous-fabric-id-
databaseDisplays the contents of the AFID database.
switchname
To change the name of the switch, use the switchname command in configuration mode. To revert the switch name to the default name, use the no form of the command.
switchname {name}
no switchname {name}
Syntax Description
Defaults
The default is switch#.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example changes the name of the switch to myswitch1.
switch# config terminalswitch(config)# switchname myswitch1The following example changes the name of the switch to the default.
myswitch1(config)# no switchnameRelated Commands
snmp-server
Sets the contact information, switch location, and switch name within the limit of 20 characters (without spaces).
switchport
To configure a switch port parameter on a Fibre Channel, Gigabit Ethernet, or management interface, use the switchport command in interface configuration submode. To discard the configuration, use the no form of the command.
Fibre Channel Interface
switchport {beacon |
description text |
encap eisl |
fcbbscn |
fcrxbbcredit {credit [mode {E | Fx}] | default | extended credit | performance-buffers {buffers | default}} |
fcrxbufsize size |
mode {auto | E | F | FL | Fx | SD | ST | TL} |
rate-mode {dedicated | shared} |
speed {1000 | 2000 | 4000 | auto [max 2000]} |
trunk {allowed vsan {[add] vsan-id | all} | mode {auto | off | on}}}no switchport {beacon | description text | encap eisl | fcrxbbcredit [extended credit] | fcrxbufsize size | mode | rate-mode | speed | trunk allowed vsan [[add] vsan-id | all]}
Gigabit Ethernet Interface
switchport {beacon |
description text |
mtuno switchport {auto-negotiate | beacon | description text | mtu | promiscuous-mode}
Management Interface
switchport {description text |
duplex {auto | full | half} |
speed {10 | 100 | 1000}}no switchport {description text | duplex | speed}
Syntax Description
Defaults
The beacon is disabled.
The EISL encapsulation is disabled.
The default receive data buffer size is 2112 bytes.
The port mode is auto.
The speed is auto.
The maximum auto speed is 2000.
The trunk mode is on.
The rate mode is shared.
Command Modes
Interface configuration submode.
Command History
Usage Guidelines
You can specify a range of interfaces by issuing a command with the following example format:
interfacespacefc1/1space-space5space,spacefc2/5space-space7
Tip
You must perform the fcrxbbcredit extended enable command in configuration mode to use the switchport fcrxbbcredit extended command in interface configuration submode to enable extended BB_credits on a Fibre Channel interface.
The port speed on an interface, combined with the rate mode, determines the amount of shared resources available to the ports in the port group. Especially in the case of dedicated rate mode, the port group resources are reserved even though the bandwidth is not used. For example, if an interface is configured for autosensing (auto), then 4 Gbps of bandwidth is reserved even though the maximum operating speed is 2 Gbps. For the same interface, if autosensing with a maximum speed of 2 Gbps (auto max 2000) is configured, then only 2 Gbps of bandwidth is reserved and the unused 2 Gbps is shared with the other interface in the port group.
Note
Table 21-1 lists the default configurations, credits, and buffers for switching modules.
Table 21-1 Default Configurations, Credits, and Buffers
Min/Max/Default12 port
Auto1
Auto2
Dedicated
2/250/250
24 port
Auto1
Fx
Shared
1/16/16
Dedicated
1/250/16
Auto
Dedicated
2/250/250
48 port
Auto1
Fx
Shared
1/16/16
Dedicated
1/250/16
Auto
Dedicated
2/250/125
4 port
Auto3
Auto2
Auto
2/250/250
1 Auto speed negotiates to 1-, 2-, or 4-Gbps.
2 Auto port mode can operate as an E, TE, or Fx port.
3 Auto speed for a 4-port module negotiates to 10-Gbps.
When configuring port modes, observe the following guidelines:
•
•
•
•
•
When configuring PortChannels, observe the following guidelines:
•
•
•
•
•
•
•
–
–
–
Examples
The following example configures switch port parameters for a Fibre Channel interface.
switch# config terminalswitch(config)# interface fc 1/23switch(config-if)# switchport description techdocsSampleswitch(config-if)# switchport mode Eswitch(config-if)# switchport trunk mode autoswitch(config-if)# switchport trunk allowed vsan allswitch(config-if)# switchport trunk allowed vsan 3switch(config-if)# switchport trunk allowed vsan add 2switch(config-if)# switchport encap eislswitch(config-if)# switchport fcrxbbcredit performance-buffers 45switch(config-if)# switchport proxy-initiator nWWN 11:11:11:11:11:11:11:11 pwwn 22:22:22:22:22:22:22:22switch(config-if)# no switchport proxy-initiator nWWN 11:11:11:11:11:11:11:11 pwwn 22:22:22:22:22:22:22:22switch(config-if)# switchport fcrxbbcredit extended 2000The following example configures the port speed of a Fibre Channel interface and enables autosensing on the interface.
switch# config terminalswitch(config)# interface fc 1/1switch(config-if)# switchport speed 4000switch(config-if)# switchport speed autoThe following example reserves dedicated bandwidth for the interface.
switch(config-if)# switchport rate-mode dedicatedThe following example reserves shared (default) bandwidth for the interface.
switch(config-if)# switchport rate-mode sharedRelated Commands
fcrxbbcredit extended enable
Enables extended BB_credits on the switch.
show interface
Displays an interface configuration for a specified interface.
switchport auto-negotiate
To configure auto-negotiation on Gigabit Ethernet interfaces, use the switchport auto-negotiate command in configuration mode. Use the no form of the command to delete the configured switch port information.
switchport auto-negotiate
no switchport auto-negotiate
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled.
Command Modes
Interface configuration submode.
Command History
Usage Guidelines
You can configure the auto-negotiate option for a specified Gigabit Ethernet interface. By default, the port is configured to auto-negotiate. By configuring auto-negotiation, the port automatically detects the speed or pause method, and duplex of incoming signals and synchronizes with them.
Access this command from the switch(config-if)# submode for Gigabit Ethernet interfaces.
Examples
The following example configures auto-negotiation on a Gigabit Ethernet interface.
switch# config tswitch(config)# interface gigabitethernet 8/1switch(config-if)# switchport auto-negotiateThe following example disable auto-negotiation on a Gigabit Ethernet interface.
switch(config-if)# no switchport auto-negotiateRelated Commands
show interface gigabitethernet
Displays an interface configuration for a specified Gigabit Ethernet interface.
switchport ignore bit-errors
To prevent the detection of bit error threshold events from disabling the interface on Fibre Channel interfaces, use the switchport ignore bit-errors command. To revert to the default, use the no form of the command.
switchport ignore bit-errors
no switchport ignore bit-errors
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
Interface configuration submode.
Command History
Usage Guidelines
The bit error rate threshold is used by the switch to detect an increased error rate before performance degradation seriously affects traffic.
Bit errors can occur for the following reasons:
•
•
•
•
•
•
•
A bit error rate threshold is detected when 15 error bursts occur in a 5-minute period. By default, the switch disables the interface when the threshold is reached. You can issue a shutdown/no shutdown command sequence to reenable the interface.
Note
Examples
The following example shows how to prevent the detection of bit error events from disabling the interface.
switch# config tswitch(config)# interface fc1/1switch(config-if)# switchport ignore bit-errorsThe following example shows how to allow the detection of bit error events from disabling the interface.
switch# config tswitch(config)# interface fc1/1switch(config-if)# no switchport ignore bit-errorsRelated Commands
switchport ingress-rate
To configure the port rate limit for a specified interface, use the switchport ingress-rate command in interface configuration mode. Use the no form of the command to delete the configured switch port information.
switchport ingress-rate limit
no switchport ingress-rate limit
Syntax Description
Defaults
Disabled.
Command Modes
Interface configuration submode.
Command History
Usage Guidelines
Access this command from the switch(config-if)# submode. This command is only available if the following conditions are true:
•
•
Examples
The following example configures the ingress rate limit on a Fibre Channel interface.
switch# config terminalswitch(config)# interface fc 2/5switch(config-if)# switchport ingress-rate 5Related Commands
show interface fc
Displays an interface configuration for a specified Fibre Channel interface.
switchport initiator id
To configure the iSCSI initiator ID mode, use the switchport initiator id command in interface configuration submode. To delete the iSCSI inistiator ID mode, use the no form of the command.
switchport initiator id {ip-address | name}
no switchport initiator id {ip-address | name}
Syntax Description
ip-address
Identifies initiators using the IP address.
name
Identifies initiators using the specified name.
Defaults
The iSCSI initiator ID mode is disabled.
Command Modes
Interface configuration submode under the iscsi interface x/x command.
Command History
Usage Guidelines
None.
Examples
The following example configures the iSCSI initiator ID mode for a iSCSI interface.
switch# config terminalswitch(config)# interface iscsi 2/5switch(config-if)# switchport initiator id ip-addressswitch(config-if)# switchport initiator nameRelated Commands
show interface iscsi
Displays an interface configuration for a specified iSCSI interface.
switchport promiscuous-mode
To configure the promiscuous-mode in Gigabit Ethernet interfaces, use the switchport promiscuous-mode command in interface configuration submode. Use the no form of the command to delete the configured switch port information.
switchport promiscuous-mode {off | on}
no switchport promiscuous-mode
Syntax Description
Defaults
Disabled
Command Modes
Interface configuration submode.
Command History
Usage Guidelines
Access this command from the switch(config-if)# submode for Gigabit Ethernet interfaces.
Examples
The following example enables promiscuous mode on a Gigabit Ethernet interface.
switch# config terminalswitch(config)# interface gigabitethernet 8/1switch(config-if)# switchport promiscuous-mode onThe following example disables promiscuous mode on a Gigabit Ethernet interface.
switch(config-if)# switchport promiscuous-mode offThe following example disables promiscuous mode on a Gigabit Ethernet interface.
switch(config-if)# no switchport promiscuous-modeRelated Commands
show interface gigabitethernet
Displays an interface configuration for a specified Gigabit Ethernet interface.
switchport proxy-initiator
To configure the iSCSI proxy initiator mode on an iSCSI interface, use the switchport proxy-initiator command in interface configuration submode. To delete the iSCSI proxy initiator mode, use the no form of the command.
switchport proxy-initiator [nwwn wwn pwwn wwn]
no switchport proxy-initiator [nwwn wwn pwwn wwn]
Syntax Description
Defaults
The iSCSI proxy initiator mode is disabled.
Command Modes
Interface configuration submode under the iscsi interface x/x command.
Command History
Usage Guidelines
When you do not include the WWNs in the command, the IPS port dynamically assigns a pWWN and nWWN to the proxy initiator.
Caution
Examples
The following example configures theiSCSI proxy initiator mode for a iSCSI interface using WWNs.
switch# config terminalswitch(config)# interface iscsi 2/5switch(config-if)# switchport proxy-initiator nwwn 11:11:11:11:11:11:11:11 pwwn 22:22:22:22:22:22:22:22The following example configures the iSCSI proxy initiator mode for a iSCSI interface without WWNs.
switch# config terminalswitch(config)# interface iscsi 2/5switch(config-if)# switchport proxy-initiatorThe following example deletes the iSCSI proxy initiator mode for a iSCSI interface.
switch(config-if)# switchport proxy-initiatorRelated Commands
show interface iscsi
Displays an interface configuration for a specified iSCSI interface.
system cores
To enable copying the core and log files periodically, use the system cores command in configuration mode. To revert the switch to factory defaults, use the no form of the command.
system cores {slot0: | tftp:}
no system cores
Syntax Description
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
Create any required directory before issuing this command. If the directory specified by this command does not exist, the switch software logs a syslog message each time a copy cores is attempted.
Examples
The following example enables periodic copying core and log files.
switch# config terminalswitch(config)# system cores slot0:coreSampleThe following example disables periodic copying core and log files.
switch(config)# no system coresRelated Commands
system default switchport
To configure port attributes, use the system default switchport command in configuration mode. To disable port attributes, use the no form of the command.
system default switchport {shutdown | trunk mode {auto | off | on} | mode F}
no system default switchport {shutdown | trunk mode {auto | off | on} | mode F}
Syntax Description
Defaults
Enabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
Attributes configured using this command are applied globally to all future switch port configurations, even if you do not individually specify them at that time.
This command changes the configuration of the following ports to administrative mode F:
•
•
This command does not affect non-F ports that are up; however, if non-F ports are down, this command changes the administrative mode of those ports.
Examples
The following example shows how to configure port shutdown.
switch# config terminalswitch(config)# system default switchport shutdownThe following example shows how to configure the trunk mode.
switch# config terminalswitch(config)# system default switchport trunkmode autoThe following example shows how to set the administrative mode of Fibre Channel ports to mode F.
switch# config terminalswitch(config)# system default switchport mode FThe following example shows how to set the administrative mode of Fibre Channel ports to the default.
switch# config terminalswitch(config)# no system default switchport mode FRelated Commands
show system default switchport
Displays default values for switch port attributes.
show interface brief
Displays FC port modes.
system default zone default-zone permit
To configure default values for a zone, use the system default zone default-zone permit command in configuration mode. To revert to the defaults, use the no form of the command.
system default zone default-zone permit
no system default zone default-zone permit
Syntax Description
This command has no arguments or keywords.
Defaults
No default values for zones.
Command Modes
Configuration mode.
Command History
Usage Guidelines
This command defines the default values for the default zone for all VSANs. The default values are used when you initially create a VSAN and it becomes active. If you do not want to use the default values, use the zone default-zone permit vsan command to define the operational values for the default zone.
The system default zone default-zone permit command should only be used in conjunction with VSANs that have not yet been created; it has no effect on existing VSANs.
Note
Examples
The following example sets the default zone to use the default values.
switch# config terminalswitch(config)# system default zone default-zone permitThe following example restores the default setting.
switch(config)# no system default zone default-zone permitRelated Commands
system default zone distribute full
To configure default values for distribution to a zone set, use the system default zone distribute full command in configuration mode. To revert to the defaults, use the no form of the command.
system default zone distribute full
no system default zone distribute full
Syntax Description
This command has no arguments or keywords.
Defaults
Distribution to active zone sets only.
Command Modes
Configuration mode.
Command History
Usage Guidelines
This command distributes the default values for the default zone to all VSANs. The default values are used when you initially create a VSAN and it becomes active. If you do not want to use the default values, use the zoneset distribute full vsan command to distribute the operational values for the default zone.
The system default zone distribute full command should only be used in conjunction with VSANs that have not yet been created; it has no effect on existing VSANs.
Note
Examples
The following example distributes default values to the full zone set.
switch# config terminalswitch(config)# system default zone distribute fullThe following example distributes default values to the active zone set only.switch(config)# no system default zone distribute fullRelated Commands
zoneset distribute full vsan
Distributes the operational values for the default zone to all zone sets.
show system default zone
Displays default values for the default zone.
system default zone mode enhanced
To configure the zone mode default value as enhanced, use the system default zone mode enhanced command in the configuration mode. To configure the zone mode default value as basic, use the no form of the command.
system default zone mode enhanced
no system default zone mode enhanced
Syntax Description
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
This command is used to configure the default value of zoning mode as basic or enhanced. The default value of zoning mode is used when a VSAN is newly created. If the VSAN is deleted and recreated, the value of the zoning mode will default to the value specified by the configuration.
Note
Examples
The following example shows how to configure the zone mode default value as enhanced.
switch# configswitch# system default zone mode enhancedThe following example shows how to configure the zone mode default value as basic.
switch# configswitch# no system default zone mode enhancedRelated Commands=
show system default zone
Displays the default value of zone mode as basic and enhanced.
system hap-reset
To configure the HA reset policy, use the system hap-reset command in EXEC mode. Use the no form of this command to disable this feature.
system hap-reset
system no hap-reset
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled.
Command Modes
EXEC mode.
Command History
Usage Guidelines
You can disable the HA policy supervisor reset feature (enabled by default) for debugging and troubleshooting purposes.
Examples
The following example enables the supervisor reset HA policy.
switch# system hap-resetsystem health (Configuration mode)
To configure Online Health Management System (OHMS) features for a specified interface or for the entire switch, use the system health command. To disable this feature, use the no form of the command.
system health [failure-action | interface {fc slot/port | iscsi slot/port} |
loopback {frame-length {bytes | auto} | frequency seconds}]no system health [failure-action | interface {fc slot/port | iscsi slot/port}]
Note
interface {bay port | ext port}Syntax Description
Defaults
Enabled.
Frame-length is auto-size, which could range from 0 to 128.
Command Modes
Configuration mode.
Command History
1.3(4)
This command was introduced.
3.0(1)
Added the frame-length and auto options to the loopback keyword.
3.1(2)
Added the interface bay | ext option.
Usage Guidelines
If you do not configure the loopback frequency value, the default frequency of 5 seconds is used for all modules in the switch.
Note
Examples
The following example disables OHMS in this switch.
switch# config terminalswitch(config)# no system healthSystem Health is disabled.The following example enables (default) OHMS in this switch.
switch(config)# system healthSystem Health is enabled.The following example enables OHMS in this interface.
switch(config)# no system health interface fc8/1System health for interface fc8/13 is enabled.The following example disables OHMS in this interface.
switch(config)# system health interface fc8/1System health for interface fc8/13 is disabled.The following example configures the loopback frequency to be 50 seconds for any port in the switch.
switch(config)# system health loopback frequency 50The new frequency is set at 50 Seconds.The following example configures the loopback frame-length to auto.switch(config)# system health loopback frame-length autoLoopback frame-length auto-size mode is now enabled.The following example prevents the switch from taking any failure action.
switch(config)# system health failure-actionSystem health global failure action is now enabled.The following example prevents the switch configuration from taking OHMS action (default) in case of a failure.
switch(config)# no system health failure-actionSystem health global failure action now disabled.Related Commands
system health cf-crc-check
To run the CompactFlash CRC checksum test on demand, use the system health cf-crc-check command in EXEC mode.
system health cf-crc-check module slot
Syntax Description
Defaults
Enabled to automatically run in the background every 7 days.
Command Modes
EXEC mode.
Command History
Usage Guidelines
Run the CompactFlash CRC checksum test on demand to determine if the CompactFlash firmware is corrupted and needs to be updated.
The CRC checksum test can be run on demand on the following modules:
•
•
•
•
•
•
Examples
The following example shows how to run the CRC checksum test on demand.
switch# system health cf-crc-check module 4
Related Commands
show system health
Displays system health information.
show system health statistics
Displays system health statistics.
system health cf-re-flash
To update the CompactFlash firmware on demand, use the system health cf-re-flash command in EXEC mode.
system health cf-re-flash module slot
Syntax Description
Defaults
Enabled to automatically run in the background every 30 days.
Command Modes
EXEC mode.
Command History
Usage Guidelines
The CRC checksum test and the firmware update can be enabled on the following modules:
•
•
•
•
•
•
Examples
The following example shows how to update firmware on demand.
switch# system health cf-re-flash module 4Related Commands
show system health
Displays system health information.
show system health statistics
Displays system health statistics.
system health clear-errors
To clear previous error conditions stored in the Online Health Management System (OHMS) application's memory, use the system health clear-errors command.
system health clear-errors interface {fc slot/port | iscsi slot/port}
system health clear-errors module slot [battery-charger | bootflash | cache-disk | eobc | inband | loopback | mgmt]
Note
interface {bay port | ext port}Syntax Description
Defaults
Enabled.
Command Modes
EXEC mode.
Command History
1.3(4)
This command was introduced.
3.1(2)
Added the interface bay | ext option.
Usage Guidelines
You can clear the error history for Fibre Channel interfaces, iSCSI interfaces, for an entire module, or one particular test for an entire module. The battery-charger, the bootflash, the cache-disk, the eobc, the inband, the loopback, and the mgmt test options can be individually specified for a given module.
The management port test cannot be run on a standby supervisor module.
Examples
The following example clears the error history for the specified Fibre Channel interface.
switch# system health clear-errors interface fc 3/1The following example clears the error history for the specified module.
switch# system health clear-errors interface module 3The following example clears the management port test error history for the specified module.
switch# system health clear-errors module 2 mgmtsystem health external-loopback
To explicitly run an external Online Health Management System (OHMS) loopback test on demand (when requested by the user) for a specified interface or module, use the system health external-loopback command.
system health external-loopback {interface fc slot/port | source interface fc slot/port destination fc slot/port} [frame-length bytes [frame-count number] | frame-count number] [force]
Note
interface {bay port | ext port}Syntax Description
Defaults
The loopback is disabled.
The frame-length is 0. The frame-count is 1.
Command Modes
EXEC mode.
Command History
1.3(4)
This command was introduced.
3.0(1)
Added the source and destination keywords and the frame-count and frame-length options.
3.1(2)
Added the interface bay | ext option.
Usage Guidelines
Use this command to run this test on demand for the external devices connected to a switch that are part of a long haul network.
Examples
The following example displays an external loopback command for a Fibre Channel interface.
switch# system health external-loopback interface fc 3/1This will shut the requested interfaces Do you want to continue (y/n)? [n] yExternal loopback test on interface fc3/1 was successful.The following example displays the effect of the force option when implementing a forced loopback.
switch# system health external-loopback interface fc 3/1 forceExternal loopback test on interface fc3/1 was successful.Related Commands
system health internal-loopback
To explicitly run an internal Online Health Management System (OHMS) loopback test on demand (when requested by the user) for a specified interface or module, use the system health internal-loopback command.
system health internal-loopback interface {fc slot/port | iscsi slot/port} [frame-length bytes [frame-count number] | frame-count number]
Note
interface {bay port | ext port}Syntax Description
Defaults
The loopback is disabled.
The frame-length is 0. The frame-count is 1.
Command Modes
EXEC mode.
Command History
1.3(4)
This command was introduced.
3.0(1)
Added the frame-count and frame-length options.
3.1(2)
Added the interface bay | ext option.
Usage Guidelines
Internal loopback tests send and receive FC2 frames to and from the same ports and provide the round trip time taken in microseconds for the Fibre Channel interface.
Examples
The following example performs the internal loopback test for a Fibre Channel interface.
switch# system health internal-loopback interface iscsi 8/1Internal loopback test on interface iscsi 8/1 was successful.Round trip time taken is 79 usecondsRelated Commands
system health module
To configure Online Health Management System (OHMS) features for a specified module, use the system health module command. To disable these features, use the no form of this command.
system health module slot
[battery-charger [failure-action | frequency seconds] |
bootflash [failure-action | frequency seconds] |
cache-disk [failure-action | frequency seconds] |
cf-crc-check [failure-action | frequency frequency] |
cf-re-flash [failure-action | frequency frequency] |
eobc [failure-action | frequency seconds] |
failure-action |
inband [failure-action | frequency seconds] |
loopback [failure-action] |
mgmt [failure-action | frequency seconds]]no system health module slot
[battery-charger [failure-action | frequency seconds] |
bootflash [failure-action | frequency seconds] |
cache-disk [failure-action | frequency seconds] |
cf-crc-check [failure-action | frequency frequency] |
cf-re-flash [failure-action | frequency frequency] |
eobc [failure-action | frequency seconds] |
failure-action |
inband [failure-action | frequency seconds] |
loopback [failure-action] |
mgmt [failure-action | frequency seconds]]Syntax Description
Defaults
The default for OHMS is enabled.
The CRC Checksum test is enabled to automatically run in the background every 7 days.
The firmware update is enabled to automatically run in the background every 30 days.
The failure-action feature is enabled.
Command Modes
Configuration mode.
Command History
1.3(4)
This command was introduced.
3.1(3)
Added the cf-crc-check and cf-reflash options.
Usage Guidelines
The CRC checksum test and the firmware update can be enabled on the following modules:
•
•
•
•
•
•
If you do not configure the loopback frequency value, the default frequency of 5 seconds is used for all modules in the switch.
Examples
The following example enables the battery-charger test on both batteries in the CSM module. If the switch does not have a CSM, this message is issued:
switch# config terminalswitch(config)# system health module 6 battery-chargerbattery-charger test is not configured to run on module 6.The following example enables the cache-disk test on both disks in the CSM module. If the switch does not have a CSM, this message is issued:
switch(config)# system health module 6 cache-diskcache-disk test is not configured to run on module 6.The following example enables the bootflash test.
switch(config)# system health module 6 bootflashSystem health for module 6 Bootflash is already enabled.The following example enables you to prevent the SAN-OS software from taking any action if any component fails.
switch(config)# system health module 6 bootflash failure-actionSystem health failure action for module 6 Bootflash test is now enabled.The following example enables an already-enabled bootflash test.
switch(config)# system health module 6 bootflash failure-actionSystem health failure action for module 6 Bootflash test is already enabled.The following example disables the bootflash test configuration.
switch(config)# no system health module 6 bootflash failure-actionSystem health failure action for module 6 Bootflash test is now disabled.The following example sets the new frequency of the bootflash test to 200 seconds.
switch(config)# system health module 6 bootflash frequency 200The new frequency is set at 200 Seconds.The following example enables the EOBC test.
switch(config)# system health module 6 eobcSystem health for module 6 EOBC is now enabled.The following example enables the inband test.
switch(config)# system health module 6 inbandSystem health for module 6 EOBC is now enabled.The following example enables the loopback test.
switch(config)# system health module 6 loopbackSystem health for module 6 EOBC is now enabled.The following example enables the management test.
switch(config)# system health module 6 managementSystem health for module 6 EOBC is now enabled.The following example shows how to set the CompactFlash CRC test interval.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# system health module 6 cf-crc-check frequency 10The following example shows how to set the CompactFlash CRC test failure-action feature.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# system health module 6 cf-crc-check failure-actionThe following example shows how to set the CompactFlash reflash update interval.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# system health module 6 cf-reflash frequency 10The following example shows how to set the CompactFlash reflash failure-action feature.
switch# config tEnter configuration commands, one per line. End with CNTL/Z.switch(config)# system health module # cf-re-flash failure-actionRelated Commands
show system health
Displays system health information.
show system health statistics
Displays system health statistics.
system health serdes-loopback
To explicitly run an internal Online Health Management System (OHMS) Serializer/Deserializer (Serdes) loopback test on demand (when requested by the user) for a Fibre Channel interface, use the system health serdes-loopback command.
system health serdes-loopback interface fc slot/port [frame-length bytes [frame-count number] | frame-count number] [force]
Note
interface {bay port | ext port}Syntax Description
Defaults
Loopback is disabled.
The frame-length is 0. The frame-count is 1.
Command Modes
EXEC mode.
Command History
3.0(1)
This command was introduced.
3.1(2)
Added the interface bay | ext option.
Usage Guidelines
None.
Examples
The following example performs a Serdes loopback test within ports for an entire module.
switch# system health serdes-loopback interface fc 4/1This will shut the requested interfaces Do you want to continue (y/n)? [n] ySerdes loopback test on interface fc 4/1 was successful.The following example performs a Serdes loopback test within ports for the entire module and overrides the frame count configured on the switch.
switch# system health serdes-loopback interface fc 3/1 frame-count 10This will shut the requested interfaces Do you want to continue (y/n)? [n] ySerdes loopback test passed for module 3 port 1Related Commands
system heartbeat
To enable system heartbeat checks, use the system heartbeat command in EXEC mode. Use the no form of this command to disable this feature.
system heartbeat
system no heartbeat
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled.
Command Modes
EXEC mode.
Command History
Usage Guidelines
You can disable the heartbeat checking feature (enabled by default) for debugging and troubleshooting purposes like attaching a GDB to a specified process.
Examples
The following example enables the system heartbeat checks.
switch# system heartbeatsystem memlog
To collect system memory statistics, use the system memlog command in EXEC mode.
system memlog
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled.
Command Modes
EXEC mode.
Command History
Usage Guidelines
Use this command for debugging and troubleshooting purposes.
Examples
The following example enables system memory logging.
switch# system memlogsystem startup-config
To release a system startup configuration lock, use the system startup-config command in EXEC mode.
system startup-config unlock lock-id
Syntax Description
Defaults
Disabled.
Command Modes
EXEC.
Command History
Usage Guidelines
The system startup-config command allows you to unlock or release the rr_token lock. To determine the lock-id, use the show system internal sysmgr startup-config locks command.
Examples
The following example releases the system configuration lock with identifier 1.
switch# system startup-config unlock 1Related Commands
system statistics reset
To reset the high availability statistics collected by the system, use the system statistics reset command in EXEC mode.
system statistics reset
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled.
Command Modes
EXEC mode.
Command History
Usage Guidelines
You can disable the system statistics reset feature (enabled by default) for debugging and troubleshooting purposes.
Examples
The following example resets the HA statistics.
switch# system statistics resetsystem switchover (EXEC mode)
To specifically initiate a switchover from an active supervisor module to a standby supervisor module, use the system switchover command in EXEC mode.
system switchover
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
EXEC mode.
Command History
Usage Guidelines
Any switchover function is nonrevertive. Once a switchover has occurred and the failed processor has been replaced or successfully restarted, you cannot switch back to the original, active supervisor module (unless there is a subsequent failure or you issue the system switchover command).
Examples
The following example initiates a HA switchover from an active supervisor module to a standby supervisor module.
switch# system switchoverRelated Commands
system switchover (configuration mode)
To enable a switchover for the system, use the system switchover command in configuration mode. To revert to the factory default setting, use the no form of the command.
system switchover {ha | warm}
no system switchover
Syntax Description
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
None.
Examples
The following example enables a HA switchover from an active supervisor module to a standby supervisor module.
switch# config terminalswitch(config)# system switchover hasystem trace
To configure the system trace level, use the system trace command in configuration mode. To disable this feature, use the no form of the command.
system trace bit-mask
no system trace
Syntax Description
Defaults
None.
Command Modes
Configuration mode.
Command History
Usage Guidelines
This command is used for debugging purposes.
Examples
The following example shows how to configure the system trace level.
switch# config terminalswitch(config)# system trace 0xffsystem watchdog
To enable watchdog checks, use the system watchdog command in EXEC mode. To disable this feature, use the no form of the command.
system watchdog
system no watchdog
Syntax Description
This command has no arguments or keywords.
Defaults
Enabled.
Command Modes
EXEC mode.
Command History
Usage Guidelines
If a watchdog is not logged at every 8 seconds by the software, the supervisor module reboots the switch.
You can disable the watchdog checking feature (enabled by default) for debugging and troubleshooting purposes like attaching a GDB or a kernel GDB (KGDB) to a specified process.
Examples
The following example enables the system watchdog.
switch# system watchdog
