Cisco MDS 9000 Family Command Reference, Release 1.3 (from Release 1.3(1) through Release 1.3(6)) - S Commands [Cisco MDS 9000 NX-OS and SAN-OS Software]

Table Of Contents

S Commands

send

setup

setup ficon

shutdown

sleep

snmp port

snmp-server

snmp-server host

span session

special-frame

ssh key

ssh server enable

switchname

switchport

switchport auto-negotiate

switchport ingress-rate

switchport initiator id

switchport promiscuous-mode

system cores

system default switchport

system hap-reset

system health

system health clear-errors

system health external-loopback

system health internal-loopback

system health module

system heartbeat

system memlog

system statistics reset

system switchover (EXEC mode)

system switchover (configuration mode)

system trace

system watchdog

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.

•send

•setup

•setup ficon

•sleep

•snmp port

•snmp-server

•snmp-server host

•span session

•special-frame

•ssh key

•ssh server enable

•switchname

•switchport

•switchport auto-negotiate

•switchport ingress-rate

•switchport initiator id

•switchport promiscuous-mode

•system cores

•system default switchport

•system hap-reset

•system health

•system health clear-errors

•system health external-loopback

•system health internal-loopback

•system health module

•system heartbeat

•system memlog

•system statistics reset

•system switchover (EXEC mode)

•system switchover (configuration mode)

•system trace

•system watchdog

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

message-text

The text of your message.

Defaults

None.

Command Modes

EXEC mode.

Command History

This command was introduced in Cisco MDS SAN-OS Release 1.0(2).

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.
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 of
the system. Setup configures only enough connectivity for management
of the system.
*Note: setup always assumes a predefined defaults irrespective
of the current system configuration when invoked from CLI.
Press Enter incase you want to skip any dialog. Use ctrl-c at anytime
to skip away remaining dialogs.
Would you like to enter the basic configuration dialog (yes/no): yes
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

This command was introduced in Cisco MDS SAN-OS Release 1.3(1).

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 Configuration
on the system.
Press Enter if you want to skip any dialog. Use ctrl-c at anytime
to skip all remaining dialogs.
Would you like to enter the basic configuration dialog (yes/no): yes
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

force

Forces the shutdown of the mgmt 0 interface to avoid the confirmation.

Defaults

None.

Command Modes

Interface configuration submode.

Command History

This command was introduced in Cisco MDS SAN-OS Release 1.0(1).

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 t
switch(config)# interface fc 1/2
switch(config-if)# no shutdown
The following example shows how to disable an interface.
switch# config t
switch(config)# interface mgmt 0
switch(config-if)# shutdown
The following example shows how to forcefully disable the mgmt 0 interface.
switch# config t
switch(config)# interface mgmt 0
switch(config-if)# shutdown force
Related Commands

Command

Description

interface

Specifies an interface and enters interface configuration submode.

show interface

Displays interface information.

sleep

To delay an action by a specified number of seconds, use the sleep command.

sleep seconds
Syntax Description

seconds

The number of seconds to delay an action.

Defaults

None.

Command Modes

EXEC mode.

Command History

This command was introduced in Cisco MDS SAN-OS Release 1.0(2).

Usage Guidelines

This command is useful within scripts. For example, if you create a script called test-script:
switch# show file slot0:test-script
discover scsi-target remote
sleep 10
show scsi-target disk
switch# run-script slot0:test-script
When you execute the slot0:test-script, the switch software executes the discover scsi-target remote command, and then waits for 10 seconds before executing the show scsi-target disk command.

Examples

The following example shows how to delay the switch prompt return.
switch# sleep 30
You 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

This command was introduced in Cisco MDS SAN-OS Release 1.3(1).

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 2
switch(config-ficon)# no snmp port control
The following example allows SNMP users to configure FICON parameters (default).
switch(config-ficon)# snmp port control
Related Commands

Command

Description

show ficon

Displays configured FICON details.

ficon vsan vsan-id

Enables FICON on the specified VSAN.

snmp-server

To set the contact 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 [ro | rw] | contact [name] | location [location] | user name [rolename] [auth {{md5 | sha} password [localizedkey | priv [[aes-128] password [localizedkey]]]}
no snmp-server {community string [ro | rw] | contact [name] | location [location] | user name [rolename] [auth {{md5 | sha} password [localizedkey | priv [[aes-128] password [localizedkey]]]}
Syntax Description

community string

Specifies SNMP community string. Maximum length is 32 characters.

ro

Sets read-only access with this community string.

rw

Sets read-write access with this community string.

contact

Configures system contact.

name

Specifies the name of the contact. Maximum length is 80 characters.

location

Configures system location.

location

Specifies system location. Maximum length is 80 characters.

user

Sets a user who can access the SNMP engine.

rolename

Specifies group to which the user belongs. Maximum length is 32 characters.

auth

Sets authentication parameters for the user.

md5

Sets HMAC MD5 algorithm for authentication.

password

Specifies user password. Maximum length is 130 characters.

priv

Sets encryption parameters for the user.

sha

Uses HMAC SHA algorithm for authentication.

localizedkey

Sets passwords in localized key format.

aes-128

Uses 128-byte AES algorithm for privacy.

Defaults

The default is read-only (ro).

Command Modes

Configuration mode

Command History

This command was modified in Cisco MDS SAN-OS Release 1.0(3).

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.

Examples

The following example sets the contact information, switch location, and switch name.
switch# config t
switch(config)# snmp-server contact NewUser 
switch(config)# no snmp-server contact NewUser 
switch(config)# snmp-server location SanJose
switch(config)# no snmp-server location SanJose
switch(config)# snmp-server name NewName 
switch(config)# no snmp-server name NewName 
switch(config)# snmp-server user joe network-admin auth sha abcd1234
switch(config)# snmp-server user sam network-admin auth md5 abcdefgh
switch(config)# snmp-server user Bill network-admin auth sha abcd1234 priv abcdefgh
switch(config)# no snmp-server user usernameA 
switch(config)# snmp-server user user1 network-admin auth md5 0xab0211gh priv 0x45abf342 
localizedkey
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 this 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

host-address

Specifies the name or IP address of the host (the targeted recipient).

traps

Sends SNMP traps to this host.

informs

Sends SNMP informs to this host.

version

Specifies the version of the Simple Network Management Protocol (SNMP) used to send the traps. Version 3 is the most secure model, as it allows packet encryption with the priv keyword.

1

SNMPv1 (default). This option is not available with informs.

2c

SNMPv2C.

3

SNMPv3 has three optional keywords (auth, no auth (default), or priv).

auth

Enables Message Digest 5 (MD5) and Secure Hash Algorithm (SHA) packet authentication

noauth

Specifies the noAuthNoPriv security level.

priv

Enables Data Encryption Standard (DES) packet encryption (privacy).

community-string

Sends a password-like community string with the notification operation.

udp-port

Specifies the port UDP port of the host to use. The default is 162.

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 t
switch(config)# snmp-server host 10.1.1.1 traps version 2c abcddsfsf udp-port 500
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 -->
destination interface {fc slot/port | fc-tunnel tunnel-id}
source {filter | interface {fc slot/port | fcip fcip-id | iscsi slot/port | port-channel channel-number rx | tx | sup-fc number} [rx | traffic-type {initiator | mgmt | target} | tx]} | vsan vsan-id}
suspend
span session session-id -->
no destination interface {fc slot/port | fc-tunnel tunnel-id}
no source {filter | interface {fc slot/port | fcip fcip-id | iscsi slot/port | port-channel channel-number rx | tx | sup-fc number} [rx | traffic-type {initiator | mgmt | target} | tx]} | vsan vsan-id}
no suspend
no span session session-id
Syntax Description

session-id

Enter SPAN session ID from 1 to 16.

destination

Specifies the SPAN destination.

interface

Specifies SPAN source or destination interface configuration.

fc slot/port

Specifies the Fiber Channel interface ID at a slot and port.

fc-tunnel tunnel-id

Specifies the Fiber Channel tunnel interface ID.

source

Specifies the SPAN source.

rx

Specifies SPAN traffic in ingress direction

traffic-type

Configures the SPAN traffic type.

initiator

Specifies initiator traffic.

mgmt

Specifies management traffic.

target

Specifies target traffic.

tx

Specifies SPAN traffic in egress direction

fcip fcip-id

Specifies the FCIP interface ID. The range is 1 to 255.

iscsi slot/port

Specifies the iSCSI interface ID at a slot and port.

port-channel channel-number

Specifies the PortChannel interface ID. The range is 1 to 128.

sup-fc number

Specifies the inband interface, which is 0.

vsan vsan-id

Specifies the VSAN ID. The range is 1 to 4093.

suspend

SPAN suspend session.

Defaults

None.

Command Modes

Configuration mode.

Command History

This command was modified in Cisco MDS SAN-OS Release 1.2(1).

Usage Guidelines

None.

Examples

The following example shows how to configure a SPAN session.
switch# config t
switch(config)# span session 1
switch(config-span)# destination interface fc9/1
switch(config-span)# no destination interface fc1/5
switch(config-span)# source interface sup-fc0
switch(config-span)# source vsan 1
switch(config-span)# source interface port-channel 1
switch(config-span)# no source interface port-channel 3
switch(config-span)# suspend
switch(config-span)# no suspend
switch(config-span)# exit
switch(config)# span session 1
switch(config-span)# source interface fc9/1 tx filter vsan 1
switch(config-span)# source interface fcip 51
switch(config-span)# source interface iscsi 4/1
switch(config-span)# source filter vsan 1-2
switch(config-span)# exit
switch(config)# span session 11
switch(config-span)# destination interface fc-tunnel 1500
switch(config)# no span session 6
Related Commands

Command

Description

show span session

Displays all SPAN session information.

special-frame

To enable or disable special frames for the FCIP interface, use the special-frame option. To disable the passive mode for the FCIP interface, use the no form of the option.

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

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 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 t
switch(config)# interface fcip 1
switch(config)# special-frame peer-pwwn 11:11:11:11:11:11:11:11
switch(config)# special-frame peer-pwwn 22:22:22:22:22:22:22:22 profile-id 10
Related Commands

Command

Description

show interface fcip

Displays an interface configuration for a specified FCIP interface.

ssh key

To generate a 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

dsa [bits]

Generates a DSA key. The range for the number of bits is 768 to 1856.

rsa [bits]

Generates an RSA key. The range for the number of bits is 768 to 2048.

rsa1 [bits]

Generates an RSA1 key. The range for the number of bits is 768 to 2048.

force

Forces the generation of keys even when previous keys are present.

Defaults

None.

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 shows how to generate a SSH key.
switch# config t
switch(config)# ssh key rsa1 1024
generating rsa1 key.....
generated rsa1 key
switch(config)#
switch(config)# ssh key dsa 1024
generating dsa key.....
generated dsa key
switch(config)#
switch(config)# ssh key rsa 1024 
generating rsa key.....
generated rsa key
switch(config)#
switch(config)# no ssh key
cleared RSA keys
switch(config)#
Related Commands

Command

Description

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

This command was introduced in Cisco MDS SAN-OS Release 1.0(2).

Usage Guidelines

None.

Examples

The following example enables the SSH server.
switch# config t
switch(config)# ssh server enable
updated
switch(config)# no ssh server enable
updated
Related Commands

Command

Description

show ssh server

Displays SSH server information.

ssh key

Generates an SSH key.

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

name

Specifies a switch name. Maximum length is 32 characters.

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 t
switch(config)# switchname myswitch1
myswitch1(config)# 
myswitch1(config)# no switchname
switch(config)# 
Related Commands

Command

Description

snmp-server

Sets the contact information, switch location, and switch name within the limit of 20 characters (without spaces).

switchport

To assign the port mode, allowed VSAN numbers, or the description of an FCIP interface, use the switchport command in configuration mode. Use the no form of the command to delete the configured switchport information.

switchport {beacon |
description text |
encap eisl |
fcrxbbcredit {credit [mode {E | Fx}] | default | 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 | fcrxbufsize | mode | speed |
trunk {allowed vsan | mode {auto | off | on}}}
Syntax Description

slot/port

Specifies a slot number and port number.

switchport

Configures switchport parameters.

beacon

Enables the beacon for the interface.

description text

Specifies the interface description. Maximum length is 80 characters.

encap eisl

Configures EISL encapsulation for the interface.

fcrxbbcredit

Configures receive BB_credit for the port.

credit

Specifies receive BB_credit. The range is 1 to 255

mode

Configures receive BB_credit for specific mode.

E

Specifies receive BB_credit for E or TE mode.

Fx

Specifies receive BB_credit for F or FL mode.

default

Specifies default receive BB_credits depending on the port mode and capabilities.

performance-buffers {buffers | default}

Specifies receive BB_credit performance buffers. The range is 1 to 145. The default value is determined by a built-in algorithm.

fcrxbufsize size

Configures receive data field size for the interface. The range is 256 to 2112 byes.

mode

Configures the port mode.

auto

Specifies autosense mode.

E

Specifies E port mode.

F

Specifies F port mode.

FL

Specifies FL port mode.

Fx

Specifies Fx port mode.

SD

Specifies SD port mode.

TL

Specifies TL port mode.

speed

Configures the port speed.

1000

Specifies 1000 Mbps speed.

2000

Specifies 2000 Mbps speed.

auto

Specifies autosense speed.

trunk

Configures trunking parameters on the interface.

allowed

Specifies the allowed list for interface(s).

vsan

Configures the VSAN range.

add

Adds the VSAN id to the range of allowed vsan list

vsan-id

The ID of the VSAN. The range is 1 to 4093.

all

Adds all the VSANs to allowed VSAN list.

mode

Configures the trunking mode.

auto

Specifies automatic trunking mode.

off

Disables the trunking mode.

on

Enables the trunking mode.

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

Release

Modification

1.0(2)

This command was introduced.

2.0(1)

Added the extended option to the fcrxbbcredit keyword.

Usage Guidelines

Access this command from the switch(config-if)# submode.

You can specify a range of interfaces by issuing a command with the following example format:

interfacespacefc1/1space-space5space,spacefc2/5space-space7

Tip The shutdown or no shutdown command for the FCIP or iSCSI interfaces is automatically issued when you change the MTU size—you do not need to explicitly issue this command.

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 t
switch(config)# interface fc 1/23
switch(config-if)# switchport description techdocsSample
switch(config-if)# switchport mode E
switch(config-if)# switchport trunk mode auto
switch(config-if)# switchport trunk allowed vsan all
switch(config-if)# switchport trunk allowed vsan 3
switch(config-if)# switchport trunk allowed vsan add 2
switch(config-if)# switchport encap eisl
switch(config-if)# switchport fcrxbbcredit performance-buffers 45
switch(config-if)# switchport proxy-initiator nWWN 11:11:11:11:11:11:11:11 pwwn 
22:22:22:22:22:22:22:22	
switch(config-if)# no switchport proxy-initiator nWWN 11:11:11:11:11:11:11:11 pwwn 
22:22:22:22:22:22:22:22	 
Related Commands

Command

Description

show interface fc

Displays an interface configuration for a specified Fibre Channel 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 t 
switch(config)# interface gigabitethernet 8/1
switch(config-if)# switchport auto-negotiate 
The following example disable auto-negotiation on a Gigabit Ethernet interface.
switch(config-if)# no switchport auto-negotiate 
Related Commands

Command

Description

show interface gigabitethernet

Displays an interface configuration for a specified Gigabit Ethernet interface.

switchport ingress-rate

To configure the port rate limit for a specified interface, use the switchport ingress-rate command in 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

limit

Specifies the ingress rate limit as a percentage. The range is 1 to 100.

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 hold true:

•The QoS feature is enabled using the qos enable command.

•The command is issued in a Cisco MDS 9100 series switch.

Examples

The following example configures the ingress rate limit on a Fibre Channel interface.
switch# config t
switch(config)# interface fc 2/5
switch(config-if)# switchport ingress-rate 5
Related Commands

Command

Description

show interface fc

Displays an interface configuration for a specified Fibre Channel interface.

switchport initiator id

To identify the iSCSI initiator, use the switchport initiator id command in configuration mode. Use the no form of the command to delete the configured switchport information.

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
switch# config t
switch(config)# interface iscsi 2/5
switch(config-if)# switchport initiator id ip-address 
switch(config-if)# switchport initiator name
Related Commands

Command

Description

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 configuration mode. Use the no form of the command to delete the configured switchport information.

switchport promiscuous-mode {off | on}
no switchport promiscuous-mode
Syntax Description

off

Disables promiscuous mode.

on

Enables promiscuous mode.

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 t
switch(config)# interface gigabitethernet 8/1
switch(config-if)# switchport promiscuous-mode on
The following example disables promiscuous mode on a Gigabit Ethernet interface.
switch(config-if)# switchport promiscuous-mode off
The following example disables promiscuous mode on a Gigabit Ethernet interface.
switch(config-if)# no switchport promiscuous-mode 
Related Commands

Command

Description

show interface gigabitethernet

Displays an interface configuration for a specified Gigabit Ethernet 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 this command.

system cores {slot0: | tftp:}
no system cores
Syntax Description

slot0

Selects destination file system.

tftp:

Selects destination file system.

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 t
switch(config)# system cores slot0:coreSample
The following example disables periodic copying core and log files.
switch(config)# no system cores
switch(config)# 
Related Commands

Command

Description

show system cores

Displays the currently configured scheme for copying cores.

system default switchport

To configure default values for various switchport attributes, use the system default switchport command in configuration mode.

system default switchport [shutdown] [trunk mode auto | off | on]
Syntax Description

shutdown

(Optional) Disables or enables switch ports by default.

trunk

(Optional) Configures trunking parameters as a default.

mode

(Optional) Configures trunking mode.

auto

(Optional) Sets autosense trunking.

off

(Optional) Disables trunking.

on

(Optional) Enables trunking.

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 t
switch(config)# system default switchport shutdown
switch(config-if)# 
switch(config)# no system default switchport shutdown
switch(config-if)#
switch(config)# system default switchport trunkmode auto
switch(config-if)# 
Related Commands

Command

Description

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-reset 
system 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

interface

Specifies the interface to be configured.

fc slot/port

Configures the Fiber Channel interface.

iscsi slot/port

Selects the iSCSI interface to configure.

loopback

Configure the OHMS loopback test.

frequency seconds

Specifies the loopback frequency in seconds loopback frequency ranging from 5 seconds (default) to 255 seconds.

failure-action

Prevents the SAN-OS software from taking any OHMS action for the entire switch.

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 terminal
switch(config)# no system health
System Health is disabled.
The following example enables (default) OHMS in this switch.
switch(config)# system health
System Health is enabled.
The following example enables OHMS in this interface.
switch(config)# no system health interface fc8/1
System health for interface fc8/13 is enabled.
The following example disables OHMS in this interface.
switch(config)# system health interface fc8/1
System 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 50
The new frequency is set at 50 Seconds.
The following example prevents the switch from taking any failure action.
switch(config)# system health failure-action
System 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-action
System 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

interface

Specifies the interface to be configured.

fc slot/port

Configures the Fiber Channel interface.

iscsi slot/port

Selects the iSCSI interface to configure.

module slot

Specifies the required module in the switch,

battery-charger

Configure the OHMS battery-charger test on the specified module

bootflash

Configures the OHMS bootflash test on the specified module.

cache-disk

Configures the OHMS cache-disk test on the specified module.

eobc

Configures the OHMS EOBC test on the specified module.

inband

Configures the OHMS inband test on the specified module.

loopback

Configures the OHMS loopback test on the specified module.

mgmt

Configures the OHMS management port test on the specified module.

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/1
The following example clears the error history for the specified module:
switch# system health clear-errors interface module 3
The following example clears the management port test error history for the specified module:
switch# system health clear-errors module 2 mgmt
system 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/1
This will shut the requested interfaces Do you want to continue (y/n)?  [n] y
External 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 force
External 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/1
Internal loopback test on interface iscsi8/1 was  successful.
Round trip time taken is 79 useconds
system 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

module slot

Specifies the required module in the switch,

battery-charger

Configure the OHMS battery-charger test on the specified module

frequency seconds

Specifies the loopback frequency in seconds loopback frequency ranging from 5 seconds (default) to 255 seconds.

failure-action

Prevents the SAN-OS software from taking any OHMS action for the specified module.

bootflash

Configures the OHMS bootflash test on the specified module.

cache-disk

Configures the OHMS cache-disk test on the specified module.

eobc

Configures the OHMS EOBC test on the specified module.

inband

Configures the OHMS inband test on the specified module.

loopback

Configures the OHMS loopback test on the specified module.

mgmt

Configures the OHMS management port test on the specified module.

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 t
switch(config)# system health module 8 battery-charger
battery-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-disk
cache-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 bootflash
System 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-action
System 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-action
System 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-action
System 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 200
The new frequency is set at 200 Seconds.
The following example enables the EOBC test on Module 8.
switch(config)# system health module 8 eobc
System health for module 8 EOBC is now enabled.
The following example enables the inband test on Module 8.
switch(config)# system health module 8 inband
System health for module 8 EOBC is now enabled.
The following example enables the loopback test on Module 8.
switch(config)# system health module 8 loopback
System health for module 8 EOBC is now enabled.
The following example enables the management test on Module 8.
switch(config)# system health module 8 management
System 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 heartbeat 
system 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 memlog 
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 reset 
system 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.

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 switchover 
Related Commands

Command

Description

show version compatibility

Determines version compatibility between switching modules.

show module

Displays the HA-standby state for the standby supervisor module.

show system redundancy status

Determines whether the system is ready to accept a switchover.

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

ha

Specifies HA switchover.

warm

Specifies warm switchover.

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 t
switch(config)# system switchover ha
system trace

To configure the system trace level, use the system trace command in configuration mode. Use the no form of this command to disable this feature.

system trace bit-mask
no system trace
Syntax Description

bit-mask

Specifies the bit mask to change the trace level.

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 t
switch(config)# system trace 0xff
system watchdog

To enable watchdog checks, use the system watchdog command in EXEC mode. Use the no form of this command to disable this feature.

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 