Catalyst 2900 XL and Catalyst 3500 XL Command Reference, 12.0(5)WC6
Cisco IOS Commands

Table Of Contents

Cisco IOS Commands

abort

apply

cgmp

clear cgmp

clear controllers ethernet-controller

clear controllers lre log

clear ip address

clear lre rate selection

clear mac-address-table

clear mac-address-table notification

clear vmps statistics

clear vtp counters

cluster commander-address

cluster discovery hop-count

cluster enable

cluster holdtime

cluster management-vlan

cluster member

cluster run

cluster standby-group

cluster timer

controller LongReachEthernet

cpe protected

debug lre

delete

duplex

errdisable detect cause

errdisable recovery

exit

flowcontrol

hw-module slot module-slot # upgrade lre

interface

ip address

ip igmp filter

ip igmp max-groups

ip igmp profile

login authentication

lre log

lre patchfile

lre persistence

lre profile

lre profile global

lre rate selection sequence

lre reset

lre sequence

lre shutdown

lre upgrade default family device-family binary

mac-address-table aging-time

mac-address-table dynamic

mac-address-table notification

mac-address-table secure

mac-address-table static

management

margin

mvr (global configuration)

mvr (interface configuration)

ntp broadcast client

ntp broadcast destination

ntp broadcast key

ntp broadcast version

ntp max-associations

ntp source

port block

port group

port monitor

port network

port protected

port security

port storm-control

power inline

profile

rate selection

rate selection profile lock

rate selection sequence

rcommand

reset

rmon collection stats

session

show cgmp

show changes

show cluster

show cluster candidates

show cluster members

show controllers ethernet-controller

show controllers lre cpe info

show controllers lre cpe protected

show controllers lre interface-id actual

show controllers lre interface-id admin

show controllers lre log

show controllers lre log level

show controllers lre profile

show controllers lre sequence

show controllers lre status

show controllers lre version

show controllers lre version mfg

show current

show diags

show env

show errdisable detect

show errdisable recovery

show file systems

show interface

show ip igmp profile

show local ethernet-statistics

show lre upgrade binaries

show lre upgrade status

show lre upgrade version

show mac-address-table

show mac-address-table notification

show mvr

show mvr interface

show mvr members

show port block

show port group

show port monitor

show port network

show port protected

show port security

show port storm-control

show power inline

show proposed

show remote ethernet-statistics

show remote interfaces status

show rps

show spanning-tree

show tacacs

show tech-support

show udld

show version

show vlan

show vmps

show vmps statistics

show vtp

shutdown

shutdown vlan

snmp-server enable traps mac-notification

snmp-server enable traps vlan-membership

snmp-server enable traps vtp

snmp-server host

snmp trap mac-notification

spanning-tree

spanning-tree cost

spanning-tree forward-time

spanning-tree hello-time

spanning-tree max-age

spanning-tree portfast

spanning-tree portfast bpduguard

spanning-tree port-priority

spanning-tree priority

spanning-tree protocol

spanning-tree rootguard

spanning-tree stack-port

spanning-tree uplinkfast

speed

switchport access

switchport mode

switchport multi

switchport priority

switchport trunk allowed vlan

switchport trunk encapsulation

switchport trunk native

switchport trunk pruning

switchport voice vlan

tacacs-server attempts

tacacs-server dns-alias-lookup

udld

udld enable

udld reset

upgrade binary

upgrade preserve

vlan

vlan database

vmps reconfirm

vmps reconfirm

vmps retry

vmps server

vtp

vtp domain

vtp file

vtp password

vtp pruning

vtp v2-mode


Cisco IOS Commands


abort

Use the abort VLAN database command to abandon the proposed VLAN database, exit VLAN database mode, and return to privileged EXEC mode.

abort

Syntax Description

This command has no arguments or keywords.

Defaults

No default is defined.

Command Modes

VLAN database

Command History

Release
Modification

11.2(8)SA4

This command was first introduced.


Usage Guidelines

If you have added, deleted, or modified VLAN parameters in VLAN database mode but you do not want to keep the changes, the abort command causes all the changes to be abandoned. The VLAN configuration that was running before you entered VLAN database mode continues to be used.

Examples

This example shows how to abandon the proposed VLAN database and to exit to the privileged EXEC mode:

Switch(vlan)# abort
Switch#

You can verify that no VLAN database changes occurred by entering the show vlan brief user EXEC command.

Related Commands

Command
Description

apply

Implements the proposed VLAN database, increments the database configuration revision number, propagates it throughout the administrative domain, and remains in VLAN database mode.

exit

Implements the proposed VLAN database, increments the database configuration number, propagates it throughout the administrative domain, and returns to privileged EXEC mode.

reset

Abandons the proposed VLAN database and remains in VLAN database mode. Resets the proposed database to the currently implemented VLAN database on the switch.

show vlan

Displays the parameters for all configured VLANs in the administrative domain.

shutdown vlan

Shuts down (suspends) local traffic on the specified VLAN.

vlan database

Enters VLAN database mode from the command-line interface (CLI).


apply

Use the apply VLAN database command to implement the proposed VLAN database to increment the database configuration revision number, to propagate it throughout the administrative domain, and to remain in VLAN database mode.

apply

Syntax Description

This command has no arguments or keywords.

Defaults

No default is defined.

Command Modes

VLAN database

Command History

Release
Modification

11.2(8)SA4

This command was first introduced.


Usage Guidelines

The apply command implements the configuration changes that you made after you entered VLAN database mode and uses them for the running configuration. This command keeps you in VLAN database mode.

You cannot use this command when the switch is in the VLAN Trunking Protocol (VTP) client mode.

Examples

This example shows how to implement the proposed VLAN database as the running database:

Switch(vlan)# apply

You can verify that VLAN database changes occurred by entering the show vlan user EXEC command.

Related Commands

Command
Description

apply

Implements the proposed VLAN database, increments the database configuration revision number, propagates it throughout the administrative domain, and remains in VLAN database mode.

exit

Implements the proposed VLAN database, increments the database configuration number, propagates it throughout the administrative domain, and returns to privileged EXEC mode.

reset

Abandons the proposed VLAN database and remains in VLAN database mode. Resets the proposed database to the currently implemented VLAN database on the switch.

show vlan

Displays the parameters for all configured VLANs in the administrative domain.

shutdown vlan

Shuts down (suspends) local traffic on the specified VLAN.

vlan database

Enters VLAN database mode from the command-line interface (CLI).


cgmp

Use the cgmp global configuration command to enable Cisco Group Management Protocol (CGMP) and other CGMP options. Use the no form of this command to disable CGMP and its options.

cgmp {leave-processing | holdtime time | reserved}

no cgmp {leave-processing | holdtime | reserved}

Syntax Description

leave-processing

Enable Fast Leave processing on the switch.

holdtime time

Number of seconds a router connection is retained before the switch ceases to exchange messages with it. You can enter a number from 10 to 6000 (seconds).

reserved

Allow reserved addresses from 0100.5E00.0000 to 0100.5E00.00FF to join as group destination addresses.


Defaults

CGMP is enabled.

Fast Leave is disabled.

The hold time is 300 seconds.

Reserved addresses are allowed as group destination addresses.

Command Modes

Global configuration

Command History

Release
Modification

11.2(8)SA3

This command was first introduced.

12.0(5)XP

The reserved keyword was added.


Usage Guidelines

CGMP must be enabled before the Fast Leave option can be enabled.

Examples

This example shows how to disable CGMP:

Switch(config)# no cgmp

This example shows how to disable the Fast Leave option:

Switch(config)# no cgmp leave-processing

This example shows how to set 400 seconds as the length of time the switch waits before ceasing to exchange messages with a router:

Switch(config)# cgmp holdtime 400

This example shows how to remove the amount of time the switch waits before ceasing to exchange messages with a router:

Switch(config)# no cgmp holdtime

This example shows how to exclude reserved addresses from the group destination address for compatibility with Catalyst 5000 series switches.

Switch(config)# no cgmp reserved

You can verify the previous commands by entering the show cgmp user EXEC command.

Related Commands

Command
Description

clear cgmp

Deletes information that the switch learned by using CGMP.

show cgmp

Displays the state of the CGMP-learned multicast groups and routers.


clear cgmp

Use the clear cgmp privileged EXEC command to delete information that was learned by the switch by using the Cisco Group Management Protocol (CGMP).

clear cgmp [vlan vlan-id] | [group [address] | router [address]]

Syntax Description

vlan vlan-id

(Optional) VLAN for which the CGMP groups or routers are to be deleted. Valid IDs are from 1 to 1001; do not enter leading zeros.

group address

Delete all known multicast groups and their destination ports. Limited to a VLAN if the vlan keyword is entered. Limited to a specific group if the address parameter (MAC address of the group or router) is entered.

router address

(Optional) Delete all routers, their ports, and expiration times. Limited to a given VLAN if the vlan keyword is entered. Limited to a specific router if the address parameter is entered.


Command Modes

Privileged EXEC

Command History

Release
Modification

11.2(8)SA3

This command was first introduced.


Usage Guidelines

Using clear cgmp with no arguments deletes all groups and routers in all VLANs.

Examples

This example shows how to delete all groups and routers on VLAN 2:

Switch# clear cgmp vlan 2

This example shows how to delete all groups on all VLANs:

Switch# clear cgmp group

This example shows how to delete a router address on VLAN 2:

Switch# clear cgmp vlan 2 router 0012.1234.1234

You can verify the previous commands by entering the show cgmp user EXEC command.

Related Commands

Command
Description

cgmp

Enables CGMP and the Fast Leave option and sets the router port aging time.

show cgmp

Displays the state of the CGMP-learned multicast groups and routers.


clear controllers ethernet-controller

Use the clear controllers ethernet-controller privileged EXEC command to delete the Ethernet link transmit and receive statistics on a switch port and on a Long-Reach Ethernet (LRE) customer premises equipment (CPE) device.

clear controllers ethernet-controller [interface-id]

Syntax Description

interface-id

(Optional) ID of the switch port.


Defaults

There is no default.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.0(5)WC1

This command was first introduced.

12.0(5)WC4

This command was extended to support the Cisco 585 LRE CPE device.


Usage Guidelines

Using the clear controllers ethernet-controller command without specifying a switch port clears the Ethernet link statistics for all ports on the switch. If you use this command on a switch LRE port, it clears the statistics on the Ethernet port on the Cisco 575 LRE CPE device or on all four Ethernet ports on the Cisco 585 LRE CPE device. The Cisco 585 LRE CPE Ethernet ports cannot be cleared on a per-port basis.

The CPE Ethernet link is the connection between the CPE Ethernet port and the remote Ethernet device (such as a PC) connected to it. It is not the link between the switch LRE port and the LRE CPE device.

It takes the switch several seconds to clear all of the ports. The switch LRE ports take longer to clear than all the other port types.

Examples

This example shows how to use the clear controllers ethernet-controller command to delete the Ethernet link statistics on Fast Ethernet port 0/1:

Switch# clear controllers ethernet-controller FastEthernet 0/1
Switch#

This example shows how to use the clear controllers ethernet-controller command to delete the Ethernet link statistics between the LRE CPE device and the remote Ethernet device. The LRE CPE device is connected to switch LRE port 1:

Switch# clear controllers ethernet-controller lo0/1
Switch#

You can verify that information was deleted by entering the show controllers ethernet-controller user EXEC command.

Related Commands

Command
Description

show controllers ethernet-controller

Displays the Ethernet link transmit and receive statistics on a Fast Ethernet or switch LRE port.


clear controllers lre log

Use the clear controllers lre log privileged EXEC command to delete the history of link, configuration, and timer events for a specific Long-Reach Ethernet (LRE) port or for all switch LRE ports.

clear controllers lre log [interface-id]

Syntax Description

interface-id

(Optional) ID of the switch LRE port.


Defaults

There is no default.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.0(5)WC1

This command was first introduced.

12.0(5)WC4

This command was extended to support the Cisco 585 LRE customer premises equipment (CPE) device.


Usage Guidelines

Using the clear controllers lre log command but without specifying a switch LRE port deletes the history of events on all switch LRE ports.

Examples

This example shows how to use the clear controllers lre log command to delete the history of events on switch LRE port 3:

Switch# clear controllers lre log longReachEthernet 0/3
Switch# 

You can verify that information was deleted by entering the show controllers lre log privileged EXEC command.

Related Commands

Command
Description

show controllers lre log

Displays the history of link, configuration, and timer events for a specific switch LRE port or for all LRE ports on the switch.


clear ip address

Use the clear ip address privileged EXEC command to delete an IP address for a switch without disabling the IP processing.

clear ip address [vlan vlan-id]

Syntax Description

vlan vlan-id

(Optional) Delete an IP address only within the specified VLAN.
Valid IDs are from 1 to 1000; do not enter leading zeros.


Command Modes

Privileged EXEC

Command History

Release
Modification

11.2(8)SA

This command was first introduced.

11.2(8)SA3

The vlan keyword was added.


Usage Guidelines

A switch can have one IP address.

The IP address of the switch can be accessed only by nodes connected to ports that belong to the management VLAN. By default, the management VLAN is VLAN 1, but you can configure a different VLAN as the management VLAN.

If your switch receives its IP address from a Bootstrap Protocol (BOOTP) or Dynamic Host Configuration Protocol (DHCP) server and you delete the switch IP address by using the clear ip address command, the BOOTP or DHCP server reassigns the address.

Examples

This example shows how to clear the IP address for the switch on VLAN 1:

Switch# clear ip address vlan 1

You can verify the previous commands by entering the show running-config privileged EXEC command.

Related Commands

Command
Description

show running-config

Displays the running configuration on the switch.


clear lre rate selection

Use the clear lre rate selection privileged EXEC command to reset the rate selection setting and to restart rate selection for a specific Long-Reach Ethernet (LRE) port or for all switch LRE ports.

clear lre rate selection [lock] [interface-id]

Syntax Description

lock

(Optional) Rate selection runs on all ports that have rate selection enabled, including ports that are locked.

interface-id

(Optional) ID of the switch LRE port.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.0(5)WC6

This command was first introduced.


Usage Guidelines

Using the clear lre rate selection command without specifying a switch LRE port runs rate selection on all switch LRE ports that have rate selection enabled except those ports with locked profiles. Specifying the lock keyword runs rate selection on all profiles, including those that are locked.

Examples

This example shows how to use the clear lre rate selection command to reset the rate selection setting and to restart rate selection on port 1.

Switch# clear lre rate selection lo0/1
Switch# 

This example shows how to reset and to restart rate selection on all ports, including any locked ports.

Switch# clear lre rate selection lock
Switch#

This example shows how to reset and to restart rate selection on port 1, overriding the locked status.

Switch# clear lre rate selection lock lo0/1
Switch#

Related Commands

Command
Description

rate selection

Enables rate selection on a specific port.

rate selection sequence

Assigns a rate selection sequence for a specific port.

lre rate selection sequence

Assigns a rate selection sequence for the entire switch.


clear mac-address-table

Use the clear mac-address-table privileged EXEC command to delete entries from the MAC address table.

clear mac-address-table [static | dynamic | secure] [address hw-addr] [interface interface]
[atm slot/port] [vlan vlan-id]

Syntax Description

static

(Optional) Delete only static addresses.

dynamic

(Optional) Delete only dynamic addresses.

secure

(Optional) Delete only secure addresses.

address hw-addr

(Optional) Delete the address hw-addr of type static, dynamic, and secure as specified.

interface interface

(Optional) Delete an address on the interface interface of type static, dynamic, or secure as specified.

atm slot/port

(Optional) Delete only ATM addresses on this slot and port.

vlan vlan-id

(Optional) Delete all the MAC addresses for vlan-id. Valid IDs are from
1 to 1005; do not enter leading zeros.


Command Modes

Privileged EXEC

Command History

Release
Modification

11.2(8)SA

This command was first introduced.

11.2(8)SA3

The vlan keyword was added.

11.2(8)SA5

The atm keyword was added.


Usage Guidelines

This command deletes entries from the global MAC address table. Specific subsets can be deleted by using the optional keywords and values. If more than one optional keyword is used, all of the conditions in the argument must be true for that entry to be deleted.

Examples

This example shows how to delete static addresses on port fa0/7:

Switch# clear mac-address-table static interface fa0/7

This example shows how to delete all secure addresses in VLAN 3:

Switch# clear mac-address-table secure vlan 3

This example shows how to delete address 0099.7766.5544 from all ports in all VLANs. If the address exists in multiple VLANs or multiple ports, all the instances are deleted.

Switch# clear mac-address-table address 0099.7766.5544

This example shows how to delete address 0099.7766.5544 only in VLAN 2:

Switch# clear mac-address-table address 0099.7766.5544 vlan 2

This example shows how to delete the secure MAC address 00c0.00a0.03fa associated with the ATM port in expansion slot 2:

Switch(config)# clear mac-address-table secure 00c0.00a0.03fa atm 2/1

This example shows how to delete the static address 00c0.00a0.03fa associated with the ATM port in expansion slot 2:

Switch(config)# clear mac-address-table static 00c0.00a0.03fa atm 2/1

You can verify the previous commands by entering the show mac-address-table user EXEC command.

Related Commands

Command
Description

show mac-address-table

Displays the MAC address table.


clear mac-address-table notification

Use the clear mac-address-table notification privileged EXEC command to clear the addresses maintained by the MAC address notification feature.

clear mac-address-table notification

Syntax Description

This command has no keywords or options.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.0(5)WC3

This command was first introduced.


Usage Guidelines

This command clears the counters for the MAC addresses added, the MAC addresses removed, and the number of traps sent to the NMS counters on the switch. This command does not clear the history table on the switch.

Related Commands

Command
Description

show mac-address-table

Displays the MAC address table.


clear vmps statistics

Use the clear vmps statistics privileged EXEC command to clear the statistics maintained by the VLAN Query Protocol (VQP) client.

clear vmps statistics

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release
Modification

11.2(8)SA4

This command was first introduced.


Examples

This example shows how to clear VLAN Membership Policy Server (VMPS) statistics:

Switch# clear vmps statistics

You can verify the previous command by entering the show vmps statistics privileged EXEC command.

Related Commands

Command
Description

show vmps statistics

Displays the VLAN Query Protocol (VQP) version, reconfirmation interval, retry count, VMPS IP addresses, and the current and primary servers.


clear vtp counters

Use the clear vtp counters privileged EXEC command to clear the VLAN Trunking Protocol (VTP) and pruning counters.

clear vtp counters

Syntax Description

This command has no arguments or keywords.

Command Modes

Privileged EXEC

Command History

Release
Modification

11.2(8)SA4

This command was first introduced.


Examples

This example shows how to clear the VTP counters:

Switch# clear vtp counters

You can verify the previous command by entering the show vtp counters user EXEC command.

Related Commands

Command
Description

show vtp counters

Display general information about the VTP management domain, status, and counters.


cluster commander-address

You do not need to enter this command. The command switch automatically provides its MAC address to member switches when these switches join the cluster. The member switch adds this information and other cluster information to its running configuration file. Enter the no form of this global configuration command from the member switch console port to remove it from a cluster only during debugging or recovery procedures.

cluster commander-address mac-address [member number name name]

no cluster commander-address

Syntax Description

mac-address

MAC address of the cluster command switch.

member number

Number of member switch. The range is from 0 to 15.

name name

Name of the cluster up to 31 characters.

no

Remove a switch from the cluster. Entered on the member switch.

default

Remove a switch from the cluster. Entered on the member switch.


Defaults

The switch is not a member of any cluster.

Command Modes

Global configuration

Command History

Release
Modification

11.2(8)SA6

This command was first introduced.

12.0(5)XU

The member and name keywords were added.


Usage Guidelines

A cluster member can belong to only one command switch.

The member switch retains the identity of the command switch during a system reload by using the mac-address parameter.

You can enter the no form on a member switch to remove it from the cluster during debugging or recovery procedures. You would normally use this command from the member switch console port only when the member has lost communication with the command switch. With normal switch configuration, we recommend that you remove member switches only by entering the no cluster member n global configuration command on the command switch.

When a standby command-switch becomes active (becomes the command switch), it removes the cluster commander-address line from its configuration.

Examples

This is partial sample output from the running configuration of a cluster member.

Switch(config)# show running-configuration

<output truncated>

cluster commander-address 00e0.9bc0.a500 member 4 name my_cluster

<output truncated>

This example shows how to remove a member from the cluster by using the cluster member console.

Switch-es3# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Switch-es3(config)# no cluster commander-address

You can verify the previous command by entering the show cluster command in user EXEC mode.

Related Commands

Command
Description

show cluster

Displays the cluster status and a summary of the cluster to which the switch belongs.


cluster discovery hop-count

Use the cluster discovery hop-count global configuration command on the command switch to set the hop-count limit for extended discovery of candidate switches. Use the no form of this command to set the hop count to the default value.

cluster discovery hop-count number

no cluster discovery hop-count

default cluster discovery hop-count

Syntax Description

number

Number of hops from the cluster edge that the command switch limits the discovery of candidates. The range is from 1 to 7.

no

Set the hop count to the default value (3).

default

Set the hop count to the default value (3).


Defaults

The hop count is set to 3.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5)XU

This command was first introduced.


Usage Guidelines

Enter this command only on the command switch. This command does not operate on member switches.

If the hop count is set to 1, it disables extended discovery. The command switch discovers only candidates that are one hop from the edge of the cluster. The edge of the cluster is the point between the last discovered member switch and the first discovered candidate switch.

Examples

This example shows how to set the hop count limit to 4. This command is entered on the command switch.

Switch(config)# cluster discovery hop-count 4

You can verify the previous command by entering the show cluster command in user EXEC mode.

Related Commands

Command
Description

show cluster

Displays the cluster status and a summary of the cluster to which the switch belongs.

show cluster candidates

Displays a list of candidate switches.


cluster enable

Use the cluster enable global configuration command on a command-capable switch to enable it as the cluster command switch, assign a cluster name, and optionally assign a member number to it. Use the no form of the command to remove all members and to make the command switch a candidate switch.

cluster enable name [command-switch-member-number]

no cluster enable

default cluster enable

Syntax Description

name

Name of the cluster up to 31 characters. Valid characters include only alphanumerics, dashes, and underscores.

command-switch-member-number

(Optional) Assign a member number to the command switch of the cluster. The range is from 0 to 15.

no

Remove all member switches, and make the command switch a candidate.

default

Switch is not a command switch.


Defaults

The switch is not a command switch.

No cluster name is defined.

The member number is 0 when this is the command switch.

Command Modes

Global configuration

Command History

Release
Modification

11.2(8)SA6

This command was first introduced.

12.0(5)XU

The command-switch-member-number variable was added.


Usage Guidelines

This command runs on any command-capable switch that is not part of any cluster. This command fails if a device is already configured as a member of the cluster.

You must name the cluster when you enable the command switch. If the switch is already configured as the command switch, this command changes the cluster name if it is different from the previous name.

Examples

This example shows how to enable the command switch, to name the cluster, and to set the command switch member number to 4.

Switch(config)# cluster enable Engineering-IDF4 4

You can verify the previous command by entering the show cluster command in user EXEC mode on the command switch.

Related Commands

Command
Description

show cluster

Displays the cluster status and a summary of the cluster to which the switch belongs.


cluster holdtime

Use the cluster holdtime global configuration command on the command switch to set the duration in seconds before a switch (either the command or member switch) declares the other switch down after not receiving heartbeat messages. Use the no form of this command to set the duration to the default value.

cluster holdtime holdtime-in-secs

no cluster holdtime

default cluster holdtime

Syntax Description

holdtime-in-secs

Duration in seconds before a switch (either a command or member switch) declares the other switch down. The range is from 1 to 300 seconds.

no

Set the holdtime to the default value (80 seconds).

default

Set the holdtime to the default value (80 seconds).


Defaults

The holdtime is 80 seconds.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5)XU

This command was first introduced.


Usage Guidelines

Use this command with the cluster timer global configuration command only on the command switch. The command switch propagates the values to all its cluster members so that the setting is consistent among all switches in the cluster.

The holdtime is typically set as a multiple of the interval timer (cluster timer). For example, it takes (holdtime-in-secs divided by interval-in-secs) number of heartbeat messages to be missed in a row to declare a switch down.

Examples

This example shows how to change the interval timer and the duration on the command switch.

Switch(config)# cluster timer 3
Switch(config)# cluster holdtime 30

You can verify the previous commands by entering the show cluster command in user EXEC mode.

Related Commands

Command
Description

show cluster

Displays the cluster status and a summary of the cluster to which the switch belongs.


cluster management-vlan

Use the cluster management-vlan global configuration command on the command switch to change the management VLAN for the entire cluster. Use the no form of this command to change the management VLAN to VLAN 1.

cluster management-vlan n

no cluster management-vlan

default cluster management-vlan

Syntax Description

n

VLAN ID of the new management VLAN. Valid VLAN IDs are from 1 to 1001.

no

Set the management VLAN to VLAN 1.

default

Set the management VLAN to VLAN 1.


Defaults

The default management VLAN is VLAN 1.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5)XU

This command was first introduced.


Usage Guidelines

Enter this command only on the command switch. This command changes the management VLAN of the command switch and member switches. Member switches must have either a trunk connection or connection to the new command-switch management VLAN to maintain communication with the command switch.

This command is not written to the configuration file.

Examples

This example shows how to change the management VLAN to VLAN 5 on the entire cluster.

Switch(config)# cluster management-vlan 5

You can verify the previous command by entering the show interface vlan number user EXEC command.

Related Commands

Command
Description

management

Shuts down the management VLAN interface and enables the new management VLAN interface on an individual switch.


cluster member

Use the cluster member global configuration command on the command switch to add members to a cluster. Use the no form of the command to remove members from the cluster.

cluster member [n] mac-address H.H.H [password enable-password]

no cluster member n

default cluster member n

Syntax Description

n

The number that identifies a cluster member. The range is from 0 to 15.

mac-address H.H.H

MAC address of the member switch in hexadecimal format.

password enable-password

Enable password of the candidate switch. The password is not required if there is no password on the candidate switch.

no

Remove the specified member from the cluster.

default

Remove the specified member from the cluster.


Defaults

A newly enabled command switch has no associated cluster members.

Command Modes

Global configuration

Command History

Release
Modification

11.2(8)SA6

This command was first introduced.


Usage Guidelines

Enter this command only on the command switch to add a member to or remove a member from the cluster. If you enter this command on a switch other than the command switch, the switch rejects the command and displays an error message.

You must enter a member number to remove a switch from the cluster. However, you do not need to enter a member number to add a switch to the cluster. The command switch selects the next available member number and assigns it to the switch joining the cluster.

You must enter the enable password of the candidate switch for authentication when it joins the cluster. The password is not saved in the running or startup configuration. After a candidate switch becomes a member of the cluster, its password becomes the same as the command-switch password.

If a switch does not have a configured host name, the command switch appends a member number to the command-switch host name and assigns it to the member switch.

Examples

This example shows how to add a switch as member 2 with MAC address 00E0.1E00.2222 and the password key to a cluster.

Switch(config)# cluster member 2 mac-address 00E0.1E00.2222 password key

This example shows how to add a switch with MAC address 00E0.1E00.3333 to the cluster. This switch does not have a password. The command switch selects the next available member number and assigns it to the switch joining the cluster.

Switch(config)# cluster member mac-address 00E0.1E00.3333

You can verify the previous command by entering the show cluster members command in user EXEC mode on the command switch.

Related Commands

Command
Description

show cluster

Displays the cluster status and a summary of the cluster to which the switch belongs.

show cluster candidates

Displays a list of candidate switches.

show cluster members

Displays information about the cluster members.


cluster run

Use the cluster run global configuration command to enable clustering on a switch. Use the no form of this command to disable clustering on a switch.

cluster run

no cluster run

default cluster run

Syntax Description

no

Disable clustering on a switch.

default

Enable clustering on a switch.


Defaults

Clustering is enabled on all switches.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5)XU

This command was first introduced.


Usage Guidelines

When you enter the no cluster run command on a command switch, the command switch is disabled. Clustering is disabled, and the switch is incapable of becoming a candidate switch.

When you enter the no cluster run command on a member switch, it is removed from the cluster. Clustering is disabled, and the switch is incapable of becoming a candidate switch.

When you enter the no cluster run command on a switch that is not part of a cluster, clustering is disabled on this switch. This switch cannot then become a candidate switch.

Examples

This example shows how to disable clustering on the command switch:

Switch(config)# no cluster run

You can verify the previous command by entering the show cluster command in user EXEC mode.

Related Commands

Command
Description

cluster enable

Displays the cluster status and a summary of the cluster to which the switch belongs.

show cluster

Displays the cluster status and a summary of the cluster to which the switch belongs.


cluster standby-group

Use the cluster standby-group global configuration command to enable command switch redundancy by binding the Hot Standby Router Protocol (HSRP) standby group to the cluster. Use the no form of this command to unbind the cluster from the HSRP standby group.

cluster standby-group HSRP-group-name

no cluster standby-group

default cluster standby-group

Syntax Description

HSRP-group-name

Name of the HSRP group that is bound to the cluster. The group name is limited to 32 characters.

no

Unbind the cluster from the HSRP standby group.

default

Unbind the cluster from the HSRP standby group.


Defaults

The cluster is not bound to any HSRP group.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5)XU

This command was first introduced.


Usage Guidelines

You must enter this command only on the command switch. If you enter it on a member switch, an error message appears.

The command switch propagates the cluster-HSRP binding information to all members. Each member switch stores the binding information in its nonvolatile RAM (NVRAM).

The HSRP group name must be a valid standby group; otherwise, the command exits with an error.

Examples

This example shows how to bind the HSRP group named my_hsrp to the cluster. This command is entered on the command switch.

Switch(config)# cluster standby-group my_hsrp

This example shows the error message when this command is entered on a command switch and the specified HSRP standby group does not exist:

Switch(config)# cluster standby-group my_hsrp
%ERROR: Standby group (my_hsrp) doesn't exist

This example shows the error message when this command is entered on a member switch.

Switch(config)# cluster standby-group my_hsrp
%ERROR: This command runs on a cluster command switch

You can verify the previous commands by entering the show cluster command in user EXEC mode.

Related Commands

Command
Description

standby ip

Enables HSRP on the interface.

show cluster

Displays the cluster status and a summary of the cluster to which the switch belongs.

show standby

Displays standby group information.


cluster timer

Use the cluster timer global configuration command on the command switch to set the interval in seconds between heartbeat messages. Use the no form of this command to set the interval to the default value.

cluster timer interva