Cisco MDS 9000 Family Command Reference, Release 2.x
C Commands

Table Of Contents

C Commands

callhome

callhome test

cd

cdp

cfs distribute

channel mode active

cimserver

class

clear accounting log

clear arp-cache

clear callhome session

clear cdp

clear cores

clear counters (EXEC mode)

clear counters (SAN extension N port configuration mode)

clear crypto ike domain ipsec sa

clear crypto sa domain ipsec

clear debug-logfile

clear device-alias

clear dpvm

clear fabric-binding statistics

clear fcanalyzer

clear fcflow stats

clear fcns statistics

clear fcs statistics

clear fctimer session

clear ficon

clear fspf counters

clear ip access-list counters

clear ips arp

clear ivr fcdomain database

clear ivr zone database

clear license

clear line

clear logging

clear ntp

clear port-security

clear processes log

clear qos statistics

clear radius session

clear rlir

clear role session

clear rscn statistics

clear scheduler logfile

clear screen

clear scsi-flow statistics

clear ssh hosts

clear system reset-reason

clear tacacs+ session

clear tlport alpa-cache

clear user

clear vrrp

clear zone

clock

code-page

clock set

code-page

commit

contract-id

configure terminal

copy

copy licenses

crypto global domain ipsec security-association lifetime

crypto ike domain ipsec

crypto ike domain ipsec rekey sa

crypto ike enable

crypto ipsec enable

crypto map domain ipsec (configuration mode)

crypto map domain ipsec (interface configuration submode)

crypto transform-set domain ipsec

customer-id


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.

callhome

To configure the Call Home function, use the callhome command.

callhome

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled.

Command Modes

Configuration mode.

Command History

Release
Modification

1.0(2)

This command was introduced.


Usage Guidelines

The Call Home configuration commands are available in the (config-callhome) submode.

A Call Home 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 Even if Call Home is disabled, basic information for each Call Home event is sent to syslog.


Examples

The following example assigns contact information.

switch# config terminal
config terminal
switch# snmp-server contact personname@companyname.com 
switch(config)# callhome
switch(config-callhome)# email-contact username@company.com
switch(config-callhome)# phone-contact +1-800-123-4567
switch(config-callhome)# streetaddress 1234 Picaboo Street, Any city, Any state, 12345
switch(config-callhome)# switch-priority 0
switch(config-callhome)# customer-id Customer1234 
switch(config-callhome)# site-id Site1ManhattanNY
switch(config-callhome)# contract-id Company1234 

Related Commands

Command
Description

callhome test

Sends a dummy test message to the configured destination(s).

show callhome

Displays configured Call Home information.


callhome test

To simulate a CallHome message generation, use the callhome test command.

callhome test [inventory]

Syntax Description

inventory

Sends a dummy CallHome inventory.


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 callhome test command.

Examples

The following example sends a test message to the configured destination(s):

switch# callhome test
trying to send test callhome message
successfully sent test callhome message

The following example sends a test inventory message to the configured destination(s)

switch# callhome test inventory
trying to send test callhome message
successfully sent test callhome message

Related Commands

Command
Description

callhome

Configures Call Home 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

directory

Name of the directory on the file system.

bootflash:

URI or alias of the bootflash or file system.

slot0:

URI or alias of the slot0 file system.

volatile:

URI or alias of the volatile file system.


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# pwd 
bootflash:/
switch# cd slot0: 
switch# pwd 
slot0:/

Related Commands

Command
Description

copy

Copies any file from a source to a destination.

delete

Deletes a file on a Flash memory device.

dir

Displays a list of files on a file system.

pwd

Displays the current setting of the cd command.

show file systems

Lists available file systems and their alias prefix names.

undelete

Recovers a file marked deleted on a Class A or Class B Flash file system.


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 {v1 | v2} | holdtime holdtime-seconds | timer timer-seconds}

no cdp {enable | advertise | holdtime holdtime-seconds | timer timer-seconds}

Syntax Description

enable

Enables CDP globally on all interfaces on the switch.

advertise

Specifies the EXEC command to be executed.

v1

Specifies CDP version 1.

v2

Specifies CDP version 2.

holdtime

Sets the hold time advertised in CDP packets.

holdtime-seconds

Specifies the holdtime in seconds. The default is 180 seconds and the valid range is from 10 to 255 seconds.

timer

Sets the refresh time interval.

timer-seconds

Specifies the time interval in seconds. The default is 60 seconds and the valid range is from 5 to 255 seconds.


Defaults

CDP is enabled.

The hold time default interval is 180 seconds.

The refresh time interval is 60 seconds.

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 enable
Operation in progress. Please check global parameters
switch(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 time
switch(config)# cdp enable
Operation in progress. Please check global parameters
switch(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/8
switch(config-if)# no cdp enable
Operation in progress. Please check interface parameters
switch(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 enable
Operation in progress. Please check interface parameters
switch(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 terminal
switch(config)# cdp timer 100
switch(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.

switch# config terminal
switch(config)# cdp holdtime 200
switch(config)# 	

The following example globally configures the CDP version. The default is version 2 (v2). The valid options are v1 and v2

switch# config terminal
switch(config)# cdp advertise v1
switch(config)# 

Related Commands

Command
Description

clear cdp

Clears global or interface-specific CDP configurations.

show cdp

Displays configured CDP settings and parameters.


cfs distribute

To enable or disable Cisco Fabric Services (CFS) distribution on the switch, use the cfs distribute command in configuration mode. To disable this feature, use the no form of the command.

cfs distribute

no cfs distribute

Syntax Description

This command has no other arguments or keywords.

Defaults

CFS distribution is enabled.

Command Modes

Configuration mode.

Command History

Release
Modification

2.1(1a)

This command was introduced.


Usage Guidelines

By default CFS is in the distribute mode. In the distribute mode, fabric wide distribution is enabled. Applications can distribute data/configuration to all CFS-capable switches in the fabric where the application exists. This is the normal mode of operation.

If CFS distribution is disabled, using the no cfs distribute command causes the following to occurs:

CFS and the applications using CFS on the switch are isolated from the rest of the fabric even though there is physical connectivity.

All CFS operations are restricted to the isolated switch.

All the CFS commands continue to work similar to the case of a physically isolated switch.

Other CFS operations (for example, lock, commit, and abort) initiated at other switches do not have any effect at the isolated switch.

Examples

The following example shows how to disable CFS distribution.

switch# config terminal
Enter configuration commands, one per line.  End with CNTL/Z.
switch(config)# no cfs distribute

The following example shows how to reenable CFS distribution.

switch# config terminal
Enter configuration commands, one per line.  End with CNTL/Z.
switch(config)# cfs distribute

Related Commands

Command
Description

show cfs status

Displays whether CFS distribution is enabled or disabled.


channel mode active

To enable channel mode on a PortChannel interface, use the channel mode active command. To disable this feature, use the no form of the command.

channel mode active

no channel mode

Syntax Description

This command has no other arguments or keywords.

Defaults

Enabled.

Command Modes

Interface configuration submode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

This command determines the protocol behavior for all the member ports in the channel group associated with the port channel interface.

Examples

The following example shows how to disable channel mode on a PortChannel interface.

switch# config terminal
switch(config)# interface port-channel 10
switch(config-if)# no channel mode active

Related Commands

Command
Description

show interface port-channel

Displays PortChannel interface information.


cimserver

Use the cimserver command to configure the Common Information Models (CIM) parameters. Use the no form of this command to revert to factory defaults.

cimserver
{certificate {bootflash:filename | slot0:filename | volatile:filename} |
clearcertificate filename |
enable |
enablehttp |
enablehttps}

no cimserver
{certificate {bootflash:filename | slot0:filename | volatile:filename} |
clearcertificate filename
enable
enablehttp
enablehttps}

Syntax Description

certificate

Installs the Secure Socket Layer (SSL) certificate

bootflash:

Specifies the location for internal bootflash memory.

slot0:

Specifies the location for the CompactFlash memory or PCMCIA card.

volatile:

Specifies the location for the volatile file system.

filename

The name of the license file with a .pem extension.

clearcertificate

Clears a previously-installed SSL certificate.

enable

Enables and starts the CIM server.

enablehttp

Enables the HTTP (non-secure) protocol for the CIM server—(default).

enablehttps

Enables the HTTPS (secure) protocol for the CIM server.


Defaults

None.

Command Modes

Configuration mode.

Command History

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

Usage Guidelines

A CIM client is required to access the CIM server. The client can be any client that supports CIM.

Examples

The following example installs a Secure Socket Layer (SSL) certificate specified in the file named with a .pem extension.

switch# config terminal
switch(config)# cimserver certificateName bootflash:simserver.pem

The following example clears the specified SSL certificate.

switch(config)# cimserver clearCertificateName bootflash:simserver.pem

The following example enables HTTPS (secure protocol).

switch(config)# cimserver enablehttps

The following example disables HTTPS (default).

switch(config)# no cimserver enablehttps

The following example

switch(config)# cimserver enable

The following example disables the CIM server (default).

switch(config)# no cimserver enable

The following example enables HTTP and reverts to the switch default.

switch(config)# cimserver enablehttp 

The following example disables HTTP and reverts to the switch default.

switch(config)# no cimserver enablehttp 

Related Commands

Command
Description

show csimserver

Displays configured CIM settings and parameters.


class

To select a QoS policy map class for configuration, use the class command in QoS policy map configuration submode. To disable this feature, use the no form of the command.

class class-map-name

no class class-map-name

Syntax Description

class-map-name

Selects the QoS policy class map to configure.


Defaults

Disabled

Command Modes

QoS policy map configuration submode

Command History

Release
Modification

1.3(1)

This command was introduced.


Usage Guidelines

Before you can configure a QoS policy map class you must complete the following:

Enable the QoS data traffic feature using the qos enable command.

Configure a QoS class map using the qos class-map command.

Configure a QoS policy map using the qos policy-map command.

After you configure the QoS policy map class, you can configure the Differentiated Services Code Point (DSCP) and priority for frames matching this class map.

Examples

The following example shows how to select a QoS policy map class to configure.

switch# config terminal 
Enter configuration commands, one per line.  End with CNTL/Z.
switch(config)# qos enable 
switch(config)# qos class-map class-map1
switch(config)# qos policy-map policyMap1
switch(config-pmap)# class class-map1
switch(config-pmap-c)#

Related Commands

Command
Description

qos enable

Enables the QoS data traffic feature on the switch.

qos class-map

Configures a QoS class map.

qos policy-map

Configures a QoS policy map.

dscp

Configures the DSCP in the QoS policy map class.

priority

Configures the priority in the QoS policy map class.

show qos

Displays the current QoS settings.


clear accounting log

To clear the accounting log, use the clear accounting log command.

clear accounting log

Syntax Description

This command has no other arguments or keywords.

Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

None.

Examples

The following example clears the accounting log.

switch# clear accouting session

Related Commands

Command
Description

show accounting log

Displays the accounting log contents.


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-cache

Related Commands

Command
Description

show arp

Displays Address Resolution Protocol (ARP) entries.


clear callhome session

To clear Call Home Cisco Fabric Services (CFS) session configuration and locks, use the clear callhome session command.

clear callhome session

Syntax Description

This command has no other arguments or keywords.

Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

None.

Examples

The following example shows how to clear the Call Home session configuration and locks.

switch# clear callhome session

Related Commands

Command
Description

show callhome

Displays Call Home information.


clear cdp

Use the clear cdp command to delete global or interface-specific CDP configurations.

clear cdp {counters | table} [interface {gigabitethernet slot/port | mgmt 0}]

Syntax Description

counters

Enables CDP on globally or on a per-interfaces basis.

table

Specifies the EXEC command to be executed.

interface

Displays CDP parameters for an interface.

gigabitethernet

Specifies the Gigabit Ethernet interface.

slot/port

Specifies the slot number and port number separated by a slash (/).

mgmt 0

Specifies the Ethernet management interface.


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 counters
switch#

The following example clears CDP entries for the specified Gigabit Ethernet interface.

switch# clear cdp table interface gigabitethernet 4/1
switch#

Related Commands

Command
Description

cdp

Configures global or interface-specific CDP settings and parameters.

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 cores

Related Commands

Command
Description

show cores

Displays core dumps that have been made.


clear counters (EXEC mode)

To clear the interface counters, use the clear counters command in EXEC mode.

clear counters {all | interface {fc | mgmt | port-channel | sup-fc | vsan} number}

Syntax Description

all

Clears all interface counters.

interface

Clears interface counters for the specified interface.

type

Specifies the interface type. See the Keywords table in the "Usage Guidelines" section.

number

Specifies the number of the slot or interface being cleared.


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:

Keyword
Interface Type
Number

fc

Fibre Channel

1- 2 or 1 - 9 (slot)

gigabitethernet

Gigabit Ethernet

1- 2 or 1 - 9 (slot)

mgmt

Management

0-0 (management interface)

port-channel

PortChannel

1-128 (PortChannel)

sup-fc

Inband

0-0 (Inband interface)

vsan

VSAN

1- 4093 (VSAN ID)


This command clears counter displayed in the show interface command output.

Examples

The following example shows how to clear counters for a VSAN interface.

switch# clear counters interface vsan 13

Related Commands

Command
Description
show interface

Displays interface information.


clear counters (SAN extension N port configuration mode)

To clear SAN extension tuner N port counters, use the clear counters command.

clear counters

Syntax Description

This command has no other arguments or keywords.

Defaults

None.

Command Modes

SAN extension N port configuration submode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

None.

Examples

The following example shows how to clear SAN extension tuner N port counters.

switch# san-ext-tuner
switch(san-ext)# nWWN 10:00:00:00:00:00:00:00
switch(san-ext)# nport pwwn 12:00:00:00:00:00:00:56 vsan 13 interface gigabitethernet 1/2
switch(san-ext-nport)# clear counters

Related Commands

Command
Description

show san-ext-tuner

Displays SAN extension tuner information.


clear crypto ike domain ipsec sa

To clear the IKE tunnels for IPsec, use the clear crypto ike domain ipsec sa command.

clear crypto ike domain ipsec sa [tunnel-id]

Syntax Description

tunnel-id

Specifies a tunnel ID. The range is 1 to 2147483647.


Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

To use this command, the IKE protocol must be enabled using the crypto ike enable command.

If the tunnel ID is not specified, all IKE tunnels are cleared.

Examples

The following example shows how to clear all IKE tunnels.

switch# clear crypto ike domain ipsec sa

Related Commands

Command
Description

crypto ike domain ipsec

Configures IKE information.

crypto ike enable

Enables the IKE protocol.

show crypto ike domain ipsec

Displays IKE information for the IPsec domain.


clear crypto sa domain ipsec

To clear the security associations for IPsec, use the clear crypto sa domain ipsec command.

clear crypto sa domain ipsec interface gigabitethernet slot/port {inbound | outbound}
sa sa-index

Syntax Description

interface gigabitethernet slot/port

Specifies the Gigabit Ethernet interface.

inbound

Specifies clearing inbound associations.

outbound

Specifies clearing output associations.

sa sa-index

Specifies the security association index. The range is 1 to 2147483647.


Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

To clear security associations, IPsec must be enabled using the crypto ipsec enable command.

Examples

The following example shows how to clear a security association for an interface.

switch# clear crypto sa domain ipsec interface gigabitethernet 1/2 inbound sa 1

Related Commands

Command
Description

show crypto sad domain ipsec

Displays IPsec security association database information.


clear debug-logfile

To delete the debug logfile, use the clear debug-logfile command in EXEC mode.

clear debug-logfile filename

Syntax Description

filename

The name (restricted to 80 characters) of the log file to be cleared. The maximum size of the log file is 1024 bytes.


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 debug logfile.

switch# clear debug-logfile debuglog

Related Commands

Command
Description

show debug logfilw

Displays the logfile contents.


clear device-alias

To clear device alias information, use the clear device-alias command.

clear device-alias {session | statistics}

Syntax Description

session

Clears session information.

statistics

Clears device alias statistics.


Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

None.

Examples

The following example shows how to clear the device alias session.

switch# clear device-alias session

Related Commands

Command
Description

show device-alias

Displays device alias database information.


clear dpvm

To clear Dynamic Port VSAN Membership (DPVM) information, use the clear dpvm command.

clear dpvm {auto-learn [pwwn pwwn-id] | session}

Syntax Description

auto-learn

Clears automatically learned (autolearn) DPVM entries.

pwwn pwwn-id

Specifies the pWWN ID. The format is hh:hh:hh:hh:hh:hh:hh:hh, where h is a hexadecimal number.

session

Clears the DPVM session and locks.


Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

To use this command, DVPM must be enabled using the dpvm enable command.

Examples

The following example shows how to clear a single autolearned entry.

switch# clear dpvm auto-learn pwwn 21:00:00:20:37:9c:48:e5

The following example shows how to clear all autolearn entries.

switch# clear dpvm auto-learn

The following example shows how to clear a session.

switch# clear dpvm session

Related Commands

Command
Description

dpvm enable

Enables DPVM.

show dpvm

Displays DPVM database information.


clear fabric-binding statistics

To clear fabric binding statistics in a FICON enabled VSAN, use the clear fabric-binding statistics command in EXEC mode.

clear fabric-binding statistics vsan vsan-id

Syntax Description

vsan vsan-id

Specifies the FICON-enabled VSAN. The ID of the VSAN is from 1 to 4093.


Defaults

None

Command Modes

EXEC mode

Command History

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

Usage Guidelines

None.

Examples

The following example clears existing fabric binding statistics in VSAN 1.

switch# clear fabric-binding statistics vsan 1

Related Commands

Command
Description

show fabric-binding efmd statistics

Displays existing fabric binding statistics information.



clear 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.

Defaults

None.

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 fcanalyzer 

Related Commands

Command
Description

show fcanalyzer

Displays the list of hosts configured for a remote capture.


clear fcflow stats

To clear Fibre Channel flow statistics, use the clear fcflow stats command in EXEC mode.

clear fcflow stats [aggregated] module module-number index flow-number

Syntax Description

aggregated

Clears the Fibre Channel flow aggregated statistics.

module

Clears the statistics for a specified module.

module-number

Specifies the module number.

index

Clears the Fibre Channel flow counters for a specified flow index.

flow-number

Specifies the flow index number.


Defaults

None.

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 1

Related Commands

Command
Description

show fcflow

Displays the fcflow statistics.


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

vsan vsan-id

FCS statistics are to be cleared for a specified VSAN ranging from 1 to 4093.


Defaults

None.

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 statistics

Name server statistics for vsan 1
===================================
registration requests received = 0
deregistration requests received = 0
queries received = 23
queries sent = 27
reject responses sent = 23
RSCNs received = 0
RSCNs sent = 0

switch# clear fcns statistics vsan 1

switch# show fcns statistics

Name server statistics for vsan 1
===================================
registration requests received = 0
deregistration requests received = 0
queries received = 0
queries sent = 0
reject responses sent = 0
RSCNs received = 0
RSCNs sent = 0
switch#

Related Commands

Command
Description

show fcns statistics

Displays the name server statistics.


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 vsan-id

FCS statistics are to be cleared for a specified VSAN ranging 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 for VSAN 10.

switch# clear fcs statistics vsan 10

Related Commands

Command
Description

show fcs statistics

Displays the fabric configuration server statistics information.


clear fctimer session

To clear fctimer Cisco Fabric Services (CFS) session configuration and locks, use the clear fctimer session command.

clear fctimer session

Syntax Description

This command has no other arguments or keywords.

Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

None.

Examples

The following example shows how to clear fctimer session.

switch# clear fctimer session

Related Commands

Command
Description

show fctimer

Displays fctimer information.


clear ficon

Use the clear ficon command in EXEC mode to clear the FICON information for the specified VSAN.

clear ficon vsan vsan-id [allegiance | timestamp]

Syntax Description

vsan vsan-id

Specifies the FICON-enabled VSAN. The ID of the VSAN is from 1 to 4093.

allegiance

Clears FICON device allegiance.

timestamp

Clears FICON VSAN specific timestamp.


Defaults

None.

Command Modes

EXEC mode.

Command History

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

Usage Guidelines

The clear ficon vsan vsan-id allegiance command aborts the currently-executing session.

Examples

The following example clears the current device allegiance for VSAN 1.

switch# clear ficon vsan 1 allegiance

The following example clears the VSAN clock for VSAN 20.

switch# clear ficon vsan 20 timestamp

Related Commands

Command
Description

show ficon

Displays configured FICON details.


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

vsan

Indicates that the counters are to be cleared for a VSAN.

vsan-id

The ID of the VSAN is from 1 to 4093.

interface type

(Optional). The counters are to be cleared for an interface. The interface types are fc for Fibre Channel, and port-channel for PortChannel.


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 1

The 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/32

Related Commands

Command
Description

show fspf

Displays global FSPF information for a specific VSAN.


clear ip access-list counters

To clear IP access list counters, use the clear ip access-list counters command in EXEC mode.

clear ip access-list counters list-name

Syntax Description

list-name

Specifies the IP access list name (maximum 64 characters).


Defaults

None.

Command Modes

EXEC.

Command History

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

Examples

The following example clears the counters for an IP access list.

switch# clear ip access-list counters adminlist

Related Commands

Command
Description

show ip access-list

Displays IP access list information.


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

address

Clears fcflow aggregated statistics.

ip-address

Enters the peer IP address.

interface gigabitethernet

Specifies the Gigabit Ethernet interface.

module-number

Specifies slot and port of the Gigabit Ethernet interface.


Defaults

None.

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/7 
arp clear successful

The following example clears all ARP cache entries

switch# clear ips arp interface gigabitethernet 8/7
arp clear successful

clear ivr fcdomain database

To clear the IVR fcdomain database, use the clear ivr fcdomain database command in EXEC mode.

clear ivr fcdomain database

Syntax Description

This command has no arguments or keywords.

Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.1(2)

This command was introduced.


Usage Guidelines

None.

Examples

The following example clears all IVR fcdomain database information.

switch# clear ivr fcdomain database

Related Commands

Command
Description

show ivr fcdomain database

Displays IVR fcdomain database entry information.


clear ivr zone database

To clear the Inter-VSAN Routing (IVR) zone database, use the clear ivr zone database command in EXEC mode.

clear ivr zone database

Syntax Description

This command has no arguments or keywords.

Defaults

None.

Command Modes

EXEC.

Command History

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

Examples

The following example clears all configured IVZ information.

switch# clear ivr zone database 

clear license

To uninstall a license, use the clear license command in EXEC mode.

clear license filename

Syntax Description

filename

Specifies the license file to be uninstalled.


Defaults

None.

Command Modes

EXEC.

Command History

This command was modified in Cisco MDS SAN-OS Release 1.3(2).

Examples

The following example clears a specific license.

switch# clear license Ficon.lic 
Clearing license Ficon.lic:
SERVER this_host ANY
VENDOR cisco
# An example fcports license
INCREMENT SAN_EXTN_OVER_IP cisco 1.000 permanent 1 HOSTID=VDH=ABCD \
        NOTICE=<LicFileID>san_extn2.lic</LicFileID><LicLineID>1</LicLineID> \
        SIGN=67CB2A8CCAC2
Do you want to continue? (y/n) y
Clearing license ..done
switch# 

Related Commands

Command
Description

show license

Displays license information.


clear line

To clear VTY sessions, use the clear line command in EXEC mode.

clear line vty-name

Syntax Description

vty-name

Specifies the VTY name (maximum 64 characters).


Defaults

None.

Command Modes

EXEC.

Command History

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

Examples

The following example clears one ARP cache entry:

switch# clear line Aux
arp clear successful

Related Commands

Command
Description

show line

Displays line information.


clear logging

To delete the SYSLOG information, use the clear logging command in EXEC mode.

clear logging {logfile | nvram}

Syntax Description

logfile

Clears log file messages.

nvram

Clears NVRAM logs.


Defaults

None.

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 logging logfile

Related Commands

Command
Description

show logging

Displays logging information.


clear ntp

To clear Network Time Protocol (NTP) information, use the clear ntp command in EXEC mode.

clear ntp {session | statistics {all-peers | io | local | memory}}

Syntax Description

session

Clears NTP CFS session configuration and locks.

statistics

Clears NTP statistics.

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-peers

The following example shows how to clear NTP statistics for I/O devices.

switch# clear ntp statistics io

The following example shows how to clear NTP statistics for local devices.

switch# clear ntp statistics local

The following example shows how to clear NTP statistics for memory.

switch# clear ntp statistics memory

Related Commands

Command
Description

show ntp

Displays the configured server and peer associations.


clear port-security

To clear the port security information on the switch, use the clear port-security command in EXEC mode.

clear port-security {database auto-learn {interface fc slot/port | port-channel port} | session | statistics} vsan vsan-id

Syntax Description

database

Clears the port security active configuration database.

session

Clears the port security CFS configuration session and locks.

statistics

Clears the port security counters.

auto-learn

Clears the auto-learnt entries for a specified interface or VSAN.

interface fc slot/port

Clears entries for a specified interface.

port-channel port

Clears entries for a specified PortChannel. The range is 1 to 128.

vsan vsan-id

Clears entries for a specified VSAN ID. The range is 1 to 4093.


Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

1.2(1)

This command was introduced.

2.0(1b)

Added the session option.


Usage Guidelines

The active database is read-only and clear port-security database command can be used when resolving conflicts.

Examples

The following example clears all existing statistics from the port security database for a specified VSAN.

switch# clear port-security statistics vsan 1

The following example clears learnt entries in the active database for a specified interface within a VSAN.

switch# clear port-security database auto-learn interface fc1/1 vsan 1

The following example clears learnt entries in the active database up to for the entire VSAN.

switch# clear port-security database auto-learn vsan 1

Related Commands

Command
Description

show port-security

Displays the configured port security information.


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 all

Related Commands

Command
Description

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 statistics

Related Commands

Command
Description

show qos statistics

Displays the current QoS settings, along with a number of frames marked high priority.


clear radius session

To clear RADIUS Cisco Fabric Services (CFS) session configuration and locks, use the clear radius session command.

clear radius session

Syntax Description

This command has no other arguments or keywords.

Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

None.

Examples

The following example shows how to clear RADIUS session.

switch# clear radius session

Related Commands

Command
Description

show radius

Displays RADIUS CFS distribution status and other details.


clear rlir

To clear the Registered Link Incident Report (RLIR), use the clear rlir command in EXEC mode.

clear rlir {history | recent {interface fc slot/port | portnumber port-number} |
statistics vsan vsan-id}

Syntax Description

history

Clears RLIR link incident history.

recent

Clears recent link incidents.

interface fc slot/port

Clears entries for a specified interface.

portnumber port-number

Displays the port number for the link incidents.

statistics

Clears RLIR statistics.

vsan vsan-id

Specifies the VSNA ID for which the RLIR statistics are to be cleared.


Defaults

None.

Command Modes

EXEC mode.

Command History

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

Usage Guidelines

None.

Examples

The following example clears all existing statistics for a specified VSAN.

switch# clear rlir statistics vsan 1

The following example clears the link incident history.

switch# clear rlir history 

The following example clears recent RLIR information for a specified interface.

switch# clear rlir recent interface fc 1/2

The following example clears recent RLIR information for a specified port number.

switch# clear rlir recent portnumber 16

Related Commands

Command
Description

show rscn

Displays RSCN information.


clear role session

To clear authentication role Cisco Fabric Services (CFS) session configuration and locks, use the clear role session command.

clear role session

Syntax Description

This command has no other arguments or keywords.

Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

None.

Examples

The following example shows how to clear authentication role CFS session.

switch# clear role session

Related Commands

Command
Description

show role

Displays role configuration information.


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 1

Related Commands

Command
Description

show rscn

Displays RSCN information.


clear scheduler logfile

To clear the command scheduler logfile, use the clear scheduler logfile command.

clear scheduler logfile

Syntax Description

This command has no other arguments or keywords.

Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

None.

Examples

The following example shows how to clear the command scheduler logfile.

switch# clear scheduler logfile

Related Commands

Command
Description

show scheduler

Displays command scheduler information.


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 screen



clear scsi-flow statistics

To clear the SCSI flow statistics counters, use the clear scsi-flow statistics command.

clear scsi-flow statistics flow-id flow-id

Syntax Description

flow-id flow-id

Configures the SCSI flow identification number.


Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(2)

This command was introduced.


Usage Guidelines

None.

Examples

The following example shows how to clear the SCSI flow statistics counters for SCSI flow ID 3.

switch# clear scsi-flow statistics flow-id 3 

Related Commands

Command
Description

scsi-flow flow-id

Configures the SCSI flow services.

show scsi-flow

Displays SCSI flow configuration and status.


clear ssh hosts

To clear trusted SSH hosts, use the clear ssh hosts command in EXEC mode.

clear ssh hosts

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.2(1).

Usage Guidelines

None.

Examples

The following example shows how to clear reset-reason information from NVRAM and volatile storage.

switch# clear ssh hosts

Related Commands

Command
Description

show ssh hosts

Displays SSH host information.


clear system reset-reason

To clear the reset-reason information stored in NVRAM and volatile persistent storage, use the clear system reset-reason command in EXEC mode.

clear system reset-reason

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(2a).

Usage Guidelines

Use this command as listed below:

In a Cisco MDS 9500 Series switch, this command clears the reset-reason information stored in NVRAM and volatile persistent storage in the active and standby supervisor modules.

In a Cisco MDS 9200 Series switch, this command clears the reset-reason information stored in NVRAM and volatile persistent storage in the active supervisor module.

Examples

The following example shows how to clear trusted SSH hosts.

switch# clear system reset-reason

Related Commands

Command
Description

show system reset-reason

Displays system reset-reason information.


clear tacacs+ session

To clear TACACS+ Cisco Fabric Services (CFS) session configuration and locks, use the clear tacacs+ session command.

clear tacacs+ session

Syntax Description

This command has no other arguments or keywords.

Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

To use this command, TACACS+ must be enabled using the tacacs+ enable command.

Examples

The following example shows how to clear the TACACS+ session.

switch# clear tacacs+ session

Related Commands

Command
Description

show tacacs+

Displays TACACS+ CFS distribution status and other details.

tacacs+ enable

Enables TACACS+.


clear tlport alpa-cache

To clear the entire contents of the alpa-cache, use the clear tlport alpa-cache command in EXEC mode.

clear tlport alpa-cache

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(5).

Usage Guidelines

None.

Examples

The following example shows how to clear a TL port ALPA cache.

switch# clear tlport alpa-cache

Related Commands

Command
Description

show tlport alpa-cache

Displays TL port alpa-cache information.


clear user

To clear trusted SSH hosts, use the clear user command in EXEC mode.

clear user username

Syntax Description

username

Specifies the user name to clear.


Defaults

None.

Command Modes

EXEC mode.

Command History

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

Usage Guidelines

None.

Examples

The following example shows how to log out a specified user.

switch# clear user vsam

Related Commands

Command
Description

show users

Displays user information.


clear vrrp

To clear all the software counters for the specified virtual router, use the clear vrrp command in EXEC mode.

clear vrrp {statistics | vr number interface {gigabitethernet port/slot | mgmt 0 |
port-channel portchannel-id | vsan vsan-id}}

Syntax Description

statistics

Clears global VRRP statistics.

vr

Clears specific VR statistics.

number

Specifies a VR number from 1 to 255.

interface

Specifies an interface.

gigabitethernet port/slot

Specifies a gigabitethernet interface.

mgmt 0

Specifies the management interface.

port-channel portchannel-id

Specifies a port-channel interface.The ID of the port-channel interface is from 1 to 128.

vsan vsan-id

Specifies a VSAN. The ID of the VSAN is 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).

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 vsan2 

Related Commands

Command
Description

show vrrp

Displays VRRP configuration information.


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 {lun-zoning | read-only-zoning}} vsan vsan-id

Syntax Description

database

Clears zone server database information.

statistics

Clears zone server statistics.

lun-zoning

Clears LUN-zoning related statistics.

read-only-zoning

Clears read-only zoning related statistics.

vsan

Clears zone information for a VSAN.

vsan-id

The ID of the VSAN is 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).

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 1

Related Commands

Command
Description

show zone

Displays zone information for any configured interface.


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 the 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

summer-time

Adjusts the daylight savings time for the Pacific time zone by 60 minutes starting the first sunday in April at 2 a.m. and ending the last Sunday in October at 2 a.m.

time-zone

Sets the time zone for a specified time zone name.

daylight-timezone-name

The 8-character name of the time zone

start-week
end-week

The week ranging from 1 through 5

start-day
end-day

The day ranging from Sunday through Saturday

start-month
end-month

The month ranging from January through December

start-time
end-time

The time ranging from

daylight-offset-to-be-added-in-minutes

The daylight offset ranges from1 through 1440 minutes that will be added to the start time and deleted from the end time


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 terminal
switch(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 60
switch(config)# no clock summer-time
switch(config)# exit
switch# 

Related Commands

Command
Description

clock set

Changes the default time on the switch.

show clock

Displays the current date and time.

show run

Displays changes made to the time zone configuration along with other configuration information.


code-page

Use the code-page command to configure the EBCDIC format. To disable the configuration or to revert to factory defaults, use the no form of the command.

code-page brazil |france | france | international-5 | italy | japan | spain-latinamerica | uk | us-canada

Syntax Description

code-page

Configures code page on a FICON-enabled VSAN

brazil

Configures the brazil EBCDIC format.

france

Configures the france EBCDIC format.

international-5

Configures the international-5 EBCDIC format.

italy

Configures the italy EBCDIC format.

japan

Configures the japan EBCDIC format.

spain-latinamerica

Configures the spain-latinamerica EBCDIC format.

uk

Configures the uk EBCDIC format.

us-canada

Configures the us-canada EBCDIC format.


Defaults

None.

Command Modes

Configuration mode.

Command History

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

Usage Guidelines

This is an optional configuration. If you are not sure of the EBCDIC format to be used, we recommend retaining the us-canada (default) option.

Examples

The following example configures the italy EBCDIC format.

switch(config)# ficon vsan 2
switch(config-ficon)# code-page italy

The following example reverts to the factory default of using the us-canada EBCDIC format.

switch(config-ficon)# no code-page

Related Commands

Command
Description

show ficon

Displays configured FICON details.

ficon vsan vsan-id

Enables FICON on the specified VSAN.


clock set

To change the system 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

HH

The two-digit time in hours in military format (15 for 3 p.m.).

MM

The two-digit time in minutes (58).

SS

The two-digit time in seconds(15).

DD

The two-digit date (12).

Month

The month in words (August).

YYYY

The four-digit year (2002).


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 2002
Mon Aug 12 15:58:00 PDT 2002

code-page

Use the code-page command to configure the EBCDIC format. To disable the configuration or to revert to factory defaults, use the no form of the command.

code-page {brazil | france | france | international-5 | italy | japan | spain-latinamerica | uk | us-canada}

Syntax Description

brazil

Specifies brazil EBCDIC format.

france

Specifies france EBCDIC format.

international-5

Specifies international-5 EBCDIC format.

italy

Specifies italy EBCDIC format.

japan

Specifies japan EBCDIC format.

spain-latinamerica

Specifies spain-latinamerica EBCDIC format.

uk

Specifies uk EBCDIC format.

us-canada

Specifies us-canada EBCDIC format.


Defaults

us-canada

Command Modes

Configuration mode.

Command History

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

Usage Guidelines

This is an optional configuration. If you are not sure of the EBCDIC format to be used, we recommend retaining the us-canada (default) option.

Examples

The following example configures the italy EBCDIC format.

switch(config)# ficon vsan 2
switch(config-ficon)# code-page italy

The following example reverts to the factory default of using the us-canada EBCDIC format.

switch(config-ficon)# no code-page

Related Commands

Command
Description

show ficon

Displays configured FICON details.

ficon vsan vsan-id

Enables FICON on the specified VSAN.


commit

To apply the pending configuration pertaining to the Call Home configuration session in progress, use the commit command in Call Home configuration submode.

commit

Syntax Description

This command has no other arguments or keywords.

Defaults

None.

Command Modes

Call Home configuration submode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

CFS distribution must be enabled before you can commit the Call Home configuration.

Examples

The following example shows how to commit the Call Home configuration commands.

switch# config terminal
Enter configuration commands, one per line.  End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# commit

Related Commands

Command
Description

callhome

Configures the Call Home function.

callhome test

Sends a dummy test message to the configured destination(s).

show callhome

Displays configured Call Home information.


contract-id

To configure the service contract ID of the customer with the Call Home function, use the contract-id command in Call Home configuration submode. To disable this feature, use the no form of the command.

contract-id customer-id

no contract-id customer-id

Syntax Description

contract-id

(Optional) Configures the service contract ID of the customer. Allows up to 64 characters for the contract number.


Defaults

None.

Command Modes

Call Home configuration submode

Command History

Release
Modification

1.0(2)

This command was introduced.


Usage Guidelines

None.

Examples

The following example shows how to configure the contract ID in the Call Home configuration.

switch# config terminal
Enter configuration commands, one per line.  End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# contract-id Customer1234 

Related Commands

Command
Description

callhome

Configures the Call Home function.

callhome test

Sends a dummy test message to the configured destination(s).

show callhome

Displays configured Call Home information.


configure terminal

To enter 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# configure terminal
switch(config)# 

The following example enters the configuration mode using an abbreviated format of the command:

switch# config terminal
switch(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.

running-config

Specifies the configuration currently running on the switch. The system:running-config keyword represents the current running configuration file.

startup-config

Specifies the configuration used during initialization (startup). You can copy the startup configuration from NVRAM. The nvram:startup-config keyword represents the configuration file used during initialization.

bootflash:

Specifies the location for internal bootflash memory.

log:

Specifies the location for the log file system.

slot0:

Specifies the location for the CompactFlash memory or PCMCIA card.

volatile:

Specifies the location for the volatile file system.

system:

Specifies the location for system memory, which includes the running configuration.

fabric

Specifies a fabric wide startup configuration update using Cisco Fabric Services (CFS) where all the remote switches in the fabric copy their running configuration (source) file into their startup configuration (destination) file. The syntax for this command is copy running-config startup-config fabric.

tftp:

Specifies the location for a Trivial File Transfer Protocol (TFTP) network server. The syntax for this alias is tftp:[[//location]/directory]/filename.

ftp:

Specifies the location for a File Transfer Protocol (FTP) network server. The syntax for this alias is ftp:[[//location]/directory]/filename.

scp:

Specifies the location for a secure copy (scp) network server. The syntax for this alias is scp:[[//location]/directory]/filename.

sftp:

Specifies the location for a Secure Trivial File Transfer Protocol (SFTP) network server. The syntax for this alias is sftp:[[//location]/directory]/filename.

log:

Specifies the location for log files stored in the same directory.

debug:

Specifies the location for the debug files stored in the debug partition

nvram:

Specifies the switch NVRAM.

core:

Specifies the location of the cores from any switching or supervisor module to an external flash (slot 0) or a TFTP server.

filename

The name of the Flash file.

sup-1
sup-2

The number of the supervisor module, where sup-1 is the slot 5 supervisor (active) and sup-2 is the slot 6 supervisor (standby).


Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

1.3(4)

Command modified.

2.1(1a)

Added the fabric keyword and functionality.


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.

You can save cores (from the active supervisor module, the standby supervisor module, or any switching module) to an external flash (slot 0) or to a TFTP server in one of two ways:

On demand—to copy a single file based on the provided process ID.

Periodically—to copy core files periodically as configured by the user.

You copy the logfile to a different location using the copy log:messages command.

The debug partition contains debugging files created by the software for troubleshooting purposes.

The running-config startup-config fabric parameters allow you to use CFS to force every switch in the Fibre Channel fabric to copy their running configuration (source) to their startup configuration (destination).


Note If any remote switch fails to complete the copy running-config startup-config fabric process, the initiator switch also does not complete saving its startup-configuration. This means, both the remote switch and the initiator switch have failed to save their startup-configuration (the old startup-configuration reverts back). All the other switches in the network would have succeeded.


Examples

The following example saves your configuration to the startup configuration.

switch# copy system:running-config nvram:startup-config 

The following example copies the file called samplefile from the slot0 directory to the mystorage directory.

switch# copy slot0:samplefile slot0:mystorage/samplefile

The following example copies a file from the current directory level.

switch# copy samplefile mystorage/samplefile

If the current directory is slot0:mydir, this command copies slot0:mydir/samplefile to slot0:mydir/mystorage/samplefile.

The following example downloads a configuration file from an external CompactFlash to the running configuration.

switch copy slot0:dns-config.cfg system:running-config

The following example saves a running configuration file to an external CompactFlash.

switch# copy system:running-config slot0:dns-config.cfg

The following example saves a startup configuration file to an external CompactFlash.

switch# copy system:startup-config slot0:dns-config.cfg

The following example uses CFS to cause all switches in the fabric to copy their running configuration (source) file to their startup configuration (destination) file.

switch# copy running-config startup-config fabric
[########################################] 100%
switch# 


Note If any remote switch fails to complete the copy running-config startup-config fabric process, the initiator switch also does not complete saving its startup-configuration. This means, both the remote switch and the initiator switch have failed to save their startup-configuration (the old startup-configuration reverts back). All the other switches in the network would have succeeded.


The following example creates a backup copy of the binary configuration.

switch# copy nvram:startup-config nvram:snapshot-config

The 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/myimage

The following example creates a running configuration copy in bootflash.

switch# copy system:running-config bootflash:my-config

The following examples creates a startup configuration copy in bootflash.

switch# copy nvram:startup-config bootflash:my-config

Related Commands

Command
Description

cd

Changes the default directory or file system.

dir

Displays a list of files on a file system.

reload

Reloads the operating system.

show version

Displays the version of the running configuration file.


copy licenses

To save a backup of the installed license files, use the copy licenses command in EXEC mode.

copy licenses 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.

bootflash:

Specifies the location for internal bootflash memory.

slot0:

Specifies the location for the CompactFlash memory or PCMCIA card.

volatile:

Specifies the location for the volatile file system.

filename

Specifies the name of the license file with a.tar extension.


Defaults

None.

Command Modes

EXEC mode.

Command History

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

Usage Guidelines

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:).

We recommend backing-up your license files immediately after installing them and just before issuing a write erase command.

Examples

The following example saves a file called Enterprise.tar to the bootflash: directory.

switch# copy licenses bootflash:/Enterprise.tar
Backing up license done

Related Commands

Command
Description

cd

Changes the default directory or file system.

dir

Displays a list of files on a file system.

install license

Installs a license file.


crypto global domain ipsec security-association lifetime

To configure global parameters for IPsec, use the crypto global domain ipsec security-association lifetime command. To revert to the default, use the no form of the command.

crypto global domain ipsec security-association lifetime {gigabytes number | kilobytes number |
megabytes number | seconds number}

no crypto global domain ipsec security-association lifetime {gigabytes | kilobytes | megabytes | seconds}

Syntax Description

gigabytes number

Specifies a volume-based key duration in gigabytes. The range is 1 to 4095.

kilobytes number

Specifies a volume-based key duration in kilobytes. The range is 2560 to 2147483647.

megabytes number

Specifies a volume-based key duration in megabytes. The range is 3 to 4193280.

seconds number

Specifies a time-based key duration in seconds. The range is 120 to 86400.


Defaults

450 gigabytes and 3600 seconds

Command Modes

Configuration mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

To use this command, IPsec must be enabled using the crypto ipsec enable command.

The global security association lifetime value can be overridden for individual IPsec crypto maps using the set command in IPsec crypto map configuration submode.

Examples

The following example shows how to configure the system default before the IPsec.

switch# config terminal
switch(config)# crypto global domain ipsec security-association lifetime gigabytes 500

Related Commands

Command
Description

crypto ipsec enable

Enables IPsec.

set (IPsec crypto map configuration submode)

Configures IPsec crypto map entry parameters.

show crypto global domain ipsec

Displays the global attributes for IPsec.


crypto ike domain ipsec

To enter IKE configuration submode, use the crypto ike domain ipsec command.

crypto ike domain ipsec

Syntax Description

This command has no other arguments or keywords.

Defaults

None.

Command Modes

Configuration mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

To configure IKE protocol attributes, IKE must be enabled using the crypto ike enable command.

Examples

The following example shows how enter IKE configuration mode.

switch# config terminal
switch(config)# crypto ike domain ipsec
switch(config-ike-ipsec)# 

Related Commands

Command
Description

crypto ike enable

Enables the IKE protocol.

show crypto ike domain ipsec

Displays IKE information for the IPsec domain.


crypto ike domain ipsec rekey sa

To rekey an IKE crypto security association (SA) in the IPsec domain, use the crypto ike domain ipsec rekey sa command.

crypto ike domain ipsec rekey sa sa-index

Syntax Description

sa-index

Specifies the SA index. The range is 1 to 2147483647.


Defaults

None.

Command Modes

EXEC mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

To use this command, IKE must be enabled using the crypto ike enable command.

Examples

The following example rekeys an IKE crypto SA.

switch# crypto ike domain ipsec rekey sa 100

Related Commands

Command
Description

crypto ike enable

Enables the IKE protocol.

show crypto ike domain ipsec

Displays IKE information for the IPsec domain.


crypto ike enable

To enable IKE, use the crypto ike enable command. To disable IKE, use the no form of the command.

crypto ike enable

no crypto ike enable

Syntax Description

This command has no other arguments or keywords.

Defaults

Disabled.

Command Modes

Configuration mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

The IKE protocol cannot be disabled unless IPsec is disabled.

The configuration and verification commands for the IKE protocol are only available when the IKE protocol is enabled on the switch. When you disable this feature, all related configurations are automatically discarded.

Examples

The following example shows how to enable the IKE protocol.

switch# config terminal
switch(config)# crypto ike enable

Related Commands

Command
Description

clear crypto ike domain ipsec sa

Clears IKE protocol information clear IKE SAs.

crypto ipsec enable

Enables IPsec.

show crypto ike domain ipsec

Displays IKE information for the IPsec domain.


crypto ipsec enable

To enable IPsec, use the crypto ipsec enable command. To disable IPsec, use the no form of the command.

crypto ipsec enable

no crypto ipsec enable

Syntax Description

This command has no other arguments or keywords.

Defaults

Disabled.

Command Modes

Configuration mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

To enable the IPsec, the IKE protocol must be enabled using the crypto ike enable command.

The configuration and verification commands for IPsec are only available when IPsec is enabled on the switch. When you disable this feature, all related configurations are automatically discarded.

Examples

The following example shows how to enable IPsec.

switch# config terminal
switch(config)# crypto ipsec enable

Related Commands

Command
Description

show crypto global domain ipsec

Displays IPsec crypto global information.

show crypto map domain ipsec

Displays IPsec crypto map information.

show crypto transform-set domain ipsec

Displays IPsec crypto transform set information.


crypto map domain ipsec (configuration mode)

To specify an IPsec crypto map and enter IPsec crypto map configuration mode, use the crypto map domain ipsec command. To delete an IPsec crypto map or a specific entry in an IPsec crypto map, use the no form of the command.

crypto map domain ipsec map-name seq-number

no crypto map domain ipsec map-name [seq-number]

Syntax Description

map-name

Specifies the map name. Maximum length is 63 characters.

seq-number

Specifies the sequence number for the map entry. The range is 1 to 65535.


Defaults

None.

Command Modes

Configuration mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

To use this command, IPsec must be enabled using the crypto ipsec enable command.

The sequence number determines the order in which IPsec crypto map entries are applied.

Examples

The following example specifies entry 1 for IPsec crypto map IPsecMap and enters IPsec crypto map configuration mode.

switch# config terminal
switch(config)# crypto map domain ipsec IPsecMap 1
switch(config-crypto-map-ip)#

The following example deletes an IPsec crypto map entry.

switch# config terminal
switch(config)# no crypto map domain ipsec IPsecMap 1

The following example deletes the entire IPsec crypto map.

switch# config terminal
switch(config)# no crypto map domain ipsec IPsecMap

Related Commands

Command
Description

crypto ipsec enable

Enables IPsec.

crypto transform-set domain ipsec

Configures the transform set for an IPsec crypto map.

set (IPsec crypto map configuration submode)

Configures IPsec crypto map entry parameters.

show crypto map domain ipsec

Displays IPsec crypto map information.


crypto map domain ipsec (interface configuration submode)

To configure an IPsec crypto map on a Gigabit Ethernet interface, use the crypto map domain ipsec command in interface configuration submode. To remove the IPsec crypto map, use the no form of the command.

crypto map domain ipsec map-name

no crypto map domain ipsec

Syntax Description

map-name

Specifies the map name. Maximum length is 63 characters.


Defaults

None.

Command Modes

Interface configuration submode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

To use this command, IPsec must be enabled using the crypto ipsec enable command.

The sequence number determines the order in which crypto maps are applied.

Examples

The following example shows how to specify an IPsec crypto map for a Gigabit Ethernet interface.

switch# config terminal
switch(config)# interface gigabitethernet 1/2
switch(config-if)# crypto map domain ipsec IPsecMap

Related Commands

Command
Description

crypto ipsec enable

Enables IPsec.

show crypto map domain ipsec

Displays IPsec crypto map information.

show interface

Displays interface information.


crypto transform-set domain ipsec

To create and configure IPsec transform sets, use the crypto transform-set domain ipsec command. To delete an IPsec transform set, use the no form of the command.

crypto transform-set domain ipsec set-name {esp-3des | esp-des} [esp-aes-xcbc-mac | esp-md5-hmac | esp-sha1-hmac]

crypto transform-set domain ipsec set-name esp-aes {128 | 256} [ctr {esp-aes-xcbc-mac | esp-md5-hmac | esp-sha1-hmac} | esp-aes-xcbc-mac | esp-md5-hmac | esp-sha1-hmac]

crypto transform-set domain ipsec set-name [{esp-3des | esp-des} [esp-aes-xcbc-mac | esp-md5-hmac | esp-sha1-hmac]]

crypto transform-set domain ipsec set-name esp-aes [{128 | 256} [ctr {esp-aes-xcbc-mac | esp-md5-hmac | esp-sha1-hmac} | esp-aes-xcbc-mac | esp-md5-hmac | esp-sha1-hmac]]

Syntax Description

set-name

Specifies the transform set name. Maximum length is 63 characters.

esp-3des

Specifies ESP transform using the 3DES cipher (128 bits).

esp-des

Specifies ESP transform using the DES cipher (56 bits).

esp-aes-xcbc-mac

Specifies ESP transform using AES-XCBC-MAC authentication.

esp-md5-hmac

Specifies ESP transform using MD5-HMAC authentication.

esp-sha1-hmac

Specifies ESP transform using SHA1-HMAC authentication

esp-aes

Specifies ESP transform using the AES cipher (128 or 256 bits).

128

Specifies ESP transform using AES 128-bit cipher.

256

Specifies ESP transform using AES 256-bit cipher.

ctr

Specifies AES in counter mode.


Defaults

None.

The default mode of AES is CBC (Cyber Block Chaining).

Command Modes

Configuration mode.

Command History

Release
Modification

2.0(1b)

This command was introduced.


Usage Guidelines

To use this command, IPsec must be enabled using the crypto ipsec enable command.

You can use this command to modify existing IPsec transform sets. If you change a transform set definition, the change is only applied to crypto map entries that reference the transform set. The change is not applied to existing security associations, but used in subsequent negotiations to establish new security associations. If you want the new settings to take effect sooner, you can clear all or part of the security association database using the clear crypto sa domain ipsec command.

Examples

The following example shows how to configure an IPsec transform set.

switch# config terminal
switch(config)# crypto transform-set domain ipsec Set1 esp-aes 128

Related Commands

Command
Description

clear crypto sa domain ipsec

Clears security associations.

crypto ipsec enable

Enables IPsec.

show crypto transform-set domain ipsec

Displays IPsec crypto transform set information.


customer-id

To configure the customer ID with the Call Home function, use the customer-id command in Call Home configuration submode. To disable this feature, use the no form of the command.

customer-id customer-id

no customer customer-id

Syntax Description

customer-id

(Optional) Specifies the customer ID. The maximum length is 64 alphanumeric characters in free format.


Defaults

None.

Command Modes

Call Home configuration submode.

Command History

Release
Modification

1.0(2)

This command was introduced.


Usage Guidelines

None.

Examples

The following example shows how to configure the customer ID in the Call Home configuration submode.

switch# config terminal
Enter configuration commands, one per line.  End with CNTL/Z.
switch(config)# callhome
switch(config-callhome)# customer-id Customer1234 

Related Commands

Command
Description

callhome

Configures the Call Home function.

callhome test

Sends a dummy test message to the configured destination(s).

show callhome

Displays configured Call Home information.