FeedbackTable Of Contents
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
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
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 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): yessleep
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
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-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-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 community string] [ro | rw] [contact name-string] [location location] [user name group auth md5 password priv password | sha password priv password]
no snmp-server [community snmp community string] [ro | rw] [contact name-string] [location location] [user name group auth md5 password priv password | sha password priv password | localizedkey]
Syntax Description
Defaults
The default is read-only (ro).
Command Modes
Configuration mode
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
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.
Examples
The following example sets the contact information, switch location, and switch name.
switch# config tswitch(config)# snmp-server contact NewUserswitch(config)#switch(config)# no snmp-server contact NewUserswitch(config)#switch(config)# snmp-server location SanJoseswitch(config)#switch(config)# no snmp-server location SanJoseswitch(config)#switch(config)# snmp-server name NewNameswitch(config)#switch(config)# no snmp-server name NewNameswitch(config)#switch(config)# snmp-server user joe network-admin auth sha abcd1234switch(config)#switch(config)# snmp-server user sam network-admin auth md5 abcdefghswitch(config)#switch112(config)# snmp-server user Bill network-admin auth sha abcd1234 priv abcdefghswitch112(config)#switch112(config)# no snmp-server user usernameAswitch112(config)# snmp-server user user1 network-admin auth md5 0xab0211gh priv 0x45abf342 localizedkeysnmp-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]
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.
Though you can set the community-string using the snmp-server host command by itself, we recommend you define this string using the snmp-server community command prior to using the snmp-server host command.
Examples
The following example specify the recipient of an SNMP notification.
switch# config tswitch(config)# snmp-server host 10.1.1.1 traps version 2c abcddsfsf udp-port 500span 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-number | source [ rx | tx] | interface fc slot-number| port-channel port-channel-number | sup-fc inband-interface-number |] | suspend}
no span session session-id {destination interface fc slot-number | source [ rx | tx] | interface fc slot-number| port-channel port-channel-number | sup-fc inband-interface-number |] | suspend}
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
None.
Examples
The following example shows how to configure a SPAN session.
switch# config tswitch(config)# span session 1switch(config-span)#switch(config)# no span session 6switch(config-span)# destination interface fc9/1switch(config-span)# no destination interface fc1/5switch(config-span)# source interface sup-fc0switch(config-span)# source vsan1switch(config-span)# source interface po1switch(config-span)# no source interface po3switch(config-span)# suspendswitch(config-span)# no suspendswitch(config-span)# exitswitch(config)# span session 1switch(config-span)#switch(config-span)# source interface fc9/1 tx filter vsan 1switch(config-span)# source filter vsan 1-2Related Commands
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
no special-frame peer-wwn pwwn-id
Syntax Description
special-frame
Configures special frames.
peer-wwn
Configures the peer WWN for special frames.
pwwn-id
Enters the peer pWWN ID.
Defaults
Disabled
Command Modes
Configuration mode
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
switch# config tswitch(config)# interface fcip 1switch(config)# peer-info ipaddr 10.1.1.1switch(config)# peer-info ipaddr 10.1.1.1 port 4000switch(config)# no peer-info ipaddr 10.1.1.1 port 4000Related Commandss
show interface fcip
Displays an interface configuration for a specified FCIP interface.
ssh key
To generate a host key, use the ssh key command in configuration mode.
ssh key {dsa number | rsa number | rsa1 number}
Syntax Description
dsa
Generates a DSA key.
rsa
Generates an RSA key.
rsa1
Generates an RSA1 key.
number
Specifies a number of bits from 768 to 2048.
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 shows how to generate a host key.
switch# config tswitch(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 key rsa 1024cleared RSA keysswitch(config)#Related Commands
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 tswitch(config)# ssh server enableupdatedswitch(config)# no ssh server enableupdatedRelated Commands
switchname
To change the name of the switch, use the switchname command in configuration mode. To revert the switch name to the default name, use the no form of the command.
switchname name
no switchname name
Syntax Description
Defaults
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 changes the name of the switch to myswitch1.
switch# config tswitch(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 assign the port mode, allowed VSAN numbers, or the description of an FCIP interface, use the switchport command in the interface fcip mode. Use the no form of the command to delete the configured switchport information.
switchport [description text] | [mode auto | E] | [trunk allowed vsan number | add vsan number | all]
no switchport [description text] | [mode auto | E] | [trunk allowed vsan number | add vsan number | all]
Syntax Description
Defaults
Disabled
Command Modes
Configuration mode.
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
switch## config tswitch(config)# interface fcip 1switch(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 2Related Commands
show interface fcip
Displays an interface configuration for a specified FCIP 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 [description text] | [initiator id ip-address | name ]
no switchport [description text] | [initiator id ip-address | name ]
Syntax Description
Defaults
Disabled
Command Modes
Configuration mode.
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
switch## config tswitch(config)# interface iscsi 2/5switch(config-if)# switchport description techdocs sampleswitch(config-if)# switchport initiator id ip-addressswitch(config-if)# switchport initiator nameRelated Commands
show interface fcip
Displays an interface configuration for a specified FCIP interface.
system auto-sync
To synchronize the standby supervisor module software image with the bootflash image, use the system auto-sync command in configuration mode. To disable auto syncing of the image, use the no form of this command.
system auto-sync image
no system auto-sync image
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
None.
Examples
The following example shows how to synchronize the standby supervisor module software image with the bootflash image.
switch# config tswitch(config)# system auto-sync imageswitch(config)# no system auto-sync image Automatic synchronization of BOOT and KICKSTART is now disabledswitch(config)#system cores
To copy 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
Defaults
None.
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 copies the core and log files.
switch# config tswitch(config)# system cores slot0:coreSampleswitch(config)#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.
system default switchport [shutdown] [trunk mode auto | off | on]
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 tswitch(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 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 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
To specifically initiate a switchover from an active supervisor module to a standby supervisor module, use the system switchover command in configuration mode.
system switchover {ha | warm}
Syntax Description
Defaults
system switchover ha
Command Modes
EXEC
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
Perform a switchover when the switch has two supervisor modules functioning in the switch. The system switchover command returns a Failed to switchover: (supervisor has no standby) message when the standby supervisor is not present in the switch.
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# config tswitch(config)# system switchover HARelated Commands
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
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 tswitch(config)# system trace bit-masksystem upgrade-reset
To enable a supervisor module reset, use the system upgrade-reset command in EXEC mode. Use the no form of this command to disable this feature.
system upgrade-reset
system no upgrade-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
This feature enables supervisor module resets when an upgrade has failed. If the upgrade fails for any reason, the software reboots the switch since the file system may be in an unstable state.
You can disable the upgrade-reset feature (enabled by default) for debugging and troubleshooting purposes.
Examples
The following example enables the supervisor reset HA policy.
switch# system upgrade-resetsystem 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