-
Cisco MDS 9000 Family Command Reference, Release 2.x
-
Preface
-
CLI Overview
-
A Commands
-
B Commands
-
C 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
-
P Commands
-
Q Commands
-
R Commands
-
S Commands
-
Show Commands
-
T Commands
-
U Commands
-
V Commands
-
W Commands
-
Z Commands
-
Advanced Services Module (ASM) Commands
-
Caching Services Module (CSM) Commands
-
FeedbackTable Of Contents
set (IPsec crypto map configuration submode)
static (iSCSI initiator submode)
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 the "Command Modes" section to determine the appropriate mode for each command. For more information, refer to the Cisco MDS 9000 Family Configuration Guide.
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
no santap module slot-number appl-vsan vsan-id
Syntax Description
Defaults
Disabled.
Command Modes
Configuration mode.
Command History
Usage Guidelines
To access this command you must first enable the SANTap feature on the SSM using the ssm enable feature command.
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
Enables the SANTap feature on the SSM.
Displays the configuration and statistics of the SANTap feature.
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
Distribution is enabled by default.
Command Modes
Configuration mode.
Command History
Usage Guidelines
You must enable the SCSI flow feature on the Advanced Services Module (ASM) or 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
Enables the SCSI flow feature on the SSM.
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
Disabled
Command Modes
Configuration mode.
Command History
Usage Guidelines
You must enable the SCSI flow feature on the Advanced Services Module (ASM) or 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:
•
Initiator VSAN number—101
•
•
•
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
Enables the SCSI flow feature on the SSM.
Displays SCSI flow configuration and status.
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.
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 | group14 | 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
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
Refer to the Cisco MDS 9000 Family 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 until that point.
If you do not wish 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 previously 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 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 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 until that point.
If you do not wish 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 previously 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): yesshutdown
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.
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
(Optional) 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
Configures the Call Home function.
Sends a dummy test message to the configured destination(s).
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. For example, if you 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 software executes the discover scsi-target remote command, and then waits for 10 seconds before executing the show scsi-target disk command.
Examples
The following example shows how to delay the switch prompt return.
switch# sleep 30You will see the switch prompt return after 30 seconds.
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
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 SanJoseswitch(config)# snmp-server name NewNameswitch(config)# no snmp-server name NewNameswitch(config)# no snmp-server user usernameARelated 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 | standard [cisco] | standard-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 | standard [cisco] | standard-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
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 entityTo 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 host
To specify the recipient of an Simple Network Management Protocol notification operation, 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] [notification-type]
no snmp-server host host-address [traps | informs] [version {1 | 2c | 3 [auth | noauth | priv]}] community-string [udp-port port] [notification-type]
Syntax Description
Defaults
Sends SNMP traps.
Command Modes
Configuration mode
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(3).
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 500snmp-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]]]
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]]]
Syntax Description
Defaults
None.
Command Modes
Configuration mode.
Command History
1.0(2)
This command was introduced.
1.0(3)
Added the localizedkey option.
2.0(1b)
Added the auto and aes128 options.
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 is defined by the role name command.
Examples
The 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}Syntax Description
Defaults
Disabled.
Command Modes
SPAN session configuration submode.
Command History
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 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
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. If no user name is specified, the default is "admin".
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 enableupdatedswitch(config)# no ssh server enableupdatedRelated Commands
ssm 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 {
emcsr {bootflash: uri | module slot-number | slot0: uri} |
nasb {interface fc slot/port-port} | module slot-number} |
nsp {bootflash: uri | module slot-number | slot0: uri} |
santap {interface fc slot/port-port | module slot-number} |
scsi-flow {interface fc slot/port-port | module slot-number}}no ssm enable feature {
emcsr {bootflash: uri | module slot-number | slot0: uri} |
nasb {interface fc slot/port-port} | module slot-number} |
nsp {bootflash: uri | module slot-number | slot0: uri} |
santap {interface fc slot/port-port | module slot-number} |
scsi-flow {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 features.
Usage Guidelines
Use the ssm enable feature scsi-flow command to enable the SCSI flow feature on an SSM.
The features emcsr 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 emcsr 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 EMCSR feature on the SSM in slot 4.
switch# config terminalEnter configuration commands, one per line. End with CNTL/Z.switch(config) ssm enable feature emcsr module 4The following example enables the EMCSR feature using the bootflash image name.
switch(config) ssm enable feature emcsr bootflash:image_nameThe following example enables the EMCSR feature using the image name found on the PC card Flash module in slot0.
switch(config) ssm enable feature emcsr slot0:image_nameThe following example disables the EMCSR feature on the SSM in slot 4.
switch(config) no ssm enable feature emcsr 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
static (iSCSI initiator submode)
To assign persistent WWNs to an iSCSI initiator, use the static command in iSCSI 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.
Command History
Usage Guidelines
None.
Examples
The following example uses the switch WWN pool to allocate the nWWN for this iSCSI initiator and keeps 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 keeps it persistent.
switch(config-iscsi-init)# static pWWN system-assign 2Related Commands
Assigns an iSCSI name and changes to iSCSI initiator configuration submode.
show iscsi initiator
Displays information about configured iSCSI initiators.
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
Stop 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
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
Configures the Call Home function.
Sends a dummy test message to the configured destination(s).
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
priority-value
(Optional). Configures the switch priority. Specifies a priority value. 0 is the highest priority and 7 the lowest.
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
Configures the Call Home function.
Sends a dummy test message to the configured destination(s).
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 shows adds a switch WWN, AFID, and 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-4
The following example shows 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
Enters AFID database configuration submode.
Displays 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
Syntax Description
Defaults
switch
Command Modes
Configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
None.
Examples
The following example changes the name of the switch to myswitch1.
switch# config terminalswitch(config)# switchname myswitch1myswitch1(config)#myswitch1(config)# no switchnameswitch(config)#Related Commands
snmp-server
Sets the contact information, switch location, and switch name within the limit of 20 characters (without spaces).
switchport
To configure switchport parameter on a Fibre Channel interface, use the switchport command in interface configuration submode.
switchport {beacon |
description text |
encap eisl |
fcrxbbcredit {credit [mode {E | Fx}] | default | extended credit | performance-buffers {buffers | default}} |
fcrxbufsize size |
mode {auto | E | F | FL | Fx | SD | TL} |
speed {1000 | 2000 | auto} |
trunk {allowed vsan {[add] vsan-id | all} | mode {auto | off | on}}}no switchport {beacon | description | encap | fcrxbbcredit [extended credit] | fcrxbufsize | mode | speed | trunk allowed vsan [[add] vsan-id | all]}
Syntax Description
Defaults
The beacon is disabled.
The EISL encapsulation is disabled.
The default receive data buffer size is 2112 bytes.
The mode is auto.
The speed is auto.
The trunk mode is on.
Command Modes
Interface configuration submode.
Command History
1.0(2)
This command was introduced.
2.0(1b)
Added the extended option to the fcrxbbcredit keyword.
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 subcommand to enable extended BB_credits on a Fibre Channel interface.
Examples
The following example configures switchport features 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 2000Related 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 in Gigabit Ethernet interfaces, use the switchport auto-negotiate command in configuration mode. Use the no form of the command to delete the configured switchport information.
switchport auto-negotiate
no switchport auto-negotiate
Syntax Description
switchport
Configures switchport parameters.
auto-negotiate
Automatically negotiates the speed, pause method, and duplex of incoming signals based on the link partner.
Defaults
Enabled
Command Modes
Interface configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.1(1).
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, 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 switchport information.
switchport ingress-rate limit
no switchport ingress-rate limit
Syntax Description
Defaults
Disabled
Command Modes
Interface configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(1).
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 configured switchport information, 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
Disabled
Command Modes
Interface configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.1(1).
Usage Guidelines
Access this command from the switch(config-if)# submode.
Examples
The following example configures the switchport 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 switchport information.
switchport promiscuous-mode {off | on}
no switchport promiscuous-mode
Syntax Description
Defaults
Disabled
Command Modes
Interface configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.1(1).
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, use the switchport proxy-initiator command in interface configuration submode. To delete the configured switchport 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
Disabled.
Command Modes
Interface configuration submode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.1(1).
Usage Guidelines
Access this command from the switch(config-if)# submode.
When you do not include the WWNs in the command, the IPS port dynamically assigns a pWWN and nWWN to the proxy initiator.
Examples
The following example configures the switchport 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 switchport 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 switchport 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
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
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 coresswitch(config)#Related Commands
system default switchport
To configure default values for various switchport attributes, use the system default switchport command in configuration mode. To revert to the default, use the no form of the command.
system default switchport {shutdown | trunk {mode auto | off | on}}
no system default switchport shutdown
Syntax Description
Defaults
Enabled
Command Modes
Configuration mode
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
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.
Examples
The following example configures default values for switchport attributes.
switch# config terminalswitch(config)# system default switchport shutdownswitch(config-if)#switch(config)# no system default switchport shutdownswitch(config-if)#switch(config)# system default switchport trunkmode autoswitch(config-if)#Related Commands
show system default switchport
Displays default values for switch port attributes.
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
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
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
To configure Online System Health Management (OSHM) features for a specified interface or for the entire switch, use the system health command. Use the no form of this command to disable this feature.
system health [failure-action | interface {fc slot/port | iscsi slot/port} | loopback frequency seconds]
no system health [failure-action | interface {fc slot/port | iscsi slot/port} | loopback frequency seconds]
Syntax Description
Defaults
Enabled
Command Modes
Configuration mode
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(4).
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.
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 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 to taking OHMS action (default) in case of a failure.
switch(config)# no system health failure-actionSystem health global failure action now disabled.system health clear-errors
To clear previous error conditions stored in the Online System Health Management (OSHM) 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]
Syntax Description
Defaults
Enabled
Command Modes
EXEC mode
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(4).
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 System Health Management (OSHM) 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 [force]
Syntax Description
interface
Specifies the interface to be configured.
fc slot/port
Configures the Fiber Channel interface using the slot and port.
force
Directs the software to use the non-interactive loopback mode.
Defaults
Disabled.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(4).
Usage Guidelines
Use this command to run this test on demand for the external devices connected to a switch that is 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 to implement a forced loopback.
switch# system health external-loopback interface fc 3/1 forceExternal loopback test on interface fc3/1 was successful.system health internal-loopback
To explicitly run an internal Online System Health Management (OSHM) 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}
Syntax Description
interface
Specifies the interface to be configured.
fc slot/port
Configures the Fiber Channel interface using the slot and port.
iscsi slot/port
Selects the iSCSI interface to configure.
Defaults
None
Command Modes
EXEC mode
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(4).
Usage Guidelines
Internal loopback tests send and receive FC2 frames to/from the same ports and provides the round trip time taken in microseconds for both Fibre Channel and iSCSI interfaces.
Examples
The following example performs the internal loopback test for an iSCSI interface.
switch# system health internal-loopback interface iscsi 8/1Internal loopback test on interface iscsi8/1 was successful.Round trip time taken is 79 usecondssystem health module
To configure Online System Health Management (OSHM) features for a specified module, use the system health module command. Use the no form of this command to disable this feature.
system health module slot
[battery-charger [failure-action | frequency seconds] |
bootflash [failure-action | frequency seconds] |
cache-disk [failure-action | frequency seconds] |
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] |
eobc [failure-action | frequency seconds] |
failure-action |
inband [failure-action | frequency seconds] |
loopback [failure-action] |
mgmt [failure-action | frequency seconds]]Syntax Description
Defaults
Enabled.
Command Modes
Configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.3(4).
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.
Examples
The following example enables the battery-charger test on both batteries in the CSM module residing in slot 8. If the switch does not have a CSM, this message is issued,
switch# config terminalswitch(config)# system health module 8 battery-chargerbattery-charger test is not configured to run on module 8.The following example enables the cache-disk test on both disks in the CSM module residing in slot 8. If the switch does not have a CSM, this message is issued,
switch(config)# system health module 8 cache-diskcache-disk test is not configured to run on module 8.The following example enables the bootflash test on Module 8.
switch(config)# system health module 8 bootflashSystem health for module 8 Bootflash is already enabled.The following example enables you to prevent the SAN-OS software from taking any OHMS action if any component fails in Module 8.
switch(config)# system health module 8 bootflash failure-actionSystem health failure action for module 8 Bootflash test is now enabled.The following example enables an already-enabled bootflash test on Module 8.
switch(config)# system health module 8 bootflash failure-actionSystem health failure action for module 8 Bootflash test is already enabled.The following example disables the bootflash test configuration on Module 8.
switch(config)# no system health module 8 bootflash failure-actionSystem health failure action for module 8 Bootflash test is now disabled.The following example sets the new frequency of the bootflash test on module 8 to 200 seconds.
switch(config)# system health module 8 bootflash frequency 200The new frequency is set at 200 Seconds.The following example enables the EOBC test on Module 8.
switch(config)# system health module 8 eobcSystem health for module 8 EOBC is now enabled.The following example enables the inband test on Module 8.
switch(config)# system health module 8 inbandSystem health for module 8 EOBC is now enabled.The following example enables the loopback test on Module 8.
switch(config)# system health module 8 loopbackSystem health for module 8 EOBC is now enabled.The following example enables the management test on Module 8.
switch(config)# system health module 8 managementSystem health for module 8 EOBC is now enabled.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
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
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.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
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.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
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
This command was modified in Cisco MDS SAN-OS Release 1.3(1).
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
This command was modified in Cisco MDS SAN-OS Release 1.3(1).
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
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
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
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
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 supervisor reset HA policy.
switch# system watchdog
