FeedbackTable Of Contents
C Commands
The commands in this chapter apply to the Cisco MDS 9000 Family of multilayer directors and fabric switches. All commands are shown here in alphabetical order regardless of command mode. See the "About the CLI Command Modes" section to determine the appropriate mode for each command. For more information, refer to the Cisco MDS 9000 Family Configuration Guide.
•
cd
•
•
callhome
To configure the callhome function, use the callhome command in configuration mode. To set a command back to its factory defaults or negate the command, use the no form of the command.
callhome [customer-id customer-id] [contract-id contract-id] [destination-profile full-txt-destination email-addr email-address | message-size size] [destination-profile short-txt-destination email-addr email-address | message-size size] [destination-profile XML-destination email-addr email-address | message-size size] [disable] [email-contact email-address] [enable] [phone-contact number] [site-id site number] [streetaddress street number, city, state, zip] [switch-priority priority value] [transport email from email-address |reply-to email-address | smtp-server ip address port port-number]
no callhome [customer-id customer-id] [contract-id contract-id] [destination-profile full-txt-destination email-addr email-address | message-size size] [destination-profile short-txt-destination email-addr email-address | message-size size] [destination-profile XML-destination email-addr email-address | message-size size] [disable] [email-contact email-address] [enable] [phone-contact number] [site-id site number] [streetaddress street number, city, state, zip] [switch-priority priority value] [transport email from email-address |reply-to email-address | smtp-server ip address port port-number]
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
The CallHome configuration commands available in the (config-callhome) submode.
A CallHome message is used to contact a support person or organization in case an urgent alarm is raised.
Once you have configured the contact information, you must enable the Call Home function. The enable command is required for the Call Home function to start operating. When you disable the Call Home function, all input events are ignored.
Note
Examples
The following examples assign contact informations:
switch# config tswitch# snmp-server contact personname@companyname.comswitch(config)# callhomeswitch(config-callhome)# email-contact username@company.comsuccessfully updated the informationswitch(config-callhome)# phone-contact +1-800-123-4567successfully updated the informationswitch(config-callhome)# streetaddress 1234 Picaboo Street, Any city, Any state, 12345successfully updated the informationswitch(config-callhome)# switch-priority 0successfully updated the informationswitch(config-callhome)# customer-id Customer1234successfully updated the informationswitch(config-callhome)# site-id Site1ManhattanNYsuccessfully updated the informationswitch(config-callhome)# contract-id Company1234successfully updated the informationThe following example configures full-text destination profiles:
switch(config-callhome)# destination-profile full-txt-destination email-addr person@place.comsuccessfully updated the informationswitch(config-callhome)# destination-profile full-txt-destination message-size 1000000successfully updated the informationThe following example configures short-text destination profiles:
switch(config-callhome)# destination-profile short-txt-destination email-addr person@place.comsuccessfully updated the informationswitch(config-callhome)# destination-profile short-txt-destination message-size 100000successfully updated the informationThe following example configures the from and reply-to e-mail addresses:
switch(config-callhome)# transport email from user@company1.comsuccessfully updated the informationswitch(config-callhome)# transport email reply-to person@place.comsuccessfully updated the informationThe following example configures the SMTP server and ports:
switch(config-callhome)# transport email smtp-server 192.168.1.1successfully updated the informationswitch(config-callhome)# transport email smtp-server 192.168.1.1 port 30successfully updated the informationThe following example enables and disables the CallHome function:
switch(config-callhome)# enablecallhome enabled successfullyswitch(config-callhome)# disableRelated Commands
callhome test
To simulate a CallHome message generation, use the callhome test command.
callhome test [inventory]
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
You can simulate a message generation by issuing a test command.
Examples
The following example sends a test message to the configured destination(s):
switch# callhome testtrying to send test callhome messagesuccessfully sent test callhome messageThe following example sends a test inventory message to the configured destination(s)switch# callhome test inventorytrying to send test callhome messagesuccessfully sent test callhome messageRelated Commands
callhome
Configures CallHome functions.
show callhome
Displays configured Call Home information.
cd
To change the default directory or file system, use the cd command.
cd {directory | bootflash:[directory] | slot0:[directory] | volatile:[directory]}
Syntax Description
Defaults
The initial default file system is flash:. For platforms that do not have a physical device named flash:, the keyword flash: is aliased to the default Flash device.
If you do not specify a directory on a file system, the default is the root directory on that file system.
Command Modes
EXEC mode
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
For all EXEC commands that have an optional file system argument, the system uses the file system specified by the cd command when you omit the optional file system argument. For example, the dir command, which displays a list of files on a file system, contains an optional file system argument. When you omit this argument, the system lists the files on the file system specified by the cd command.
Examples
The following example sets the default file system to the Flash memory card inserted in slot 0:
switch# pwdbootflash:/switch# cd slot0:switch# pwdslot0:/Related Commands
cdp
Use the cdp command to globally configure the Cisco Discovery Protocol parameters. Use the no form of this command to revert to factory defaults.
cdp enable | advertise version | holdtime holdtime-seconds | timer timer-seconds
no cdp enable | advertise version | holdtime holdtime-seconds | timer timer-seconds
Syntax Description
Defaults
None.
Command Modes
Configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.1(1).
Usage Guidelines
Use the cdp enable command to enable the Cisco Discovery Protocol (CDP) feature at the switch level or at the interface level. Use the no form of this command to disable this feature. When the interface link is established, CDP is enabled by default
CDP version 1 (v1) and version 2 (v2) are supported in Cisco MDS 9000 Family switches. CDP packets with any other version number are silently discarded when received.
Examples
The following example disables the CDP protocol on the switch. When CDP is disabled on an interface, one packet is sent to clear out the switch state with each of the receiving devices.
switch(config)# no cdp enableOperation in progress. Please check global parametersswitch(config-console)#The following example enables (default) the CDP protocol on the switch. When CDP is enabled on an interface, one packet is sent immediately. Subsequent packets are sent at the configured refresh timeswitch(config)# cdp enableOperation in progress. Please check global parametersswitch(config)#The following example configures the Gigabit Ethernet interface 8/8 and disables the CDP protocol on this interface. When CDP is disabled on an interface, one packet is sent to clear out the switch state with each of the receiving devices.
switch(config)# interface gigbitethernet 8/8switch(config-if)# no cdp enableOperation in progress. Please check interface parametersswitch(config-console)#The following example enables (default) the CDP protocol on the selected interface. When CDP is enabled on this interface, one packet is sent immediately. Subsequent packets are sent at the configured refresh time.
switch(config-if)# cdp enableOperation in progress. Please check interface parametersswitch(config)#The following example globally configures the refresh time interval for the CDP protocol in seconds. The default is 60 seconds and the valid range is from 5 to 255 seconds.
switch# config terminalswitch(config)# cdp timer 100switch(config)#The following example globally configures the hold time advertised in CDP packet in seconds. The default is 180 seconds and the valid range is from 10 to 255 seconds.
sswitch# config terminalswitch(config)# cdp holdtime 200switch(config)#The following example globally configures the CDP version. The default is version 2 (v2). The valid options are v1 and v2
switch# config terminalswitch(config)# cdp advertise v1switch(config)#Related Commands
clear cdp
Clears global or interface-specific CDP configurations.
show cdp
Displays configured CDP settings and prameters.
clear arp-cache
To clear the arp-cache table entries, use the clear arp-cache command in EXEC mode.
clear arp-cache
Syntax Description
This command has no arguments or keywords.
Defaults
The ARP table is empty by default.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Examples
The following example shows how to clear the arp-cache table entries.
switch# clear arp-cacheRelated Commands
clear cdp
Use the clear cdp command to delete global or interface-specific CDP configurations.
clear cdp counters [ interface (gigabitethernet slot-port | mgmt 0 ) ] | table [ interface (gigabitethernet slot-port | mgmt 0 ) ]
Syntax Description
Defaults
None.
Command Modes
Configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.1(1).
Usage Guidelines
You can issue this command for a specified interface or for all interfaces (management and Gigabit Ethernet interfaces)
Examples
The following example clears CDP traffic counters for all interfaces.
switch# clear cdp countersswitch#The following example clears CDP entries for the specified Gigabit Ethernet interface.
switch# clear cdp table interface gigabitethernet 4/1switch#Related Commands
cdp
Configures global or interface-specific CDP settings and prameters.
show cdp
Displays configured CDP settings and parameters.
clear cores
To clear all core dumps for the switch, use the clear cores command in EXEC mode.
clear cores
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
The system software keeps the last few cores per service and per slot and clears all other cores present on the active supervisor module.
Examples
The following example shows how to clear all core dumps for the switch.
switch# clear coresRelated Commands
clear counters
To clear the counters, use the clear counters command in EXEC mode.
clear counters {statistics vrrp | interface {fc | mgmt | port-channel | sup-fc | vsan} number}
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
The following table lists the keywords and number ranges for the clear counters interface types:
Examples
The following example shows how to clear global virtual router statistics.
switch# clear counters statistics vrrpswitch# clear counters interface vsan 13clear debug-logfile
To clear the debug logfile, use the clear debug-logfile command in EXEC mode.
clear debug-logfile filename
Syntax Description
Command Modes
EXEC.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Examples
The following example shows how to clear the debug logfile.
switch# clear debug-logfileclear fcanalyzer
To clear the entire list of configured hosts for remote capture, use the clear fcanalyzer command in EXEC mode.
clear fcanalyzer
Syntax Description
This command has no arguments or keywords.
Command Modes
EXEC.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
This command clears only the list of configured hosts. Existing connections are not terminated.
Examples
The following example shows how to clear the entire list of configured hosts for remote capture.
switch# clear fcanalyzerRelated Commands
clear fcflow stats
To clear Fibre Channel flow counters, use the clear fcflow stats command in EXEC mode.
clear fcflow stats {aggregated | module module-number | index flow-number}
Syntax Description
aggregated
Clears fcflow aggregated statistics.
module
Clears statistics for a specified module.
index
Clears fcflow counters for a specified flow index.
flow-number
Specifies flow index number.
Command Modes
EXEC.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Examples
The following example shows how to clear aggregated Fibre Channel flow statistics for flow index 1 of module 2.
switch(config)# # clear fcflow stats aggregated module 2 index 1Related Commands
clear fcns statistics
To clear the name server statistics, use the clear fcns statistics command in EXEC mode.
clear fcns statistics [vsan vsan-id]
Syntax Description
Command Modes
EXEC.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Examples
The following example shows how to clear the name server statistics.
switch# show fcns statisticsName server statistics for vsan 1===================================registration requests received = 0deregistration requests received = 0queries received = 23queries sent = 27reject responses sent = 23RSCNs received = 0RSCNs sent = 0switch# clear fcns statisticsswitch# show fcns statisticsName server statistics for vsan 1===================================registration requests received = 0deregistration requests received = 0queries received = 0queries sent = 0reject responses sent = 0RSCNs received = 0RSCNs sent = 0switch#Related Commands
clear fcs statistics
To clear the fabric configuration server statistics, use the clear fcs statistics command in EXEC mode.
clear fcs statistics [vsan vsan-id]
Syntax Description
vsan
FCS statistics are to be cleared for a specified VSAN.
vsan-id
The ID of the VSANs are from 1 to 4093.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Examples
The following example shows how to clear the fabric configuration server statistics.
switch# clear fcs statisticsRelated Commands
clear fspf counters
To clear the Fabric Shortest Path First statistics, use the clear fspf counters command in EXEC mode.
clear fspf counters vsan vsan-id [interface type]
Syntax Description
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
If the interface is not specified, then all of the counters of a VSAN are cleared. If the interface is specified, then the counters of the specific interface are cleared.
Examples
The following example clears the FSPF t statistics on VSAN 1.
switch# clear fspf counters vsan 1The following example clears FSPF statistics specific to the Fibre Channel interface in VSAN 1, Slot 9 Port 32.
switch# clear fspf counters vsan 1 interface fc 9/32Related Commands
clear ips arp
To clear ARP caches, use the clear ips arp command in EXEC mode.
clear ips arp {address ip-address| interface gigabitethernet module-number}
Syntax Description
Command Modes
EXEC.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.1(1).
Examples
The ARP cache can be cleared in two ways: clearing just one entry or clearing all entries in the ARP cache.
The following example clears one ARP cache entry:
switch# clear ips arp address 10.2.2.2 interface gigabitethernet 8/7arp clear successfulThe following example clears all ARP cache entries
switch# clear ips arp interface gigabitethernet 8/7arp clear successfulclear ntp statistics
To clear Network Time Protocol statistics, use the clear ntp statistics command in EXEC mode.
clear ntp statistics {all-peers | io | local | memory}
Syntax Description
all-peers
Clears I/O statistics for all peers.
io
Clears I/O statistics for I/O devices.
local
Clears I/O statistics for local devices.
memory
Clears I/O statistics for memory.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
None mode.
Examples
The following example shows how to clear NTP statistics for all peers.
switch# clear ntp statistics all-peersThe following example shows how to clear NTP statistics for I/O devices.
switch# clear ntp statistics ioThe following example shows how to clear NTP statistics for local devices.
switch# clear ntp statistics localThe following example shows how to clear NTP statistics for memory.
switch# clear ntp statistics memoryRelated Commands
clear processes log
To clear the log files on the switch, use the clear processes log command in EXEC mode.
clear processes log {all | pid pid-number}
Syntax Description
all
Deletes all of the log files.
pid
Deletes the log files of a specific process.
pid-number
Specifies the process ID, which must be from 0 to 2147483647.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
None.
Examples
The following examples show how to clear all of the log files on the switch.
switch# clear processes log allRelated Commands
show processes
Displays the detailed running or log information of processes or high availability applications.
clear qos statistics
To clear the quality of services statistics counters, use the clear qos statistics command in EXEC mode.
clear qos statistics
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
None.
Examples
The following examples shows how to clear the quality of service counters.
switch# clear qos statisticsRelated Commands
show qos statistics
Displays the current QoS settings, along with a number of frames marked high priority.
clear rscn statistics
To clear the registered state change notification statistics for a specified VSAN, use the clear rscn statistics command in EXEC mode.
clear rscn statistics vsan vsan-id
Syntax Description
vsan
The RSCN statistics are to be cleared for a VSAN.
vsan-id
The ID for the VSAN for which you want to clear RSCN statistics.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
None.
Examples
The following example shows how to clear rcsn statistics for VSAN 1.
switch# clear rscn statistics 1Related Commands
clear screen
To clear the terminal screen, use the clear screen command in EXEC mode.
clear screen
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
None.
Examples
The following example shows how to clear the terminal screen.
switch# clear screenclear vrrp
To clear all the software counters for the specified virtual router, use the clear vrrp command in EXEC mode.
clear vrrp number interface type [vsan-id | mgmt-int]
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
None.
Examples
The following examples shows how to clear all the software counters for virtual router 7 on VSAN 2.
switch# clear vrrp 7 interface vsan2Related Commands
clear zone
To clear all configured information in the zone server for a specified VSAN, use the clear zone command in EXEC mode.
clear zone {database | statistics} vsan vsan-id
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
After issuing a clear zone database command, you need to explicitly issue the copy running-config startup-config to ensure that the running configuration is used when you next start the switch.
Examples
The following examples shows how to clear all configured information in the zone server for VSAN 1.
switch# clear zone database vsan 1Related Commands
clock
To configure the time zone and the summer time of day, use the clock command in configuration mode. To disable the daylight saving time adjustment, use the no form of this command.
clock {summer-time | time-zone daylight-timezone-name start-week start-day start-month start-time end-week end-day end-month end-time daylight-offset-to-be-added-in-minutes}
no clock {summer-time | time-zone daylight-timezone-name start-week start-day start-month start-time end-week end-day end-month end-time daylight-offset-to-be-added-in-minutes}
Syntax Description
Defaults
Coordinated Universal Time (UTC), which is the same as Greenwich Mean Time (GMT).
Command Modes
Configuration mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
Use this command if you need to change the UTC or GMT time or time zone.
Examples
The following example shows how to configure the time zone and summer time of day.
switch# config tswitch(config)# clock timezone <daylight timezone name> <start week> <start day> <start month> <start time> <end week> <end day> <end month> <end time> <daylight offset to be added in minutes>switch(config)# clock summer-time Pacific 1 Sun Apr 02:00 5 Sun Oct 02:00 60switch(config)# no clock summer-timeswitch(config)# exitswitch#Related Commands
clock set
To change the default time on a Cisco MDS 9000 Family switch, use the clock set command in EXEC mode.
clock set HH:MM:SS DD Month YYYY
Syntax Description
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
Generally, if the system is synchronized by a valid outside timing mechanism, such as an NTP clock source, or if you have a switch with calendar capability, you do not need to set the system clock. Use this command if no other time sources are available. The time specified in this command is relative to the configured time zone.
The clock set command changes are saved across system resets.
Examples
The following example displays the clock set command:
switch# clock set 15:58:15 12 August 2002Mon Aug 12 15:58:00 PDT 2002
configure terminal
To entr the configuration mode, use the configure terminal command in EXEC mode.
configure terminal
Syntax Description
This command has no arguments or keywords.
Defaults
None.
Command Modes
EXEC mode.
Command History
This command was introduced in Cisco MDS SAN-OS Release 1.0(2).
Usage Guidelines
None.
Examples
The following example enters the configuration mode:
switch# conf tswitch(config)#copy
To save a backup of the system software, use the copy command in EXEC mode.
copy source-URL destination-URL
Syntax Description
source-URL
The location URL or alias of the source file or directory to be copied.
destination-URL
The destination URL or alias of the copied file or directory.
The following table lists the aliases for source and destination URLs.
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 makes the running and the backup copy of the software identical.
A file can only be copied from an active supervisor to a standby supervisor, not from standby to active.
This command does not allow 127.x.x.x IP addresses.
The copy function will not be completed if the required space is not available in the directory. First change to the required directory (for example, cd bootflash:) and verify the available space (for example, dir bootflash:).
The entire copying process may take several minutes.
Do not copy a file from an external source directly to the standby supervisor. You must copy from the external source to the active supervisor, and then copy the saved file to the standby supervisor.
Examples
The following example saves your configuration to the startup configuration.
switch# copy system:running-config nvram:startup-configThe following example copies the file called samplefile from the slot0 directory to the mystorage directory.
switch# copy slot0:samplefile slot0:mystorage/samplefileThe following example copies a file from the current directory level.switch# copy samplefile mystorage/samplefileIf the current directory is slot0:mydir, this command copies slot0:mydir/samplefile to slot0:mydir/mystorage/samplefile.The following command downloads a configuration file from an external CompactFlash to the running configuration.
switch copy slot0:dns-config.cfg system:running-configThe following command downloads a configuration file from an external CompactFlash to the startup configuration.
switch# copy slot0:dns-config.cfg nvram:startup-configThe following command saves a running configuration file to an external CompactFlash.
switch# copy system:running-config slot0:dns-config.cfgThe following command saves a startup configuration file to an external CompactFlash.
switch# copy system:startup-config slot0:dns-config.cfgThe following example creates a copy of the binary configuration in NVRAM.
switch# copy system:running-config nvram:startup-configThe following example creates a backup copy of the binary configuration.
switch# copy nvram:startup-config nvram:snapshot-configThe following example overwrites the contents of an existing configuration in NVRAM.
switch# copy nvram:snapshot-config nvram:startup-configWarning: Snapshot file is going to override the current startup-config. Do you wish to proceed anyway? {y/n} [y] yThe following example copies an image in bootflash on the active supervisor to the bootflash on the standby supervisor.
switch# copy bootflash:myimage bootflash://sup-2/myimageThe following example creates a running configuration copy in bootflash.
switch# copy system:running-config bootflash:my-configThe following examples creates a startup configuration copy in bootflash.
switch# copy nvram:startup-config bootflash:my-configRelated Commands