Catalyst 2950 and Catalyst 2955 Switch Command Reference, 12.1(22)EA11 and Later
Catalyst 2950 and 2955 Switch Cisco IOS Commands - a through r
Downloads: This chapterpdf (PDF - 1.91MB) The complete bookPDF (PDF - 13.99MB) | Feedback

Catalyst 2950 and 2955 Cisco IOS Commands

Table Of Contents

Catalyst 2950 and 2955 Cisco IOS Commands

aaa accounting dot1x

aaa authentication dot1x

access-list (IP extended)

access-list (IP standard)

archive download-sw

archive tar

archive upload-sw

auto qos voip

boot buffersize

boot config-file

boot enable-break

boot helper

boot helper-config-file

boot manual

boot private-config-file

boot system

channel-group

channel-protocol

class

class-map

clear controllers ethernet-controller

clear controllers lre

clear controllers lre link monitor

clear controllers lre log

clear interface

clear lacp

clear lre rate selection

clear mac address-table

clear pagp

clear port-security

clear spanning-tree counters

clear spanning-tree detected-protocols

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 duplex

cpe protected

cpe shutdown

cpe speed

cpe toggle

cpe type

define interface-range

delete

deny (access-list configuration)

deny (MAC access-list configuration)

dot1x

dot1x auth-fail max-attempts

dot1x auth-fail vlan

dot1x control-direction

dot1x default

dot1x guest-vlan

dot1x host-mode

dot1x initialize

dot1x max-req

dot1x multiple-hosts

dot1x port-control

dot1x re-authenticate

dot1x re-authentication

dot1x reauthentication

dot1x timeout

duplex

errdisable detect cause

errdisable recovery

flowcontrol

hw-module slot

interface

interface port-channel

interface range

interleave

ip access-group

ip access-list

ip address

ip dhcp snooping

ip dhcp snooping information option

ip dhcp snooping information option allow-untrusted

ip dhcp snooping limit rate

ip dhcp snooping trust

ip dhcp snooping vlan

ip igmp filter

ip igmp max-groups

ip igmp profile

ip igmp snooping

ip igmp snooping mrouter learn pim v2

ip igmp snooping report-suppression

ip igmp snooping source-only-learning

ip igmp snooping vlan

ip igmp snooping vlan immediate-leave

ip igmp snooping vlan last-member-query interval

ip igmp snooping vlan mrouter

ip igmp snooping vlan static

ip ssh

lacp port-priority

lacp system-priority

link monitor

link monitor logging

link monitor threshold rserr

link monitor threshold snr

local duplex

local speed

logging lre

lre profile

lre rate selection sequence

lre sequence

lre syslog

lre upbo

lre upgrade default family

mac access-group

mac access-list extended

mac address-table aging-time

mac address-table notification

mac address-table static

mac address-table static drop

macro apply

macro description

macro global

macro global description

macro name

margin

match

media-type

mls qos cos

mls qos map

mls qos trust

monitor session

mvr

mvr immediate

mvr type

mvr vlan group

pagp learn-method

pagp port-priority

permit (access-list configuration)

permit (MAC access-list configuration)

persistence

police

policy-map

port-channel load-balance

profile (interface configuration)

profile (sequence configuration)

rate selection

rate selection profile lock

rate selection sequence

rcommand

remote-span

rmon collection stats


Catalyst 2950 and 2955 Cisco IOS Commands


aaa accounting dot1x

Use the aaa accounting dot1x global configuration command to enable authentication, authorization, and accounting (AAA) accounting and to create method lists defining specific accounting methods on a per-line or per-interface basis for IEEE 802.1x sessions. Use the no form of this command to disable IEEE 802.1x accounting.

aaa accounting dot1x {name | default} start-stop {broadcast group {name | radius | tacacs+} [group {name | radius | tacacs+} ... ] | group {name | radius | tacacs+} [group {name | radius | tacacs+} ...]}

no aaa accounting dot1x {name | default}

Syntax Description

name

Name of a server group. This is optional when you enter it after the broadcast group and group keywords.

default

Use the accounting methods that follow as the default list for accounting services.

start-stop

Send a start accounting notice at the beginning of a process and a stop accounting notice at the end of a process. The start accounting record is sent in the background. The requested-user process begins regardless of whether or not the start accounting notice was received by the accounting server.

broadcast

Enable accounting records to be sent to multiple AAA servers and send accounting records to the first server in each group. If the first server is unavailable, the switch uses the list of backup servers to identify the first server.

group

Specify the server group to be used for accounting services. These are valid server group names:

name—Name of a server group.

radius—List of all RADIUS hosts.

tacacs+—List of all TACACS+ hosts.

The group keyword is optional when you enter it after the broadcast group and group keywords. You can enter more than optional group keyword.

radius

(Optional) Enable RADIUS authorization.

tacacs+

(Optional) Enable TACACS+ accounting.


Defaults

AAA accounting is disabled.

Command Modes

Global configuration

Command History

Release
Modification

12.1(20)EA2

This command was introduced.


Usage Guidelines

This command requires access to a RADIUS server.


Note We recommend that you enter the dot1x re-authentication interface configuration command before configuring IEEE 802.1x RADIUS accounting on an interface.


Examples

This example shows how to configure IEEE 802.1x accounting:

Switch(config)# aaa new model
Switch(config)# aaa accounting dot1x default start-stop group radius


Note The RADIUS authentication server must be properly configured to accept and log update or watchdog packets from the AAA client.


Related Commands

Command
Description

aaa authentication dot1x

Specifies one or more AAA methods for use on interfaces running IEEE 802.1x.

dot1x reauthentication

Enables or disables periodic re-authentication.

dot1x timeout reauth-period

Sets the number of seconds between re-authentication attempts.


aaa authentication dot1x

Use the aaa authentication dot1x global configuration command to specify the authentication, authorization, and accounting (AAA) method to use on ports complying with IEEE 802.1x authentication. Use the no form of this command to disable authentication.

aaa authentication dot1x {default} method1

no aaa authentication dot1x {default}

Syntax Description

default

Use the listed authentication method that follows this argument as the default method when a user logs in.

method1

Enter the group radius keywords to use the list of all RADIUS servers for authentication.



Note Though other keywords are visible in the command-line help strings, only the default and group radius keywords are supported.


Defaults

No authentication is performed.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

The method argument identifies the method that the authentication algorithm tries in the given sequence to validate the password provided by the client. The only method that is truly IEEE 802.1x-compliant is the group radius method, in which the client data is validated against a RADIUS authentication server.

If you specify group radius, you must configure the RADIUS server by entering the radius-server host global configuration command.

Use the show running-config privileged EXEC command to display the configured lists of authentication methods.

Examples

This example shows how to enable AAA and how to create an IEEE 802.1x-compliant authentication list. This authentication first tries to contact a RADIUS server. If this action returns an error, the user is not allowed access to the network.

Switch(config)# aaa new model
Switch(config)# aaa authentication dot1x default group radius

You can verify your settings by entering the show running-config privileged EXEC command.

Related Commands

Command
Description

aaa new-model

Enables the AAA access control model. For syntax information, select Cisco IOS Security Command Reference for Release 12.1 > Authentication, Authorization, and Accounting > Authentication Commands.

show running-config

Displays the configuration information running on the switch. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


access-list (IP extended)

Use the extended version of the access-list global configuration command to configure an extended IP access control list (ACL). Use the no form of this command to remove an extended IP ACL.

access-list access-list-number {deny | permit | remark} protocol {source source-wildcard | host source | any} [operator port] {destination destination-wildcard | host destination | any} [operator port] [dscp dscp-value] [time-range time-range-name]

no access-list access-list-number

This command is available on physical interfaces only if your switch is running the enhanced software image (EI).

Syntax Description

access-list-number

Number of an ACL. The range is 100 to 199 and 2000 to 2699.

protocol

Name of an IP protocol.

protocol can be ip, tcp, or udp.

deny

Deny access if conditions are matched.

permit

Permit access if conditions are matched.

remark

ACL entry comment up to 100 characters.

source source-wildcard | host source | any

Define a source IP address and wildcard.

The source is the source address of the network or host from which the packet is being sent, specified in one of these ways:

The 32-bit quantity in dotted-decimal format. The source-wildcard applies wildcard bits to the source.

The keyword host, followed by the 32-bit quantity in dotted-decimal format, as an abbreviation for source and source-wildcard of source 0.0.0.0.

The keyword any as an abbreviation for source and source-wildcard of 0.0.0.0 255.255.255.255. You do not need to enter a source-wildcard.

destination destination-wildcard | host destination | any

Define a destination IP address and wildcard.

The destination is the destination address of the network or host to which the packet is being sent, specified in one of these ways:

The 32-bit quantity in dotted-decimal format. The destination-wildcard applies wildcard bits to the destination.

The keyword host, followed by the 32-bit quantity in dotted-decimal format, as an abbreviation for destination and destination-wildcard of destination 0.0.0.0.

The keyword any as an abbreviation for destination and destination-wildcard of 0.0.0.0 255.255.255.255. You do not need to enter a destination-wildcard.

operator port

(Optional) Define a source or destination port.

The operator can be only eq (equal).

If operator is after the source IP address and wildcard, conditions match when the source port matches the defined port.

If operator is after the destination IP address and wildcard, conditions match when the destination port matches the defined port.

The port is a decimal number or name of a TCP or User Datagram Protocol (UDP) port. The number can be from 0 to 65535.

Use TCP port names only for TCP traffic.

Use UDP port names only for UDP traffic.

dscp dscp-value

(Optional) Define a Differentiated Services Code Point (DSCP) value to classify traffic.

For the dscp-value, enter any of the 13 supported DSCP values (0, 8, 10, 16, 18, 24, 26, 32, 34, 40, 46, 48, and 56), or use the question mark (?) to see a list of available values.

time-range time-range-name

(Optional) For the time-range keyword, enter a meaningful name to identify the time range. For a more detailed explanation of this keyword, see the software configuration guide.


Defaults

The default extended ACL is always terminated by an implicit deny statement for all packets.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

Plan your access conditions carefully. The ACL is always terminated by an implicit deny statement for all packets.

You can use ACLs to control virtual terminal line access by controlling the transmission of packets on an interface.

Extended ACLs support only the TCP and UDP protocols.

Use the show ip access-lists command to display the contents of IP ACLs.

Use the show access-lists command to display the contents of all ACLs.


Note For more information about configuring IP ACLs, see the "Configuring Network Security with ACLs" chapter in the software configuration guide for this release.


Examples

This example shows how to configure an extended IP ACL that allows only TCP traffic to the destination IP address 128.88.1.2 with a TCP port number of 25 and how to apply it to an interface:

Switch(config)# access-list 102 permit tcp any host 128.88.1.2 eq 25
Switch(config)# interface fastethernet0/8
Switch(config-if)# ip access-group 102 in

This is an example of an extended ACL that allows TCP traffic only from two specified networks. The wildcard bits apply to the host portions of the network addresses. Any host with a source address that does not match the ACL statements is denied.

access-list 104 permit tcp 192.5.0.0 0.0.255.255 any
access-list 104 permit tcp 128.88.0.0 0.0.255.255 any


Note In these examples, all other IP access is implicitly denied.


You can verify your settings by entering the show ip access-lists or show access-lists privileged EXEC command.

Related Commands

Command
Description

access-list (IP standard)

Configures a standard IP ACL.

ip access-group

Controls access to an interface.

show access-lists

Displays ACLs configured on the switch.

show ip access-lists

Displays IP ACLs configured on the switch.


access-list (IP standard)

Use the standard version of the access-list global configuration command to configure a standard IP access control list (ACL). Use the no form of this command to remove a standard IP ACL.

access-list access-list-number {deny | permit | remark} {source source-wildcard | host source | any}

no access-list access-list-number

This command is available on physical interfaces only if your switch is running the enhanced software image (EI).

Syntax Description

access-list-number

Number of an ACL. The range is 1 to 99 and1300 to 1999.

deny

Deny access if conditions are matched.

permit

Permit access if conditions are matched.

remark

ACL entry comment up to 100 characters.

source source-wildcard | host source | any

Define a source IP address and wildcard.

The source is the source address of the network or host from which the packet is being sent, specified in one of these ways:

The 32-bit quantity in dotted-decimal format. The source-wildcard applies wildcard bits to the source.

The keyword host, followed by the 32-bit quantity in dotted-decimal format, as an abbreviation for source and source-wildcard of source 0.0.0.0.

The keyword any as an abbreviation for source and source-wildcard of 0.0.0.0 255.255.255.255. You do not need to enter a source-wildcard.


Defaults

The default standard ACL is always terminated by an implicit deny statement for all packets.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

Plan your access conditions carefully. The ACL is always terminated by an implicit deny statement for all packets.

You can use ACLs to control virtual terminal line access by controlling the transmission of packets on an interface.

Use the show ip access-lists command to display the contents of IP ACLs.

Use the show access-lists command to display the contents of all ACLs.


Note For more information about configuring IP ACLs, see the "Configuring Network Security with ACLs" chapter in the software configuration guide for this release.


Examples

This example shows how to configure a standard IP ACL that allows only traffic from the host network 128.88.1.10 and how to apply it to an interface:

Switch(config)# access-list 12 permit host 128.88.1.10
Switch(config)# interface gigabitethernet0/1
Switch(config-if)# ip access-group 12 in

This is an example of an standard ACL that allows traffic only from three specified networks. The wildcard bits apply to the host portions of the network addresses. Any host with a source address that does not match the ACL statements is denied.

access-list 14 permit 192.5.34.0  0.0.0.255
access-list 14 permit 128.88.0.0  0.0.0.255
access-list 14 permit 36.1.1.0  0.0.0.255


Note In these examples, all other IP access is implicitly denied.


You can verify your settings by entering the show ip access-lists or show access-lists privileged EXEC command.

Related Commands

Command
Description

access-list (IP extended)

Configures an extended IP ACL.

ip access-group

Controls access to an interface.

show access-lists

Displays ACLs configured on the switch.

show ip access-lists

Displays IP ACLs configured on the switch.


archive download-sw

Use the archive download-sw privileged EXEC command to download a new image from a TFTP server to a Catalyst 2950 Long-Reach Ethernet (LRE) switch and to overwrite or to keep the existing image.

archive download-sw {/force-reload | /imageonly | /leave-old-sw | /no-set-boot | /overwrite | /reload | /safe} source-url

This command is available only on the Catalyst 2950 LRE switches.

Syntax Description

/force-reload

Unconditionally force a system reload after successfully downloading the software image.

/imageonly

Download only the software image but not the files associated with the device manager. The device manager files for the existing version are deleted only if the existing version is being overwritten or removed.

/leave-old-sw

Keep the old software version after a successful download.

/no-set-boot

Do not alter the setting of the BOOT environment variable to point to the new software image after it is successfully downloaded.

/overwrite

Overwrite the software image in flash memory with the downloaded image.

/reload

Reload the system after successfully downloading the image unless the configuration has been changed and not been saved.

/safe

Keep the current software image; do not delete it to make room for the new software image before the new image is downloaded. The current image is deleted after the download.

source-url

The source URL alias for a local or network file system. These options are supported:

The syntax for the local flash file system:
flash:

The syntax for the FTP: ftp:[[//username[:password]@location]/directory]/image-name.tar

The syntax for the Remote Copy Protocol (RCP): rcp:[[//username@location]/directory]/image-name.tar

The syntax for the TFTP: tftp:[[//location]/directory]/image-name.tar

The image-name.tar is the software image to download and install on the switch.


Defaults

Both the software image and device manager files are downloaded.

The new image is downloaded to the flash: file system.

The BOOT environment variable is changed to point to the new software image on the flash: file system.

Image names are case sensitive; the image file is provided in tar format.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Use the /overwrite option to overwrite the image on the flash device with the downloaded one.

If the flash device has sufficient space to hold two images and you want to overwrite one of these images with the same version, you must specify the /overwrite option.

If you specify the command without the /overwrite option, the download algorithm verifies that the new image is not the same as the one on the switch flash device. If the images are the same, the download does not occur. If the images are different, the old image is deleted, and the new one is downloaded.

The /imageonly option removes the device manager files for the existing image if the existing image is being removed or replaced. Only the software image (without the device manager files) is downloaded.

Using the /safe or /leave-old-sw option can cause the new image download to fail if there is insufficient flash space.

If you used the /leave-old-sw option and did not overwrite the old image when you downloaded the new one, you can remove the old image by using the delete privileged EXEC command. For more information, see the delete command.

If you leave the existing software in place before downloading the new image, an error results if the existing software prevents the new image from fitting onto flash memory.

After downloading a new image, enter the reload privileged EXEC command to begin using the new image, or specify the /reload or /force-reload option in the archive download-sw command.

Examples

This example shows how to download a new image from a TFTP server at 172.20.129.10 and to overwrite the image on the switch:

Switch# archive download-sw /overwrite tftp://172.20.129.10/test-image.tar 

This example shows how to download only the software image from a TFTP server at 172.20.129.10 to the switch:

Switch# archive download-sw /imageonly tftp://172.20.129.10/test-image.tar 

This example shows how to keep the old software version after a successful download:

Switch# archive download-sw /leave-old-sw tftp://172.20.129.10/test-image.tar 

Related Commands

Command
Description

archive tar

Creates a tar file, lists the files in a tar file, or extracts the files from a tar file.

archive upload-sw

Uploads an existing image on the switch to a server.

delete

Deletes a file or directory on the flash memory device.


archive tar

Use the archive tar privileged EXEC command to create a tar file, to list files in a tar file, or to extract the files from a tar file.

archive tar {/create destination-url flash:/file-url} | {/table source-url} | {/xtract source-url flash:/file-url [dir/file...]}

Syntax Description

/create destination-url flash:/file-url

Create a new tar file on the local or network file system.

For destination-url, specify the destination URL alias for the local or network file system and the name of the tar file to create. These options are supported:

The syntax for the local flash file system:
flash:

The syntax for the FTP: ftp:[[//username[:password]@location]/directory]/tar-filename.tar

The syntax for the Remote Copy Protocol (RCP) is: rcp:[[//username@location]/directory]/tar-filename.tar

The syntax for the TFTP: tftp:[[//location]/directory]/tar-filename.tar

The tar-filename.tar is the tar file to be created.

For flash:/file-url, specify the location on the local flash file system from which the new tar file is created.

An optional list of files or directories within the source directory can be specified to write to the new tar file. If none are specified, all files and directories at this level are written to the newly created tar file.

/table source-url

Display the contents of an existing tar file to the screen.

For source-url, specify the source URL alias for the local or network file system. These options are supported:

The syntax for the local flash file system:
flash:

The syntax for the FTP: ftp:[[//username[:password]@location]/directory]/tar-filename.tar

The syntax for the RCP: rcp:[[//username@location]/directory]/tar-filename.tar

The syntax for the TFTP: tftp:[[//location]/directory]/tar-filename.tar

The tar-filename.tar is the tar file to display.

/xtract source-url flash:/file-url [dir/file...]

Extract files from a tar file to the local file system.

For source-url, specify the source URL alias for the local file system. These options are supported:

The syntax for the local flash file system:
flash:

The syntax for the FTP: ftp:[[//username[:password]@location]/directory]/tar-filename.tar

The syntax for the RCP: rcp:[[//username@location]/directory]/tar-filename.tar

The syntax for the TFTP: tftp:[[//location]/directory]/tar-filename.tar

The tar-filename.tar is the tar file from which to extract.

For flash:/file-url [dir/file...], specify the location on the local flash file system into which the tar file is extracted. Use the dir/file... option to specify an optional list of files or directories within the tar file to be extracted. If none are specified, all files and directories are extracted.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

Filenames and directory names are case sensitive.

Image names are case sensitive.

Examples

This example shows how to create a tar file. The command writes the contents of the new-configs directory on the local flash device to a file named saved.tar on the TFTP server at 172.20.136.9:

Switch# archive tar /create tftp:172.20.136.9/saved.tar flash:/new-configs

This example shows how to display the contents of the saved.tar file that is in flash memory. The contents of the tar file appear on the screen.

Switch # archive tar /table tftp://172.20.136.9/saved.tar
Loading saved.tar from 172.20.136.9 (via Vlan1):!
info (247 bytes)
c2950lre-i6l2q4-mz.121/ (directory)
c2950lre-i6l2q4-mz.121/html/ (directory)
c2950lre-i6l2q4-mz.121/html/homepage.htm (3990 bytes)!

<output truncated>

c2950lre-i6l2q4-mz.121/lre-bin/CISCO585-LRE_MC8051boot_01.03.00.bin (688
bytes)
c2950lre-i6l2q4-mz.121/lre-bin/CISCO585-LRE_vdslsngl_51.00.00.bin (8896
bytes)!!
c2950lre-i6l2q4-mz.121/pef22824.bin (32768 bytes)!!!!!!!
c2950lre-i6l2q4-mz.121/info (247 bytes)
info.ver (247 bytes)
[OK - 4279808/8559616 bytes]

This example shows how to extract the contents of a tar file on the TFTP server at 172.20.10.30. This command extracts just the new-configs directory into the root directory on the local flash file system. The remaining files in the saved.tar file are ignored.

Switch# archive tar /xtract tftp://172.20.10.30/saved.tar flash:/ new-configs

Related Commands

Command
Description

archive download-sw

Downloads a new image to the switch.

archive upload-sw

Uploads an existing image on the switch to a server.


archive upload-sw

Use the archive upload-sw privileged EXEC command to upload an existing Long-Reach Ethernet (LRE) switch image to a server.

archive upload-sw [/version version_string] destination-url

This command is supported only on Catalyst 2950 LRE switches.

Syntax Description

/version version_string

(Optional) Specify the version string of the image to be uploaded.

destination-url

The destination URL alias for a local or network file system. These options are supported:

The syntax for the local flash file system:
flash:

The syntax for the FTP: ftp:[[//username[:password]@location]/directory]/image-name.tar

The syntax for the Remote Copy Protocol (RCP): rcp:[[//username@location]/directory]/image-name.tar

The syntax for the TFTP:

tftp:[[//location]/directory]/image-name.tar

The image-name.tar is the name of software image to be stored on the server.


Defaults

The switch uploads the currently running image from the flash: file system.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Use the upload feature only if the files associated with the device manager have been installed with the existing image.

The files are uploaded in this sequence: info, the software image, the device manager files, LRE binary files, and info.ver. After these files are uploaded, the software creates the tar file.

Image names are case sensitive.

Examples

This example shows how to upload the currently running image to a TFTP server at 172.20.140.2:

Switch# archive upload-sw tftp://172.20.140.2/test-image.tar 

Related Commands

Command
Description

archive download-sw

Downloads a new image to a Catalyst 2950 LRE switch.

archive tar

Creates a tar file, lists the files in a tar file, or extracts the files from a tar file.


auto qos voip

Use the auto qos voip interface configuration command to configure automatic quality of service (auto-QoS) for voice over IP (VoIP) within a QoS domain. Use the no form of this command to change the auto-QoS configuration settings to the standard-QoS defaults.

auto qos voip {cisco-phone | cisco-softphone | trust}

no auto qos voip

This command is available only if your switch is running the enhanced software image (EI).

Syntax Description

cisco-phone

Identify this interface as connected to a Cisco IP phone, and automatically configure QoS for VoIP. The QoS labels of incoming packets are trusted only when the phone is detected.

cisco-softphone

Identify this port as connected to a device running the Cisco SoftPhone, and automatically configure QoS for VoIP.

trust

Identify this interface as connected to a trusted switch or router. The QoS labels of incoming packets are trusted.


Defaults

Auto-QoS is disabled on all interfaces.

When auto-QoS is enabled, it uses the ingress packet label to categorize traffic and to configure the egress queues as summarized in Table 2-1.

Table 2-1 Traffic Types, Packet Labels, and Egress Queues

 
VoIP Data Traffic
VoIP Control Traffic
Routing Protocol Traffic
STP 1 BPDU 2 Traffic
Real-Time Video Traffic
All Other Traffic

DSCP3

46

24, 26

48

56

34

CoS

5

3

6

7

4

CoS-to-Queue Map

5

3, 6, 7

4

2

0, 1

Egress Queue

1% WRR4 (queue 4)

70% WRR (queue 3)

20% WRR (queue 2)

20% WRR (queue 2)

10% WRR (queue 1)

1 STP = Spanning Tree Protocol

2 BPDU = bridge protocol data unit

3 DSCP = Differentiated Services Code Point

4 WRR = weighted round robin


Table 2-2 lists the auto-QoS configuration for the egress queues.

Table 2-2 Auto-QoS Configuration for the Egress Queues

Egress Queue
Queue Number
CoS-to-Queue Map
Queue Weight

1% WRR

4

5

1 percent

70% WRR

3

3, 6, 7

70 percent

20% WRR

2

2, 4

20 percent

10% WRR

1

0, 1

10 percent


Command Modes

Interface configuration

Command History

Release
Modification

12.1(12c)EA1

This command was introduced.

12.1(20)EA2

The cisco-softphone keyword was added, and the generated auto-QoS configuration changed.


Usage Guidelines

Use this command to configure the QoS that is appropriate for VoIP traffic within the QoS domain. The QoS domain includes the switch, the interior of the network, and the edge devices that can classify incoming traffic for QoS.

In releases earlier than Cisco IOS Release 12.2(20)EA2, auto-QoS configures the switch only for VoIP with Cisco IP Phones on switch ports.

In Cisco IOS Release 12.2(20)EA2 or later, auto-QoS configures the switch for VoIP with Cisco IP Phones and for VoIP with devices running the Cisco SoftPhone application. These releases support only Cisco IP SoftPhone Version 1.3(3) or later. Connected devices must use Cisco Call Manager Version 4 or later.

To take advantage of the auto-QoS defaults, you should enable auto-QoS before you configure other QoS commands. You can fine-tune the auto-QoS configuration after you enable auto-QoS.


Note The switch applies the auto-QoS-generated commands as if the commands were entered from the command-line interface (CLI). An existing user configuration can cause the application of the generated commands to fail or to be overridden by the generated commands. These actions occur without warning. If all the generated commands are successfully applied, any user-entered configuration that was not overridden remains in the running configuration. Any user-entered configuration that was overridden can be retrieved by reloading the switch without saving the current configuration to memory. If the generated commands fail to be applied, the previous running configuration is restored.


If this is the first port on which you have enabled auto-QoS, the auto-QoS-generated global configuration commands are executed followed by the interface configuration commands. If you enable auto-QoS on another port, only the auto-QoS-generated interface configuration commands for that port are executed.

When you enable the auto-QoS feature on the first interface, these automatic actions occur:

When you enter the auto qos voip cisco-phone interface configuration command on a port at the edge of the network that is connected to a Cisco IP Phone, the switch enables the trusted boundary feature. The switch uses the Cisco Discovery Protocol (CDP) to detect the presence or absence of a Cisco IP Phone. When a Cisco IP Phone is detected, the ingress classification on the interface is set to trust the QoS label received in the packet. When a Cisco IP Phone is absent, the ingress classification is set to not trust the QoS label in the packet. The egress queues on the interface are also reconfigured (see Table 2-2).

When you enter the auto qos voip cisco-softphone interface configuration command on a port at the edge of the network that is connected to a device running the Cisco SoftPhone, the switch uses policing to decide whether a packet is in or out of profile and to specify the action on the packet. If the packet does not have a DSCP value of 24, 26, or 46 or is out of profile, the switch changes the DSCP value to 0. The egress queues on the interface are also reconfigured (see Table 2-2).

When you enter the auto qos voip trust interface configuration command on a port connected to the interior of the network, the ingress classification on the interface is set to trust the QoS label received in the packet, and the egress queues on the interface are reconfigured (see Table 2-2).

You can enable auto-QoS on static, dynamic-access, voice VLAN access, and trunk ports.


Note When a device running Cisco SoftPhone is connected to a switch or routed port, the switch supports only one Cisco SoftPhone application per port.


After auto-QoS is enabled, do not modify a policy map or aggregate policer that includes AutoQoS in its name. If you need to modify the policy map or aggregate policer, make a copy of it, and change the copied policy map or policer. To use the new policy map instead of the generated one, remove the generated policy, and apply the new policy map.

To display the QoS configuration that is automatically generated when auto-QoS is enabled, enable debugging before you enable auto-QoS. Use the debug auto qos privileged EXEC command to enable auto-QoS debugging.

To disable auto-QoS on an interface, use the no auto qos voip interface configuration command. When you enter this command, the switch changes the auto-QoS settings to the standard-QoS default settings for that interface.

To disable auto-QoS on the switch and return to the default port trust state (untrusted), follow these steps:

1. Use the no auto qos voip interface configuration command on all interfaces on which auto-QoS is enabled. To disable auto-QoS on multiple interfaces at the same time, you can use the interface range global configuration command.

2. After disabling auto-QoS on all interfaces on which auto-QoS was enabled, return the egress queues and CoS-to-DSCP map to the default settings by using these global configuration commands:

no wrr-queue bandwidth

no wrr-queue cos-map

no mls qos map cos-dscp

Examples

This example shows how to enable auto-QoS and to trust the QoS labels received in incoming packets when the switch or router connected to a port is a trusted device:

Switch(config)# interface gigabitethernet0/1
Switch(config-if)# auto qos voip trust

This example shows how to enable auto-QoS and to trust the QoS labels received in incoming packets when the device connected to a port is detected as a Cisco IP phone:

Switch(config)# interface fastethernet0/1
Switch(config-if)# auto qos voip cisco-phone

This example shows how to display the QoS configuration that is automatically generated when auto-QoS is enabled:

Switch# debug auto qos
AutoQoS debugging is on
Switch# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Switch(config)# interface fastethernet0/1
Switch(config-if)# auto qos voip cisco-phone
00:02:54:wrr-queue bandwidth 10 20 70 1
00:02:55:no wrr-queue cos-map
00:02:55:wrr-queue cos-map 1 0 1
00:02:56:wrr-queue cos-map 2 2 4
00:02:57:wrr-queue cos-map 3 3 6 7
00:02:58:wrr-queue cos-map 4 5
00:02:59:mls qos map cos-dscp 0 8 16 26 32 46 48 56
00:03:00:interface FastEthernet0/1
00:03:00: mls qos trust device cisco-phone
00:03:00: mls qos trust cos
Switch(config-if)# interface fastethernet0/2
Switch(config-if)# auto qos voip trust
00:03:15:interface FastEthernet0/2
00:03:15: mls qos trust cos
Switch(config-if)#

You can verify your settings by entering the show auto qos interface interface-id privileged EXEC command.

Related Commands

Command
Description

debug auto qos

Enable debugging of the auto-QoS feature.

mls qos map

Defines the CoS-to-DSCP map or the DSCP-to-CoS map.

mls qos trust

Configures the port trust state.

show auto qos

Displays auto-QoS information.

show mls qos maps

Displays QoS mapping information.

show mls qos interface

Displays QoS information at the interface level.


boot buffersize

Use the boot buffersize global configuration command to specify the size of the file system-simulated NVRAM in flash memory. The buffer holds a copy of the configuration file in memory. Use the no form of this command to return to the default setting.

boot buffersize size

no boot buffersize

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

size

The buffer allocation size in bytes. The range is 4096 to 524288 bytes.


Defaults

The default is 32 KB.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

The configuration file cannot be larger than the buffer size allocation.

You must reload the switch by using the reload privileged EXEC command for this command to take effect.

This command changes the setting of the CONFIG_BUFSIZE environment variable. For more information, see Appendix B, "Catalyst 2950 and 2955 Switch Boot Loader Commands."

Related Commands

Command
Description

show boot

Displays the settings of the boot environment variables.


boot config-file

Use the boot config-file global configuration command to specify the filename that the software uses to read and write a nonvolatile copy of the system configuration. Use the no form of this command to return to the default setting.

boot config-file flash:/file-url

no boot config-file

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

flash:/file-url

The path (directory) and name of the configuration file.


Defaults

The default configuration file is flash:config.text.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Filenames and directory names are case sensitive.

This command changes the setting of the CONFIG_FILE environment variable. For more information, see Appendix B, "Catalyst 2950 and 2955 Switch Boot Loader Commands."

Related Commands

Command
Description

show boot

Displays the settings of the boot environment variables.


boot enable-break

Use the boot enable-break global configuration command to enable interrupting the automatic boot process on a Catalyst 2950 Long-Reach Ethernet (LRE) switch. Use the no form of this command to return to the default setting.

boot enable-break

no boot enable-break

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

This command has no arguments or keywords.

Defaults

The automatic start up process cannot be interrupted by pressing the Break key on the console.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

When you enter this command, you can interrupt the automatic boot process by pressing the Break key on the console after the flash file system is initialized.


Note Despite the setting of this command, you can interrupt the automatic boot process at any time by pressing the MODE button on the switch front panel.


This command changes the setting of the ENABLE_BREAK environment variable. For more information, see Appendix B, "Catalyst 2950 and 2955 Switch Boot Loader Commands."

Related Commands

Command
Description

show boot

Displays the settings of the boot environment variables.


boot helper

Use the boot helper global configuration command to dynamically load files during boot loader initialization to extend or to patch the functionality of the boot loader. Use the no form of this command to return to the default setting.

boot helper filesystem:/file-url ...

no boot helper

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

filesystem:

Alias for a flash file system. Use flash: for the system board flash device.

/file-url

The path (directory) and a list of loadable files to dynamically load during loader initialization. Separate each image name with a semicolon.


Defaults

No helper files are loaded.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Filenames and directory names are case sensitive.

This command changes the setting of the HELPER environment variable. For more information, see Appendix B, "Catalyst 2950 and 2955 Switch Boot Loader Commands."

Related Commands

Command
Description

show boot

Displays the settings of the boot environment variables.


boot helper-config-file

Use the boot helper-config-file global configuration command to specify the name of the configuration file to be used by the Cisco IOS helper image. If this is not set, the file specified by the CONFIG_FILE environment variable is used by all versions of the software that are loaded. This variable is used only for internal development and testing. Use the no form of this command to return to the default setting.

boot helper-config-file filesystem:/file-url

no boot helper-config file

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

filesystem:

Alias for a flash file system. Use flash: for the system board flash device.

/file-url

The path (directory) and helper configuration file to load.


Defaults

No helper configuration file is specified.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Filenames and directory names are case sensitive.

This command changes the setting of the HELPER_CONFIG_FILE environment variable. For more information, see Appendix B, "Catalyst 2950 and 2955 Switch Boot Loader Commands."

Related Commands

Command
Description

show boot

Displays the settings of the boot environment variables.


boot manual

Use the boot manual global configuration command to enable starting the Catalyst 2950 Long-Reach Ethernet (LRE) switch manually during the next power on cycle. Use the no form of this command to return to the default setting.

boot manual

no boot manual

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

This command has no arguments or keywords.

Defaults

During the next power on cycle, you cannot manually start an LRE switch.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

The next time you restart the system, the switch is in boot loader mode, which is shown by the switch: prompt. To power on the system, use the boot boot loader command, and specify the name of the bootable image.

This command changes the setting of the MANUAL_BOOT environment variable. For more information, see Appendix B, "Catalyst 2950 and 2955 Switch Boot Loader Commands."

Related Commands

Command
Description

show boot

Displays the settings of the boot environment variables.


boot private-config-file

Use the boot private-config-file global configuration command to specify the filename that the software uses to read and write a nonvolatile copy of the private configuration. Use the no form of this command to return to the default setting.

boot private-config-file filename

no boot private-config-file

Syntax Description

filename

The name of the private configuration file.


Defaults

The default configuration file is private-config.text.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)EA1

This command was introduced.


Usage Guidelines

Only the software can read and write a copy of the private configuration file. You cannot read, write, delete, or display a copy of this file.

Filenames are case sensitive.

Examples

This example shows how to specify the name of the private configuration file as pconfig:

Switch(config)# boot private-config-file pconfig

Related Commands

Command
Description

show boot

Displays the settings of the boot environment variables.


boot system

Use the boot system global configuration command to specify the software image to load during the next power on cycle. Use the no form of this command to return to the default setting.

boot system filesystem:/file-url ...

no boot system

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

filesystem:

Alias for a flash file system. Use flash: for the system board flash device.

/file-url

The path (directory) and name of a bootable image. Separate image names with a semicolon.


Defaults

The switch attempts to automatically power on the system by using information in the BOOT environment variable. If this variable is not set, the switch attempts to load and execute the first executable image it can by performing a recursive, depth-first search throughout the flash file system. In a depth-first search of a directory, each encountered subdirectory is completely searched before the switch continues to search in the original directory.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Filenames and directory names are case sensitive.

If you are using the archive download-sw privileged EXEC command to maintain system images, you do not ever need to use the boot system command. The boot system command is automatically manipulated to load the downloaded image.

This command changes the setting of the BOOT environment variable. For more information, see Appendix B, "Catalyst 2950 and 2955 Switch Boot Loader Commands."

Related Commands

Command
Description

show boot

Displays the settings of the boot environment variables.


channel-group

Use the channel-group interface configuration command to assign an Ethernet interface to an EtherChannel group and to enable an EtherChannel mode. Use the no form of this command to remove an Ethernet interface from an EtherChannel group.

channel-group channel-group-number mode {active | {auto [non-silent]} | {desirable [non-silent]} | on | passive}

no channel-group

PAgP modes:
channel-group channel-group-number mode {{auto [non-silent]} | {desirable [non-silent}}

LACP modes:
channel-group channel-group-number mode {active | passive}

On mode:
channel-group channel-group-number mode on

Syntax Description

channel-group-number

Specify the channel group number. The range is 1 to 6.

mode

Specify the EtherChannel Port Aggregation Protocol (PAgP) or Link Aggregration Control Protocol (LACP). mode of the interface.

active

Unconditionally enable LACP.

Active mode places an interface into a negotiating state in which the interface initiates negotiations with other interfaces by sending LACP packets. A channel is formed with another port group in either the active or passive mode. When active is enabled, silent operation is the default.

auto

Enable PAgP only if a PAgP device is detected.

Auto mode places an interface into a passive negotiating state, in which the interface responds to PAgP packets it receives but does not initiate PAgP packet negotiation. A channel is formed only with another port group in desirable mode. When auto is enabled, silent operation is the default.

desirable

Unconditionally enable PAgP.

Desirable mode places an interface into a negotiating state in which the interface initiates negotiations with other interfaces by sending PAgP packets. A channel is formed with another port group in either the desirable or auto mode. When desirable is enabled, silent operation is the default.

non-silent

(Optional) Used with the auto or desirable keyword when PAgP traffic is expected from the other device.

on

Enable on mode.

In on mode, a usable EtherChannel exists only when both connected port groups are in the on mode.

This mode is not available on Long-Reach Ethernet (LRE) switches, because LRE interfaces do not support an EtherChannel-only mode.

passive

Enable LACP only if an LACP device is detected.

Passive mode places an interface into a negotiating state in which the interface responds to LACP packets it receives but does not initiate LACP packet negotiation. A channel is formed only with another port group in active mode. When passive is enabled, silent operation is the default.


Defaults

No channel groups are assigned.

There is no default mode.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced. It replaced the port group command.

12.1(12c)EA1

The active and passive keywords were added.


Usage Guidelines

You must specify the mode when entering this command. If the mode is not entered, an Ethernet interface is not assigned to an EtherChannel group, and an error message appears.

You do not have to create a port-channel interface before assigning a physical interface to a channel group. A port-channel interface is created automatically when the channel group gets its first physical interface.

You do not have to disable the IP address that is assigned to a physical interface that is part of a channel group, but we highly recommend that you do so.

You can create port channels by entering the interface port-channel global configuration command or when the channel group gets its first physical interface assignment. The port channels are not created at runtime or dynamically.

Any configuration or attribute changes you make to the port-channel interface are propagated to all interfaces within the same channel group as the port channel (for example, configuration changes are also propagated to the physical interfaces that are not part of the port channel, but are part of the channel group).

In the on mode, a PAgP EtherChannel exists only when a port group in on mode is connected to another port group in on mode.

If you do not specify non-silent with the auto or desirable mode, silent is assumed. The silent mode is used when the switch is connected to a device that is not PAgP-capable and seldom, if ever, sends packets. An example of a silent partner is a file server or a packet analyzer that is not generating traffic. In this case, running PAgP on a physical port prevents that port from ever becoming operational; however, it allows PAgP to operate, to attach the interface to a channel group, and to use the interface for transmission. Both ends of the link cannot be set to silent.


Note You cannot enable both PAgP and LACP modes on an EtherChannel group.



Caution You should use care when using the on mode. This is a manual configuration, and ports on both ends of the EtherChannel must have the same configuration. If the group is misconfigured, packet loss or spanning-tree loops can occur.

Do not configure a port that is an active or a not-yet-active member of an EtherChannel as an IEEE 802.1x port. If you try to enable IEEE 802.1x authentication on an EtherChannel port, an error message appears, and IEEE 802.1x authentication is not enabled.

Examples

This example shows how to add an interface to the EtherChannel group specified as channel group 1:

Switch(config)# interface gigabitethernet0/1
Switch(config-if)# channel-group 1 mode on

This example shows how to set an Etherchannel into PAgP mode:

Switch(config-if)# channel-group 1 mode auto 
Creating a port-channel interface Port-channel 1

This example shows how to set an Etherchannel into LACP mode:

Switch(config-if)# channel-group 1 mode passive 
Creating a port-channel interface Port-channel 1

You can verify your settings by entering the show etherchannel or show running-config privileged EXEC command.

Related Commands

Command
Description

interface port-channel

Accesses or creates the port channel.

port-channel load-balance

Sets the load distribution method among the ports in the EtherChannel.

show etherchannel

Displays EtherChannel information for a channel.

show running-config

Displays the configuration information running on the switch. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


channel-protocol

Use the channel-protocol interface configuration command to configure an EtherChannel for the Port Aggregation Protocol (PAgP) or Link Aggregation Control Protocol (LACP). Use the no form of this command to disable PAgP or LACP on the EtherChannel.

channel-protocol {lacp | pagp}

no channel-protocol

Syntax Description

lacp

Configure an EtherChannel with the LACP protocol.

pagp

Configure an EtherChannel with the PAgP protocol.


Defaults

No protocol is assigned to the EtherChannel.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(12c)EA1

This command was introduced.


Usage Guidelines

Use the channel-protocol command only to restrict a channel to LACP or PAgP.

You must use the channel-group interface command to configure the EtherChannel parameters. The channel-group command can also set the EtherChannel for a channel.


Note You cannot enable both PAgP and LACP modes on an EtherChannel group.



Caution Do not enable Layer 3 addresses on the physical EtherChannel interfaces. To prevent loops, do not assign bridge groups on the physical EtherChannel interfaces.

Examples

This example shows how to set an EtherChannel into PAgP mode:

Switch(config-if)# channel-protocol pagp

This example shows how to set an EtherChannel into LACP mode:

Switch(config-if)# channel-protocol lacp

You can verify your settings by entering the show running-config privileged EXEC command.

Related Commands

Command
Description

show lacp

Display LACP information.

show pagp

Display PAgP information.

show running-config

Displays the current operating configuration. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


class

Use the class policy-map configuration command to define a traffic classification for the policy to act on using the class-map name or access group. Use the no form of this command to delete an existing class map.

class class-map-name [access-group name acl-index-or-name]

no class class-map-name

This command is available only if your switch is running the enhanced software image (EI).

Syntax Description

class-map-name

Name of the class map.

access-group name acl-index-or-name

(Optional) Number or name of an IP standard or extended access control list (ACL) or name of an extended MAC ACL. For an IP standard ACL, the index range is 1 to 99 and 1300 to 1999. For an IP extended ACL, the index range is 100 to 199 and 2000 to 2699.


Defaults

No policy-map class maps are defined.

Command Modes

Policy-map configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

Before you use the class command, use the policy-map global configuration command to identify the policy map and to enter policy-map configuration mode. After you specify a policy map, you can configure a policy for new classes or modify a policy for any existing classes in that policy map. You attach the policy map to an interface by using the service-policy interface configuration command; however, you cannot attach one that uses an ACL classification to the egress direction.

The class name that you specify in the policy map ties the characteristics for that class to the class map and its match criteria as configured by using the class-map global configuration command.

The class command performs the same function as the class-map global configuration command. Use the class command when a new classification, which is not shared with any other ports, is needed. Use the class-map command when the map is shared among many ports.


Note In a policy map, the class named class-default is not supported. The switch does not filter traffic based on the policy map defined by the class class-default policy-map configuration command.


After entering the class command, you enter policy-map class configuration mode. These configuration commands are available:

default: sets a command to its default.

exit: exits policy-map class configuration mode and returns to policy-map configuration mode.

no: returns a command to its default setting.

set: specifies a Differentiated Services Code Point (DSCP) value to be assigned to the classified traffic. For more information, see the set command.

police: defines a policer for the classified traffic. The policer specifies the bandwidth limitations and the action to take when the limits are exceeded. For more information, see the police command.

To return to policy-map configuration mode, use the exit command. To return to privileged EXEC mode, use the end command.


Note For more information about configuring ACLs, see the "Configuring Network Security with ACLs" chapter in the software configuration guide for this release.


Examples

This example shows how to create a policy map named policy1. When attached to the ingress port, it matches all the incoming traffic defined in class1 and polices the traffic at an average rate of 1 Mbps and bursts at 131072 bytes. Traffic exceeding the profile is dropped.

Switch(config)# policy-map policy1
Switch(config-pmap)# class class1
Switch(config-pmap-c)# police 1000000 131072 exceed-action drop
Switch(config-pmap-c)# exit
Switch(config-pmap)#

You can verify your settings by entering the show policy-map privileged EXEC command.

Related Commands

Command
Description

class-map

Creates a class map to be used for matching packets to the class whose name you specify.

match

Defines the match criteria to classify traffic.

policy-map

Creates or modifies a policy map that can be attached to multiple interfaces to specify a service policy.

show policy-map

Displays quality of service (QoS) policy maps.


class-map

Use the class-map global configuration command to create a class map to be used for matching packets to the class whose name you specify and to enter class-map configuration mode. Use the no form of this command to delete an existing class map and to return to global configuration mode.

class-map class-map-name [match-all]

no class-map class-map-name [match-all]

This command is available only if your switch is running the enhanced software image (EI).

Syntax Description

class-map-name

Name of the class map.

match-all

(Optional) Perform a logical-AND of all matching statements under this class map. All criteria in the class map must be matched.


Defaults

No class maps are defined.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

Use this command to specify the name of the class for which you want to create or modify class-map match criteria and to enter class-map configuration mode. In this mode, you can enter one match command to configure the match criteria for this class.

The class-map command and its subcommands are used to define packet classification and marking as part of a globally named service policy applied on a per-interface basis.

In quality of service (QoS) class-map configuration mode, these configuration commands are available:

exit: exits from QoS class-map configuration mode.

no: removes a match statement from a class map.

match: configures classification criteria. For more information, see the match class-map configuration command.

Only one match criterion per class map is supported. For example, when defining a class map, only one match command can be entered.

Only one access control list (ACL) can be configured in a class map. The ACL can have multiple access control entries (ACEs).


Note The switch does not support any deny conditions in an ACL configured in a class map.



Note For more information about configuring ACLs, see the "Configuring Network Security with ACLs" chapter in the software configuration guide for this release.


Examples

This example shows how to configure the class map named class1. class1 has one match criteria, which is a numbered ACL.

Switch(config)# access-list 103 permit tcp any any eq 80
Switch(config)# class-map class1
Switch(config-cmap)# match access-group 103
Switch(config-cmap)# exit

You can verify your settings by entering the show class-map privileged EXEC command.

Related Commands

Command
Description

class

Defines a traffic classification for the policy to act on by using the class-map name or access group.

match

Defines the match criteria to classify traffic.

policy-map

Creates or modifies a policy map that can be attached to multiple interfaces to specify a service policy.

show class-map

Displays QoS class maps.


clear controllers ethernet-controller

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

clear controllers ethernet-controller interface-id [cpe [port port-id]]

Syntax Description

cpe

Clear the LRE CPE port statistics for all CPE ports. This keyword is available only on a Catalyst 2950 LRE switch.

port port-id

Clear the LRE CPE port statistics for a specific port. For port-id, the range is 1 to 4, depending on CPE device model.

This keyword is available only on a Catalyst 2950 LRE switch.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

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 the CPE Ethernet ports. The CPE Ethernet ports on CPE devices take longer to clear than all the other port types.

If you enter the clear controllers ethernet-controller privileged EXEC command without specifying an interface-id, the switch clears the Ethernet link statistics for all ports on the switch. If you specify an an interface, the switch clears the Ethernet link statistics for the specified port.

On a Catalyst 2950 LRE switch, if you use the cpe keyword, the switch clears the Ethernet statistics of the LRE chipset and of all these CPE Ethernet ports:

Ethernet port on the Cisco 575 LRE CPE or the Cisco 576 LRE 997 CPE

All four Ethernet ports on the Cisco 585 LRE CPE

If you enter the cpe port port-id keywords, the switch clears the Ethernet counters of the specified CPE Ethernet port.


Note The Cisco 585 LRE CPE Ethernet ports cannot be cleared on a per-port basis, even by using the port-id argument.


Examples

This example shows how to clear the Ethernet link statistics for an LRE port:

Switch# clear controllers ethernet-controller longreachethernet0/1

This example clears the Ethernet statistics for all the CPE Ethernet ports on a Cisco 585 LRE CPE:

Switch# clear controllers ethernet-controller longreachethernet0/1 cpe

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 per-interface transmit and receive statistics read from the hardware, the interface internal registers, the statistics read from LRE and CPE ports.


clear controllers lre

Use the clear controllers lre user EXEC command to reset an Long-Reach Ethernet (LRE) switch interface or a Cisco LRE customer premises equipment (CPE) device interface.

clear controllers lre {local link | remote [link | micro]} interface-id

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

local link

Reset the LRE interfaces on the switch by resetting the interface.

remote link

Reset the LRE interface on the CPE device.

remote micro

Reset the Cisco 585 CPE device.

interface-id

(Optional) ID of the switch port.


Defaults

No default is defined.

Command Modes

User EXEC

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Use this command to reset a questionable local or remote interface.

The clear controllers lre remote micro command is not supported on the Cisco 575 LRE CPE and the Cisco 576 LRE 997 CPE devices.

Examples

This example shows how to reset the local LRE interfaces on the switch:

Switch> clear controllers lre local link

This example shows how to reset the Cisco 575 LRE, Cisco 576 LRE 997 CPE, and the Cisco 585 LRE CPE devices connected to the switch:

Switch> clear controllers lre remote link

This example shows how to reset the Cisco 585 LRE CPE micro-controller connected to the switch:

Switch> clear controllers lre remote micro

Related Commands

Command
Description

cpe shutdown

Disables one or more CPE ports.

shutdown

Disables a port.


clear controllers lre link monitor

Use the clear controllers lre link monitor privileged EXEC command to clear Long-Reach Ethernet (LRE) link monitor data.

clear controllers lre link monitor interface-id

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

interface-id

ID of the LRE switch port.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

This command clears all collected link monitor data. New entries are added when a new polling cycle starts.

Examples

This example shows how to clear link monitor data on an LRE port:

Switch# clear controllers lre link monitor longreachethernet0/2

Related Commands

Command
Description

link monitor

Enables the LRE link monitor on a port.

link monitor logging

Enables link monitor event logging per port.

link monitor threshold snr

Sets a signal-to-noise margin for the LRE link monitor.

link monitor threshold rserr

Sets a Reed-Solomon error threshold for the LRE link monitor.

show controllers lre link monitor

Displays the LRE link monitor information.


clear controllers lre log

Use the clear controllers lre log privileged EXEC command to clear 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]

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

interface-id

(Optional) ID of the LRE switch port.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Use the clear controllers lre log command without specifying a switch LRE port to delete the history of events on all LRE ports.

Examples

This example shows how to delete the history of events on an LRE switch port:

Switch# clear controllers lre log longreachethernet0/3

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

Related Commands

Command
Description

logging lre

Sets the LRE logging level.

show controllers lre log

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


clear interface

Use the clear interface privileged EXEC command to clear the hardware logic on an interface or a VLAN.

clear interface {interface-id | vlan vlan-id}

Syntax Description

interface-id

ID of the interface.

vlan-id

VLAN ID. The range is 1 to 4094.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Examples

This example shows how to clear the hardware logic on an interface:

Switch# clear interface gigabitethernet0/1

This example shows how to clear the hardware logic on a specific VLAN:

Switch# clear interface vlan 5

You can verify that the interface-reset counter for an interface is incremented by entering the show interfaces privileged EXEC command.

clear lacp

Use the clear lacp privileged EXEC command to clear Link Aggregration Control Protocol (LACP) channel-group information.

clear lacp {channel-group-number | counters}

Syntax Description

channel-group-number

Channel group number. The range is 1 to 6.

counters

Clear traffic counters.


Defaults

This command has no default setting.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(12c)EA1

This command was introduced.


Examples

This example shows how to clear channel-group information for a specific group:

Switch# clear lacp 4

This example shows how to clear channel-group traffic counters:

Switch# clear lacp counters

You can verify that the information was deleted by entering the show lacp privileged EXEC command.

Related Commands

Command
Description

show lacp

Displays LACP channel-group information.


clear lre rate selection

Use the clear lre rate selection privileged EXEC command to reset the current 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]

This command is available only on Catalyst 2950 LRE switches.

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 an LREs witch port.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

If you enter the lock keyword or specify an interface, the switch runs rate selection on all LRE switch ports that have rate selection enabled, except those ports with locked profiles. If you enter the lock keyword, the switch runs rate selection on all profiles, including those that are locked.

Examples

This example shows how to reset the rate selection setting and to restart rate selection on an LRE port:

Switch# clear lre rate selection longreachethernet0/1

This example shows how to rerun rate selection on all ports, including any locked ports:

Switch# clear lre rate selection lock

This example shows how to reset and to restart rate selection on an LRE port, overriding the locked status:

Switch# clear lre rate selection lock longreachethernet0/2

Related Commands

Command
Description

rate selection

Enables rate selection on an LRE specific port

rate selection sequence

Assigns a rate selection sequence for a specific LRE port.

lre rate selection sequence

Assigns a rate selection sequence for the entire LRE switch.


clear mac address-table

Use the clear mac address-table privileged EXEC command to delete from the MAC address table a specific dynamic address, all dynamic addresses on a particular interface, or all dynamic addresses on a particular VLAN. This command also clears the MAC address notification global counters.

clear mac address-table {dynamic [address mac-addr | interface interface-id | vlan vlan-id] | notification}


Note Beginning with Cisco IOS Release 12.1(11)EA1, the clear mac address-table command replaces the clear mac-address-table command (with the hyphen).


Syntax Description

dynamic

Delete all dynamic MAC addresses.

dynamic address mac-addr

(Optional) Delete the specified dynamic MAC address.

dynamic interface interface-id

(Optional) Delete all dynamic MAC addresses on the specified physical port or port channel.

dynamic vlan vlan-id

(Optional) Delete all dynamic MAC addresses for the specified VLAN. The range is 1 to 4094.

notification

Clear the notifications in the history table and reset the counters.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(6)EA2

This command was introduced.

12.1(9)EA1

The notification keyword was added.

12.1(11)EA1

The clear mac-address-table command was replaced by the clear mac address-table command.


Examples

This example shows how to remove a specific dynamic address from the MAC address table:

Switch# clear mac address-table dynamic address 0008.0070.0007

You can verify that the information was deleted by entering the show mac address-table privileged EXEC command.

Related Commands

Command
Description

mac address-table notification

Enables the MAC address notification feature.

show mac address-table

Displays the MAC address table static and dynamic entries.

show mac address-table notification

Displays the MAC address notification settings for all interfaces or the specified interface.

snmp trap mac-notification

Enables the Simple Network Management Protocol (SNMP) MAC address notification trap on a specific interface.


clear pagp

Use the clear pagp privileged EXEC command to clear Port Aggregation Protocol (PAgP) channel-group information.

clear pagp {channel-group-number [counters] | counters}

Syntax Description

channel-group-number

Channel group number. The range is 1 to 6.

counters

Clear traffic counters.


Defaults

This command has no default setting.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Examples

This example shows how to clear channel-group information for a specific group:

Switch# clear pagp 4

This example shows how to clear channel-group traffic counters:

Switch# clear pagp counters

You can verify that the information was deleted by entering the show pagp privileged EXEC command.

Related Commands

Command
Description

show pagp

Displays PAgP channel-group information.


clear port-security

Use the clear port-security privileged EXEC command to delete from the MAC address table all secure addresses, all configured secure addresses, or a specific or all dynamic or sticky secure address on an interface or on the switch.

clear port-security {all | configured | dynamic | sticky} [address mac-address] | [interface interface-id]

Syntax Description

all

Delete all secure MAC addresses.

configured

Delete all configured secure MAC addresses.

dynamic

Delete all dynamic secure MAC addresses.

sticky

Delete all sticky secure MAC addresses.

address mac-address

(Optional) Delete the specified secure MAC address.

interface interface-id

(Optional) Delete secure MAC addresses on the specified physical port or port channel.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(11)EA1

This command was introduced.

12.1(14)EA1

The all and configured keywords were added.


Usage Guidelines

If you enter the clear port-security all privileged EXEC command, the switch removes all secure MAC addresses from the MAC address table.

If you enter the clear port-security configured address mac-address command, the switch removes the specified secure MAC address from the MAC address table.

If you enter the clear port-security dynamic interface interface-id command, the switch removes all dynamic secure MAC addresses on an interface from the MAC address table.

If you enter the clear port-security sticky command, the switch removes all sticky secure MAC addresses from the MAC address table.

Examples

This example shows how to remove all secure addresses from the MAC address table:

Switch# clear port-security all

This example shows how to remove a configured secure address from the MAC address table:

Switch# clear port-security configured address 0008.0070.0007

This example shows how to remove all the dynamic secure addresses learned on a specific interface:

Switch# clear port-security dynamic interface fastethernet0/1

This example shows how to remove all the sticky secure addresses from the address table:

Switch# clear port-security sticky

You can verify that the information was deleted by entering the show port-security privileged EXEC command.

Related Commands

Command
Description

show port-security

Displays the port security settings for an interface or for the switch.

switchport port-security

Enables port security on an interface.

switchport port-security mac-address mac-address

Configures secure MAC addresses.

switchport port-security maximum value

Configures a maximum number of secure MAC addresses on a secure interface.


clear spanning-tree counters

Use the clear spanning-tree counters privileged EXEC command to clear the spanning-tree counters.

clear spanning-tree counters [interface interface-id]

Syntax Description

interface interface-id

(Optional) Clear all spanning-tree counters on the specified interface. If interface-id is not specified, spanning-tree counters are cleared for all interfaces.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(13)EA1

This command was introduced.


Examples

This example shows how to clear spanning-tree counters for all interfaces:

Switch# clear spanning-tree counters

Related Commands

Command
Description

show spanning-tree

Displays spanning-tree state information.


clear spanning-tree detected-protocols

Use the clear spanning-tree detected-protocols privileged EXEC command to restart the protocol migration process (force the renegotiation with neighboring switches) on all interfaces or on the specified interface.

clear spanning-tree detected-protocols [interface interface-id]

Syntax Description

interface interface-id

(Optional) Restart the protocol migration process on the specified interface. Valid interfaces include physical ports, VLANs, and port channels. The VLAN range is 1 to 4094. The port-channel range is 1 to 6.


Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(9)EA1

This command was introduced.

12.1(20)EA2

This command was added to the SI.


Usage Guidelines

A switch running the rapid per-VLAN spanning-tree plus (rapid-PVST+) protocol or the Multiple Spanning Tree Protocol (MSTP) supports a built-in protocol migration mechanism that enables it to interoperate with legacy IEEE 802.1D switches. If a rapid-PVST+ switch or an MSTP switch receives a legacy IEEE 802.1D configuration bridge protocol data unit (BPDU) with the protocol version set to 0, it sends only IEEE 802.1D BPDUs on that port. A multiple spanning-tree (MST) switch can also detect that a port is at the boundary of a region when it receives a legacy BPDU, an MST BPDU (version 3) associated with a different region, or an RST BPDU (version 2).

However, the switch does not automatically revert to the rapid-PVST+ or the MSTP mode if it no longer receives IEEE 802.1D BPDUs because it cannot determine whether the legacy switch has been removed from the link unless the legacy switch is the designated switch. Use the clear spanning-tree detected-protocols command in this situation.

Examples

This example shows how to restart the protocol migration process on an interface:

Switch# clear spanning-tree detected-protocols interface fastethernet0/1

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.

Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Examples

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

Switch# clear vmps statistics

You can verify that the information was deleted by entering the show vmps statistics privileged EXEC command.

Related Commands

Command
Description

show vmps statistics

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

Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.


Examples

This example shows how to clear the VTP counters:

Switch# clear vtp counters

You can verify that the information was deleted by entering the show vtp counters privileged EXEC command.

Related Commands

Command
Description

show vtp counters

Displays 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 service 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

(Optional) Number of a configured member switch. The range is from 0 to 15.

name name

(Optional) Name of the configured cluster up to 31 characters.


Defaults

The switch is not a member of any cluster.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.


Usage Guidelines

A cluster member can have 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 consoleservice 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 an example of text from the running configuration of a cluster member:

Switch(config)# show running-config

<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# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Switch(config)# no cluster commander-address

You can verify your settings by entering the show cluster privileged EXEC command.

Related Commands

Command
Description

show cluster

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

show running-config

Displays the configuration information running on the switch. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


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 return to the default setting.

cluster discovery hop-count number

no 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 1 to 7.


Defaults

The hop count is set to 3.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was 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 your settings by entering the show cluster privileged EXEC command 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.


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 this command to remove all members and make the command switch a candidate switch.

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

no 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 0 to 15.


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

12.0(5.2)WC(1)

This command was introduced.


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, name the cluster, and set the command switch member number to 4:

Switch(config)# cluster enable Engineering-IDF4 4

You can verify your settings by entering the show cluster privileged EXEC command on the command switch.

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 return to the default setting.

cluster holdtime holdtime-in-secs

no 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 1 to 300 seconds.


Defaults

The holdtime is 80 seconds.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was 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 your settings by entering the show cluster privileged EXEC command.

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

Syntax Description

n

VLAN ID of the new management VLAN. The range is 1 to 4094.


Defaults

The default management VLAN is VLAN 1.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was 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 your settings by entering the show interfaces vlan vlan-id privileged EXEC command.

Related Commands

Command
Description

show interfaces

Displays the administrative and operational status of a switching (nonrouting) port.


cluster member

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

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

no cluster member n

Syntax Description

n

(Optional) The number that identifies a cluster member. The range is 0 to 15.

mac-address H.H.H

MAC address of the member switch in hexadecimal format.

password enable-password

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

vlan vlan-id

(Optional) VLAN ID through which the candidate is added to the cluster by the command switch. The range is 1 to 4094.


Defaults

A newly enabled command switch has no associated cluster members.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was 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 that is 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.

If you do not specify a VLAN ID, the command switch automatically chooses a VLAN and adds the candidate to the cluster.

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. The command switch adds the candidate to the cluster through VLAN 3.

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

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 your settings by entering the show cluster members privileged EXEC command 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

Defaults

Clustering is enabled on all switches.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was 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 cannot become 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 cannot become 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 that clustering is disabled by entering the show cluster privileged EXEC command.

Related Commands

Command
Description

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

Syntax Description

HSRP-group-name

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


Defaults

The cluster is not bound to any HSRP group.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was 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 NVRAM.

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

Use the same group name on all members of the HSRP standby group that is to be bound to the cluster. Use the same HSRP group name on all cluster-HSRP capable members for the HSRP group that is to be bound. (When not binding a cluster to an HSRP group, you can use different names on the cluster command and the member switches.)

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 (my_hsrp) group does not 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 your settings by entering the show cluster privileged EXEC command.

Related Commands

Command
Description

show cluster

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

show standby

Displays standby group information.

standby ip

Enables HSRP on the interface.


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 return to the default setting.

cluster timer interval-in-secs

no cluster timer

Syntax Description

interval-in-secs

Interval in seconds between heartbeat messages. The range is 1 to 300 seconds.


Defaults

The interval is 8 seconds.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.


Usage Guidelines

Use this command with the cluster holdtime 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 heartbeat interval timer (cluster timer). For example, it takes (holdtime-in-secs divided by the 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 heartbeat interval timer and the duration on the command switch:

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

You can verify your settings by entering the show cluster privileged EXEC command.

Related Commands

Command
Description

show cluster

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


controller longreachethernet

Use the controller longreachethernet global configuration command to enter the controller configuration mode.

controller longreachethernet ctrlr-number

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

ctrlr-number

LRE controller number. Controller numbers are device specific. The range is 0 to 2 on a 24-port LRE switch and 0 on an 8-port LRE switch.


Defaults

No default is defined.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Use this command to enter the controller configuration mode. An LRE controller is the LRE chipset in the switch.

Examples

This example shows how to enter the controller configuration mode for controller 0:

Switch(config)# controller longreachethernet 0
Switch(config-controller)#

Related Commands

Command
Description

upgrade binary

Configures upgrades on either end of an LRE link.

upgrade preserve

Prevents an upgrade of the local customer premises equipment (CPE) controller and all remote CPE devices connected to it.


cpe duplex

Use the cpe duplex interface configuration command to specify the duplex mode of operation for all customer premises equipment (CPE) ports. Use the no form of this command to return to the default setting.

cpe duplex {{auto | full | half} [port port-id]}

no cpe duplex {{auto | full | half} [port port-id]}

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

auto

The port automatically detects whether to run in full- or half- duplex mode.

full

The port is in full-duplex mode.

half

The port is in half-duplex mode.

port port-id

(Optional) CPE Ethernet port identifier. The range is 1to 4, depending on CPE device.


Defaults

The default duplex mode is half.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Use the cpe duplex full command to set the duplex mode to full for all the CPE Ethernet ports. Use the auto keyword to set the CPE Ethernet ports to autonegotiate, and use the half keyword to force the duplex mode to half for all the CPE Ethernet ports.

If you do not enter the port keyword, the duplex setting is applied to all the CPE Ethernet ports. If you enter the port port-id keywords, the setting is applied to the specified CPE Ethernet port and overrides any global speed settings.

Use the cpe duplex full port 2 command to set the duplex mode of port 2 on a CPE device to full duplex. If you enter both a switch-wide command, such as the cpe duplex full command, and a port-specific commands, such as the cpe duplex full port 2 command, the switch adds both the configuration file, and the port-specific command takes priority over the switch-wide command.

Examples

This example show how to set the CPE device to autonegotiate:

Switch# configure terminal
Switch(config)# interface longreachethernet0/2
Switch(config-if)# cpe duplex auto

This example shows how to set a port on a Cisco 585 LRE CPE to full-duplex mode:

Switch# configure terminal
Switch(config)# interface longreachethernet0/3
Switch(config-if)# cpe duplex full port 3

This example shows how to restore a port on a Cisco 585 LRE CPE to the default mode of half duplex:

Switch# configure terminal
Switch(config)# interface longreachethernet0/3
Switch(config-if)# no cpe duplex full port 3

This example shows how the cpe duplex {auto | full | half} port port-id command works with the cpe duplex {auto | full | half} command. Port 1 is set to full duplex, port 2 is set to half duplex, and the remainder of the ports are set to autonegotiate.

Switch# configure terminal
Switch(config)# interface longreachethernet0/4
Switch(config-if)# cpe duplex auto
Switch(config-if)# cpe duplex full port 1
Switch(config-if)# cpe duplex half port 2

After the commands in the previous example are entered, this example shows how to set a port to autonegotiate:

Switch(config-if)# no cpe duplex full port 1 

Related Commands

Command
Description

cpe speed

Specifies the CPE port speed settings.

show interfaces cpe

Displays CPE Ethernet ports connection, speed, or duplex status.


cpe protected

Use the cpe protected interface configuration command to restrict data traffic to individual ports on Cisco 585 LRE customer premises equipment (CPE) ports. Use the no form of this command to allow different ports on the same CPE device to exchange data directly.

cpe protected [port port-id]

no cpe protected [port port-id]

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

port port-id

(Optional) CPE Ethernet port identifier. The range is 1 to 4, depending on CPE device.


Defaults

Traffic is not restricted to specific ports.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Even though you can protect an LRE interface by using the switchport protected interface configuration command, this command does not protect individual CPE Ethernet ports. Use the cpe protected command to ensure that data traffic from one CPE port is not accessed on any of the other three ports. Use the cpe protected command to restrict CPE traffic, either at the CPE device level or at the individual port level for data security. Use the cpe protected command without specifying a CPE port to protect data for all applicable CPE ports. Use the cpe protected port port-id command to protect a specific CPE Ethernet port.

When using this feature, always specify a minimum of two ports. A single port that is configured as protected has no effect. Data traffic does not flow between two ports that are protected.

Examples

This example show how to protect CPE port 1 on an LRE port:

Switch# configure terminal
Switch(config)# interface longreachethernet0/1
Switch(config-if)# cpe protected port 1

Related Commands

Command
Description

show controllers lre cpe

Shows CPE protected port information.

switchport protected

Isolates unicast, multicast, and broadcast traffic at Layer 2 from other protected ports on the same switch.


cpe shutdown

Use the cpe shutdown interface configuration command to disable one or more customer premises equipment (CPE) ports. Use the no form of this command to enable a port.

cpe shutdown [port port-id]

no cpe shutdown [port port-id]

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

port port-id

(Optional) CPE Ethernet port identifier. The range is 1 to 4, depending on the CPE device.


Defaults

The CPE ports are enabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

If the port keyword is not specified, the value is applied globally to all the CPE Ethernet ports. If the port keyword is specified, the value is applied to the specific CPE Ethernet port and overrides any global speed settings.

The CPE Ethernet ports can be shut down at the CPE device level and the port level. If you add a configuration at the CPE device level and at the port level, you must enter the no form of the command for both configurations to return the port to the default state.

Examples

This example shows how to disable all ports on the CPE device:

Switch# configure terminal
Switch(config)# interface longreachethernet0/2
Switch(config-if)# cpe shutdown 

This example shows how to disable port 2 on the CPE device:

Switch# configure terminal
Switch(config)# interface longreachethernet0/2
Switch(config-if)# cpe shutdown port 2

After the cpe shutdown port 2 command was entered in the previous example, this example shows how to enable all the CPE Ethernet ports that were not shut down. After the no cpe shutdown command is entered, port 2 is still shut down because the cpe shutdown port 2 command was entered in the previous example. Use the no cpe shutdown port 2 command to enable the port 2.

Switch# configure terminal
Switch(config)# interface longreahethernet0/2
Switch(config-if)# no cpe shutdown
Switch(config-if)#

Related Commands

Command
Description

show interfaces cpe

Displays CPE Ethernet ports connection, speed, or duplex status.

shutdown

Disables a port.


cpe speed

Use the cpe speed interface configuration command to set the speed of a customer premises equipment (CPE) port. Use the no form of this command to return to the default setting.

cpe speed {{auto | 10 | 100} [port port-id]}

no cpe speed {{auto | 10 | 100} [port port-id]}

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

auto

Port automatically detects whether it should run at 10 or 100 Mbps.

10

Port runs at 10 Mbps.

100

Port runs at 100 Mbps.

port port-id

(Optional) ID of the CPE Ethernet port. The range is 1 to 4, depending on the CPE device.


Defaults

The default speed is auto.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

If you do not enter the port keyword, the speed setting is applied globally to all the CPE Ethernet ports. If you enter the port port-id keywords, the setting is applied to the specified CPE Ethernet port and overrides any global speed settings.

Examples

This example shows how to set a port on a CPE to 100 Mbps:

Switch# configure terminal
Switch(config)# interface longreachethernet0/2
Switch(config-if)# cpe speed 100 port 1

This example shows how to return the default speed setting on all CPE Ethernet ports that were not configured with the cpe speed {10 | 100} port port-id command:

Switch# configure terminal
Switch(config)# interface longreachethernet0/2
Switch(config-if)# no cpe speed 100

This example shows how to set port 1 to 10 Mbps, port 2 to 100 Mbps, and the remainder of the ports to autonegotiate.

Switch# configure terminal
Switch(config)# interface longreachethernet0/4
Switch(config-if)# cpe speed auto
Switch(config-if)# cpe speed 10 port 1
Switch(config-if)# cpe speed 100 port 2

This example shows how to set port 1 to autonegotiate after the cpe speed 10 command is entered:

Switch(config-if)# no cpe speed 10 port

Related Commands

Command
Description

local duplex

Sets the port speed for LRE ports.

show interfaces cpe

Displays connection, speed, and duplex settings for CPE Ethernet ports attached to the specified LRE switch port


cpe toggle

Use the cpe toggle interface configuration command to enable the CPE toggle feature. When this feature is enabled, a remote customer premises equipment (CPE) link automatically transitions from down to up if the Long-Reach Ethernet (LRE) link comes up in less than 30 seconds. Use the no form of this command to disable the CPE toggle feature on a specific port or on the switch.

cpe toggle [port cpe-port-id]

no cpe toggle [port cpe-port-id]

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

port cpe-port-id

(Optional) The CPE port identifier. The range is 1 to 4.


Defaults

CPE toggle is enabled on all interfaces.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

A 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, which is referred to as the LRE link.

CPE toggle cannot be disabled on a Cisco 575 LRE or Cisco 576 LRE 997 CPE link.

You can disable CPE toggle on a link from a Cisco 585 LRE CPE to a remote Ethernet device. You can disable CPE toggle on all interfaces or on a specific interface by using the no cpe toggle [port cpe-port-id] interface configuration command. If CPE toggle is disabled and the LRE link comes up in less than 30 seconds, the CPE link transitions from down to up.

If the port keyword is not specified, this command applies to all Fast Ethernet ports on a CPE device. If the port keyword and a port ID are specified, this command applies to the specific Fast Ethernet port on the CPE and overrides the global configuration.

Examples

This example shows how to disable CPE toggle on a CPE port:

Switch# configure terminal
Switch(config)# interface longreachethernet0/2
Switch(config-if)# no cpe toggle

Related Commands

Command
Description

show running-config

Displays the configuration information running on the switch. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


cpe type

Use the cpe type interface configuration command to set the type of customer premises equipment (CPE) port that is connected to a Long-Reach Ethernet (LRE) switch.

cpe type [cisco575-lre | cisco576-lre997 | cisco585-lre | unknown]

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

cisco575-lre

Model number of the Cisco 575 LRE CPE device.

cisco576-lre997

Model number of the Cisco 576 LRE 997 CPE device.

cisco585-lre

Model number of the Cisco 585 LRE CPE device.

unknown

An unknown CPE.


Defaults

The default CPE type is unknown.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.

12.1(11)YJ4

The cisco576-lre997 keyword was added.


Usage Guidelines

This command can only be used when the port is shut down. If the link is active on a CPE device port, the switch detects the CPE device type and automatically modifies the configuration. You cannot change the CPE device type on active links. For example, if the active CPE device type is cisco575-lre, you cannot change the type to cisco585-lre or unknown.

Examples

This example shows how to set the CPE device type to cisco585-lre while the link is down:

Switch# configure terminal
Switch(config)# interface longreachethernet0/2
Switch(config-if)# cpe type cisco585-lre

Related Commands

Command
Description

show interfaces cpe

Displays connection, speed, and duplex settings for CPE Ethernet ports attached to the specified LRE switch port.


define interface-range

Use the define interface-range global configuration command to create an interface-range macro. Use the no form of this command to delete the defined macro.

define interface-range macro-name interface-range

no define interface-range macro-name interface-range

Syntax Description

macro-name

Name of the interface-range macro; up to 32 characters.

interface-range

Interface range; for valid values for interface ranges, see "Usage Guidelines."


Defaults

This command has no default setting.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

The macro name is a 32-character maximum character string.

A macro can contain up to five ranges.

All interfaces in a range must be the same type; that is, all Fast Ethernet ports, all Gigabit Ethernet ports, all EtherChannel ports, or all VLANs, but you can combine multiple interface types in a macro.

When entering the interface-range, use this format:

type {first-interface} - {last-interface}

You must add a space between the first interface number and the hyphen when entering an interface-range. For example, fastethernet0/1 -2 is a valid range; fastethernet0/1-2 is not a valid range.

Valid values for type and interface:

vlan vlan-id, where vlan-id is 1 to 4094.

port-channel port-channel-number, where port-channel-number is 1 to 6

fastethernet interface-id

gigabitethernet interface-id

longreachethernet interface-id

VLAN interfaces must have been configured with the interface vlan command (the show running-config privileged EXEC command displays the configured VLAN interfaces). VLAN interfaces not displayed by the show running-config command cannot be used in interface-ranges.

For physical interfaces, the interface-id is defined as a slot/number (where slot is always 0 for the switch), and the range can be entered as type 0/number - number (for example, fastethernet0/1 - 2). You can also enter multiple ranges.

When you define a range, you must enter a space before and after the hyphen (-):

interface range fastethernet0/1 - 2

When you define multiple ranges, you must enter a space before and after the comma (,):

interface range fastethernet0/1 - 2 , gigabitethernet0/1 - 2

Examples

This example shows how to create a multiple-interface macro:

Switch(config)# define interface-range macro1 fastethernet0/3 -7 , gigabitethernet0/1 

Related Commands

Command
Description

interface range

Executes a command on multiple ports at the same time.

show running-config

Displays the current operating configuration, including defined macros. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


delete

Use the delete privileged EXEC command to delete a file or directory on the flash memory device.

delete [/force] [/recursive] filesystem:/file-url

Syntax Description

/force

(Optional) Suppress the prompt that confirms the deletion.

/recursive

(Optional) Delete the named directory and all subdirectories and the files contained in it.

filesystem:

Alias for a flash file system. Use flash: for the system board flash device.

/file-url

The path (directory) and filename to delete.


Command Modes

Privileged EXEC

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.

12.1(6)EA2

The /force and /recursive keywords were added.


Usage Guidelines

If you use the /force keyword, you are prompted once at the beginning of the deletion process to confirm the deletion.

If you use the /recursive keyword without the /force keyword, you are prompted to confirm the deletion of every file.

The prompting behavior depends on the setting of the file prompt global configuration command. By default, the switch prompts for confirmation on destructive file operations. For more information about this command, see the Cisco IOS Command Reference for Cisco IOS Release 12.1.

Examples

This example shows how to delete a file from the switch flash memory:

Switch# delete flash:filename

You can verify that the directory was removed by entering the dir filesystem: privileged EXEC command.

Related Commands

Command
Description

copy

Downloads a file from a source, such as a TFTP server, to a destination, such as the flash memory.

dir filesystem:

Displays a list of files on a file system.

rename

Renames a file.


deny (access-list configuration)

Use the deny access-list configuration command to configure conditions for a named or numbered IP access control list (ACL). Use the no form of this command to remove a deny condition from the IP ACL.

Use these commands with standard IP ACLs:

deny {source source-wildcard | host source | any}

no deny {source source-wildcard | host source | any}

Use these commands with extended IP ACLs:

deny protocol {source source-wildcard | host source | any} [operator port] {destination destination-wildcard | host source | any} [operator port] [dscp dscp-value] [time-range time-range-name]

no deny protocol {source source-wildcard | host source | any} [operator port] {destination destination-wildcard | host source | any} [operator port] [dscp dscp-value] [time-range time-range-name]

This command is available on physical interfaces only if your switch is running the enhanced software image (EI).

Syntax Description

protocol

Name of an IP protocol.

protocol can be ip, tcp, or udp.

source source-wildcard | host source | any

Define a source IP address and wildcard.

The source is the source address of the network or host from which the packet is being sent, specified in one of these ways:

The 32-bit quantity in dotted-decimal format. The source-wildcard applies wildcard bits to the source.

The keyword host, followed by the 32-bit quantity in dotted-decimal format, as an abbreviation for source and source-wildcard of source 0.0.0.0.

The keyword any as an abbreviation for source and source-wildcard of 0.0.0.0 255.255.255.255. You do not need to enter a source-wildcard.

destination destination-wildcard | host destination | any

Define a destination IP address and wildcard.

The destination is the destination address of the network or host to which the packet is being sent, specified in one of these ways:

The 32-bit quantity in dotted-decimal format. The destination-wildcard applies wildcard bits to the destination.

The keyword host, followed by the 32-bit quantity in dotted-decimal format, as an abbreviation for destination and destination-wildcard of destination 0.0.0.0.

The keyword any as an abbreviation for destination and destination-wildcard of 0.0.0.0 255.255.255.255. You do not need to enter a destination-wildcard.

operator port

(Optional) Define a source or destination port.

The operator can be only eq (equal).

If operator is after the source IP address and wildcard, conditions match when the source port matches the defined port.

If operator is after the destination IP address and wildcard, conditions match when the destination port matches the defined port.

The port is a decimal number or name of a TCP or User Datagram Protocol (UDP) port. The number can be from 0 to 65535.

Use TCP port names only for TCP traffic.

Use UDP port names only for UDP traffic.

dscp dscp-value

(Optional) Define a Differentiated Services Code Point (DSCP) value to classify traffic.

For the dscp-value, enter any of the 13 supported DSCP values (0, 8, 10, 16, 18, 24, 26, 32, 34, 40, 46, 48, and 56), or use the question mark (?) to see a list of available values.

time-range time-range-name

(Optional) For the time-range keyword, enter a meaningful name to identify the time range. For a more detailed explanation of this keyword, see the software configuration guide.


Defaults

There are no specific conditions that deny packets in the named or numbered IP ACL.

The default ACL is always terminated by an implicit deny statement for all packets.

Command Modes

Access-list configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

Use this command after the ip access-list global configuration command to specify deny conditions for an IP ACL. You can specify a source IP address, destination IP address, IP protocol, TCP port, or UDP port. Specify the TCP and UDP port numbers only if protocol is tcp or udp and operator is eq.


Note For more information about configuring IP ACLs, see the "Configuring Network Security with ACLs" chapter in the software configuration guide for this release.


Examples

This example shows how to create an extended IP ACL and to configure deny conditions for it:

Switch(config)# ip access-list extended Internetfilter
Switch(config-ext-nacl)# deny tcp host 190.5.88.10 any
Switch(config-ext-nacl)# deny tcp host 192.1.10.10 any

This is an example of a standard ACL that sets a deny condition:

Switch(config)# ip access-list standard Acclist1
Switch(config-ext-nacl)# deny 192.5.34.0  0.0.0.255
Switch(config-ext-nacl)# deny 128.88.10.0  0.0.0.255
Switch(config-ext-nacl)# deny 36.1.1.0  0.0.0.255

Note In these examples, all other IP access is implicitly denied.


You can verify your settings by entering the show ip access-lists or the show access-lists privileged EXEC command.

Related Commands

Command
Description

ip access-list

Defines an IP ACL.

permit (access-list configuration)

Sets conditions for an IP ACL.

ip access-group

Controls access to an interface.

show ip access-lists

Displays IP ACLs configured on the switch.

show access-lists

Displays ACLs configured on a switch.


deny (MAC access-list configuration)

Use the deny MAC access-list configuration command to prevent Layer 2 traffic from being forwarded if the conditions are matched. Use the no form of this command to remove a deny condition from the MAC named access control list (ACL).

{permit | deny} {any | host src-MAC-addr} {any | host dst-MAC-addr} [aarp | amber | appletalk | dec-spanning | decnet-iv | diagnostic | dsm | etype-6000 | etype-8042 | lat | lavc-sca | mop-console | mop-dump | msdos | mumps | netbios | vines-echo |vines-ip | xns-idp]

no {permit | deny} {any | host src-MAC-addr} {any | host dst-MAC-addr} [aarp | amber | appletalk | dec-spanning | decnet-iv | diagnostic | dsm | etype-6000 | etype-8042 | lat | lavc-sca | mop-console | mop-dump | msdos | mumps | netbios | vines-echo |vines-ip | xns-idp]

This command is available only if your switch is running the enhanced software image (EI).

Syntax Description

any

Keyword to deny any source or destination MAC address.

host src-MAC-addr

Define a host MAC address. If the source address for a packet matches the defined address, traffic from that address is denied. MAC address-based subnets are not allowed.

host dst-MAC-addr

Define a destination MAC address. If the destination address for a packet matches the defined address, traffic to that address is denied. MAC address-based subnets are not allowed.

aarp

Select Ethertype AppleTalk Address Resolution Protocol that maps a data-link address to a network address.

amber

Select EtherType DEC-Amber.

appletalk

Select EtherType AppleTalk/EtherTalk.

dec-spanning

Select EtherType Digital Equipment Corporation (DEC) spanning tree.

decnet-iv

Select EtherType DECnet Phase IV protocol.

diagnostic

Select EtherType DEC-Diagnostic.

dsm

Select EtherType DEC-DSM.

etype-6000

Select EtherType 0x6000.

etype-8042

Select EtherType 0x8042.

lat

Select EtherType DEC-LAT.

lavc-sca

Select EtherType DEC-LAVC-SCA.

mop-console

Select EtherType DEC-MOP Remote Console.

mop-dump

Select EtherType DEC-MOP Dump.

msdos

Select EtherType DEC-MSDOS.

mumps

Select EtherType DEC-MUMPS.

netbios

Select EtherType DEC-Network Basic Input/Output System (NETBIOS).

vines-echo

Select EtherType Virtual Integrated Network Service (VINES) Echo from Banyan Systems.

vines-ip

Select EtherType VINES IP.

xns-idp

Select EtherType Xerox Network Systems (XNS) protocol suite (0 to 65535), an arbitrary Ethertype in decimal, hexadecimal, or octal.


Defaults

This command has no defaults. However, the default action for a MAC named ACL is to deny.

Command Modes

MAC access-list configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

When an access control entry (ACE) is added to an ACL, an implied deny-any-any condition exists at the end of the list. That is, if there are no matches, the packets are denied. However, before the first ACE is added, the list permits all packets.

These options are not allowed:

Class of service (CoS)

Ethertype number of a packet with Ethernet II or Subnetwork Access Protocol (SNAP) encapsulation

Link Service Access Point (LSAP) number of a packet with IEEE 802.2 encapsulation


Note For more information about configuring MAC extended ACLs, see the "Configuring Network Security with ACLs" chapter in the software configuration guide for this release.


Examples

This example shows how to define the MAC named extended ACL to deny NETBIOS traffic from any source to MAC address 00c0.00a0.03fa. Traffic matching this list is denied.

Switch(config-ext-macl)# deny any host 00c0.00a0.03fa netbios

This example shows how to remove the deny condition from the named MAC extended ACL:

Switch(config-ext-macl)# no deny any host 00c0.00a0.03fa netbios

You can verify your settings by entering the show access-lists privileged EXEC command.

Related Commands

Command
Description

mac access-list extended

Creates an ACL based on MAC addresses for non-IP traffic.

permit (MAC access-list configuration)

Permits Layer 2 traffic to be forwarded if conditions are matched.

show access-lists

Displays ACLs configured on a switch.


dot1x

Use the dot1x global configuration command to enable IEEE 802.1x authentication globally. Use the no form of this command to return to the default setting.

dot1x {system-auth-control} | {guest-vlan supplicant}

no dot1x {system-auth-control} | {guest-vlan supplicant}

Syntax Description

system-auth-control

Enable IEEE 802.1x authentication globally on the switch.

guest-vlan supplicant

Enable optional guest VLAN behavior globally on the switch.


Defaults

IEEE 802.1x authentication is disabled, and the optional guest VLAN behavior is disabled.

Command Modes

Global configuration

Command History

Release
Modification

12.1(14)EA1

This command was introduced.

12.1(22)EA2

The guest-vlan supplicant keywords were added.


Usage Guidelines

You must enable authentication, authorization, and accounting (AAA) and specify the authentication method list before enabling IEEE 802.1x authentication globally. A method list describes the sequence and authentication methods to be queried to authenticate a user.

Before globally enabling IEEE 802.1x authentication on a switch, remove the EtherChannel configuration from the interfaces on which IEEE 802.1x authentication and EtherChannel are configured.

If you are using a device running the Cisco Access Control Server (ACS) application for IEEE 802.1x authentication with EAP-Transparent LAN Services (TLS) and with EAP-MD5 and your switch is running Cisco IOS Release 12.1(14)EA1, make sure that the device is running ACS Version 3.2.1 or later.

You can use the guest-vlan supplicant keywords to enable the optional IEEE 802.1x guest VLAN behavior globally on the switch. For more information, see the dot1x guest-vlan command.

Examples

This example shows how to globally enable IEEE 802.1x authentication on a switch:

Switch(config)# dot1x system-auth-control

This example shows how to globally enable the optional guest VLAN behavior on a switch:

Switch(config)# dot1x guest-vlan supplicant

You can verify your settings by entering the show dot1x privileged EXEC command.

Related Commands

Command
Description

dot1x guest-vlan

Enables and specifies an active VLAN as an IEEE 802.1x guest VLAN.

dot1x port-control

Enables manual control of the authorization state of the port.

show dot1x

Displays IEEE 802.1x statistics, administrative status, and operational status for the switch or for the specified interface.


dot1x auth-fail max-attempts

Use the dot1x auth-fail max-attempts interface configuration command to configure the maximum number of authentication attempts allowed before a port is moved to the restricted VLAN. To return to the default setting, use the no form of this command.

dot1x auth-fail max-attempts max-attempts

no dot1x auth-fail max-attempts

Syntax Description

max-attempts

Specify a maximum number of authentication attempts allowed before a port is moved to the restricted VLAN. The range is 1 to 3.


Defaults

The default is 3 attempts.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(22)EA7

This command was introduced.


Usage Guidelines

If you reconfigure the maximum number of authentication failures allowed by the VLAN, the change takes effect after the re-authentication timer expires.

Examples

This example shows how to set 2 as the maximum number of authentication attempts allowed before the port is moved to the restricted VLAN on Gigabit Ethernet interface 1:

Switch# configure terminal 
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface gigabitethernet0/1
Switch(config-if)# dot1x auth-fail max-attempts 2
Switch(config-if)# end
Switch(config)# end
Switch#

You can verify your settings by entering the show dot1x [interface interface-id] privileged EXEC command.

Related Commands

Command
Description

dot1x auth-fail vlan [vlan id]

Enables the optional restricted VLAN feature.

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified port.


dot1x auth-fail vlan

Use the dot1x auth-fail vlan interface configuration command to enable the restricted VLAN on a port. To return to the default setting, use the no form of this command.

dot1x auth-fail vlan vlan-id

no dot1x auth-fail vlan vlan-id

Syntax Description

vlan-id

Specify a VLAN in the range of 1 to 4094.


Defaults

No restricted VLAN is configured.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(22)EA7

This command was introduced.


Usage Guidelines

You can configure a restricted VLAN on ports configured as follows:

single-host (default) mode only

auto mode for authorization

You should enable re-authentication. The ports in restricted VLANs do not receive re-authentication requests if re-authentication is disabled. To start the re-authentication process, the restricted VLAN must receive a link down event or an Extensible Authentication Protocol (EAP) logoff event from the port. If the host is connected through a hub, the port might never receive a link down event and might not detect the new host until the next re-authentication attempt occurs. Therefore, re-authentication should be enabled.

If the user fails authentication, the port is moved to a restricted VLAN, and an EAP success message is sent to the user. Because the user is not notified of the authentication failure, there might be confusion as to why there is restricted access to the network. An EAP success message is sent for these reasons:

If the EAP success message is not sent, the user tries to authenticate every 60 seconds (the default) by sending an EAP-start message.

Some hosts (for example, devices running Windows XP) cannot implement DHCP until they receive an EAP success message.

A user might cache an incorrect username and password combination after receiving an EAP success message from the authenticator and re-use that information in every re-authentication. Until the user passes the correct username and password combination, the port remains in the restricted VLAN.

Internal VLANs that are used for Layer 3 ports cannot be configured as a restricted VLAN.

You cannot configure a VLAN to be both a restricted VLAN and a voice VLAN. If you do this, a syslog message appears.

When a restricted VLAN port is moved to an unauthorized state, the authentication process is restarted. If the user fails the authentication process again, the authenticator waits in the held state. After the user has correctly re-authenticated, all IEEE 802.1x ports are reinitialized and treated as normal IEEE 802.1x ports.

When you reconfigure a restricted VLAN to a different VLAN, any ports in the restricted VLAN are also moved, and the ports stay in their current authorized state.

When you shut down or remove a restricted VLAN from the VLAN database, any ports in the restricted VLAN are immediately moved to an unauthorized state, and the authentication process is restarted. The authenticator does not wait in a held state because the restricted VLAN configuration still exists. While the restricted VLAN is inactive, all authentication attempts are counted. As soon as the restricted VLAN becomes active, the port is placed in the restricted VLAN.

The restricted VLAN is supported only in single-host mode (the default port mode).

When a port is placed in a restricted VLAN, the user's MAC address is added to the MAC address table. If a new MAC address appears on the port, it is treated as a security violation.

Examples

This example shows how to configure a restricted VLAN on Gigabit Ethernet interface 1:

Switch# configure terminal 
Enter configuration commands, one per line. End with CNTL/Z.
Switch(config)# interface gigabitethernet0/1
Switch(config-if)# dot1x auth-fail vlan 40
Switch(config-if)# end
Switch(config)# end
Switch#

You can verify your configuration by entering the show dot1x [interface interface-id] privileged EXEC command.

Related Commands

Command
Description

dot1x auth-fail max-attempts [max-attempts]

Configures the number of authentication attempts allowed before assigning a user to the restricted VLAN.

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified port.


dot1x control-direction

Use the dot1x control-direction command to change the port to unidirectional or bidirectional control.

dot1x control-direction {in | both}

no dot1x control-direction {in | both}

Syntax Description

dot1x control-direction in

Enable unidirectional control on port.

dot1x control-direction both

Enable bidirectional control on port.


Command Default

The port is set to bidirectional mode.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(22)EA6

This command was introduced.


Usage Guidelines

Using the keyword both or using the no form of this command are the same command.

The keyword both and the no form of the command change the port to its bidirectional default setting.

Examples

This example shows how to enable unidirectional control:

Switch(config-if)# dot1x control-direction in

These examples show how to enable bidirectional control:

Switch(config-if)# dot1x control-direction both
Switch(config-if)# no dot1x control-direction 

You can verify your settings by entering the show dot1x all privileged EXEC command.

The show dot1x all privileged EXEC command output is the same for all switches except for the port names and the state of the port. If a host is attached to the port but is not yet authenticated, a display similar to this appears:

Supplicant MAC 0002.b39a.9275
AuthSM State = CONNECTING
BendSM State = IDLE
PortStatus = UNAUTHORIZED

If you enter the dot1x control-direction in interface configuration command to enable unidirectional control, this appears in the show dot1x all command output:

ControlDirection  = In

If you enter the dot1x control-direction in interface configuration command and the port cannot support this mode due to a configuration conflict, this appears in the show dot1x all command output:

ControlDirection  = In (Disabled due to port settings)

Related Commands

Command
Description

show dot1x all [interface interface-id]

Displays control-direction port setting status for the specified interface.


dot1x default

Use the dot1x default interface configuration command to reset the configurable IEEE 802.1x parameters to their default values.

dot1x default

Syntax Description

This command has no arguments or keywords.

Defaults

These are the default values:

The per-interface IEEE 802.1x protocol enable state is disabled (force-authorized).

The number of seconds between re-authentication attempts is 3600 seconds.

The periodic re-authentication is disabled.

The quiet period is 60 seconds.

The retransmission time is 30 seconds.

The maximum retransmission number is 2 times.

The host mode is single host.

The client timeout period is 30 seconds.

The authentication server timeout period is 30 seconds.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.

12.1(14)EA1

This command was changed to the interface configuration mode.


Examples

This example shows how to reset the configurable IEEE 802.1x parameters on an interface:

Switch(config-if)# dot1x default

You can verify your settings by entering the show dot1x [interface interface-id] privileged EXEC command.

Related Commands

Command
Description

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified interface.


dot1x guest-vlan

Use the dot1x guest-vlan interface configuration command to specify an active VLAN as an IEEE 802.1x guest VLAN for switches running the enhanced software image (EI). Use the no form of this command to return to the default setting.

dot1x guest-vlan vlan-id

no dot1x guest-vlan

Syntax Description

vlan-id

Specify an active VLAN as an IEEE 802.1x guest VLAN. The range is 1 to 4094.


Defaults

No guest VLAN is configured.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(14)EA1

This command was introduced.

12.1(22)EA2

This command was modified to change the default guest VLAN behavior.


Usage Guidelines

You can configure a guest VLAN for each IEEE 802.1x port on the switch to provide limited services to clients (a device or workstation connected to the switch) not currently running IEEE 802.1x authentication. These users might be upgrading their system for IEEE 802.1x authentication, and some hosts, such as Windows 98 systems, might not be IEEE 802.1x-capable.

When you enable a guest VLAN on an IEEE 802.1x port, the switch assigns clients to a guest VLAN when it does not receive a response to its Extensible Authentication Protocol over LAN (EAPOL) request/identity frame or when EAPOL packets are not sent by the client.

Before Cisco IOS Release 12.1(22)EA2, the switch did not maintain the EAPOL packet history and allowed clients that failed authentication access to the guest VLAN, regardless of whether EAPOL packets had been detected on the interface. You can use the dot1x guest-vlan supplicant global configuration command to enable this behavior.

With Cisco IOS Release 12.1(22)EA2 and later, the switch maintains the EAPOL packet history. If another EAPOL packet is detected on the interface during the lifetime of the link, the guest VLAN feature is disabled. If the port is already in the guest VLAN state, the port is returned to the unauthorized state, and authentication is restarted. The EAPOL history is reset upon loss of link.

Entering the dot1x guest-vlan supplicant global configuration command disables this behavior.

Any number of non-IEEE-802.1x-capable clients are allowed access when the switch port is moved to the guest VLAN. If an IEEE 802.1x-capable client joins the same port on which the guest VLAN is configured, the port is put into the unauthorized state in the user-configured access VLAN, and authentication is restarted.

Guest VLANs are supported on IEEE 802.1x ports in single-host or multiple-hosts mode.

You can configure any active VLAN except an RSPAN VLAN or a voice VLAN as an IEEE 802.1x guest VLAN. The guest VLAN feature is not supported on trunk ports; it is supported only on access ports.

After you configure a guest VLAN for an IEEE 802.1x port to which a DHCP client is connected, you might need to get a host IP address from a DHCP server. You can also change the settings for restarting the IEEE 802.1x authentication process on the switch before the DHCP process on the client times out and tries to get a host IP address from the DHCP server. Decrease the settings for the IEEE 802.1x authentication process (IEEE 802.1x quiet period and switch-to-client transmission time).

Examples

This example shows how to specify VLAN 5 as an IEEE 802.1x guest VLAN:

Switch(config-if)# dot1x guest-vlan 5

This example shows how to set 3 as the quiet time on the switch, to set 15 as the number of seconds that the switch waits for a response to an EAP-request/identity frame from the client before resending the request, and to enable VLAN 5 as an IEEE 802.1x guest VLAN when an IEEE 802.1x port is connected to a DHCP client:

Switch(config-if)# dot1x timeout quiet-period 3
Switch(config-if)# dot1x timeout tx-period 15
Switch(config-if)# dot1x guest-vlan 5

This example shows how to enable the optional guest VLAN behavior and to specify VLAN 5 as an IEEE 802.1x guest VLAN:

Switch(config)# dot1x guest-vlan supplicant
Switch(config)# interface FastEthernet0/1
Switch(config-if)# dot1x guest-vlan 5

You can verify your settings by entering the show dot1x [interface interface-id] privileged EXEC command.

Related Commands

Command
Description

dot1x

Enables the optional guest VLAN supplicant feature.

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified interface.


dot1x host-mode

Use the dot1x host-mode interface configuration command to allow a single host (client) or multiple hosts on an IEEE 802.1x-authorized port that has the dot1x port-control interface configuration command set to auto. Use the no form of this command to return to the default setting.

dot1x host-mode {multi-host | single-host}

no dot1x host-mode [multi-host | single-host]

Syntax Description

multi-host

Enable multiple-hosts mode on the switch.

single-host

Enable single-host mode on the switch.


Defaults

The default is single-host mode.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(14)EA1

This command was introduced. It replaces the dot1x multiple-hosts interface configuration command.


Usage Guidelines

You can use this command to limit an IEEE 802.1x-enabled port to a single client or to attach multiple clients to an IEEE 802.1x-enabled port. In multiple-hosts mode, only one of the attached hosts must be successfully authorized for all hosts to be granted network access. If the port becomes unauthorized (re-authentication fails, or an Extensible Authentication Protocol over LAN [EAPOL]-logoff message is received), all attached clients are denied access to the network.

Before entering this command, make sure that the dot1x port-control interface configuration command is set to auto for the specified interface.

Examples

This example shows how to enable IEEE 802.1x authentication globally, enable IEEE 802.1x authentication on an interface, and enable multiple-hosts mode:

Switch(config)# dot1x system-auth-control
Switch(config)# interface fastethernet0/1
Switch(config-if)# dot1x port-control auto
Switch(config-if)# dot1x host-mode multi-host

You can verify your settings by entering the show dot1x [interface interface-id] privileged EXEC command.

Related Commands

Command
Description

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified interface.


dot1x initialize

Use the dot1x initialize privileged EXEC command to manually return an IEEE 802.1x-enabled port to an unauthorized state before initiating a new authentication session on the interface.

dot1x initialize interface interface-id

Syntax Description

This command has no arguments or keywords.

Defaults

There is no default setting.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(14)EA1

This command was introduced.


Usage Guidelines

Use this command to manually return a device connected to a switch interface to an unauthorized state before initiating a new authentication session on the interface.

Examples

This example shows how to manually return a device connected to a port to an unauthorized state:

Switch# dot1x initialize interface fastethernet0/1

You can verify your settings by entering the show dot1x [interface interface-id] privileged EXEC command.

Related Commands

Command
Description

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified interface.


dot1x max-req

Use the dot1x max-req interface configuration command to set the maximum number of times that the switch sends an Extensible Authentication Protocol (EAP) frame from the authentication server (assuming that no response is received) to the client before restarting the authentication process. Use the no form of this command to return to the default setting.

dot1x max-req count

no dot1x max-req

Syntax Description

count

Number of times that the switch sends an EAP frame from the authentication server before restarting the authentication process. The range is 1 to 10.


Defaults

The default is 2.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.

12.1(14)EA1

This command was changed to the interface configuration mode.


Usage Guidelines

You should change the default value of this command only to adjust for unusual circumstances such as unreliable links or specific behavioral problems with certain clients and authentication servers.

Examples

This example shows how to set 5 as the number of times that the switch sends an EAP frame before restarting the authentication process:

Switch(config-if)# dot1x max-req 5

You can verify your settings by entering the show dot1x [interface interface-id] privileged EXEC command.

Related Commands

Command
Description

dot1x timeout

Sets the number of seconds that the switch waits for a response to an EAP-request/identity frame from the client before resending the request.

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified interface.


dot1x multiple-hosts

This is an obsolete command.

In past releases, the dot1x multiple-hosts interface configuration command was used to allow multiple hosts (clients) on an IEEE 802.1x-authorized port.

Command History

Release
Modification

12.1(6)EA2

This command was introduced.

12.1(14)EA1

The dot1x multiple-hosts interface configuration command was replaced by the dot1x host-mode interface configuration command.


Related Commands

Command
Description

dot1x host-mode

Set the IEEE 802.1x host mode on an interface.

show dot1x

Displays IEEE 802.1x statistics, administrative status, and operational status for the switch or for the specified interface.


dot1x port-control

Use the dot1x port-control interface configuration command to enable manual control of the authorization state of the port. Use the no form of this command to return to the default setting.

dot1x port-control {auto | force-authorized | force-unauthorized}

no dot1x port-control

Syntax Description

auto

Enable IEEE 802.1x authentication on the interface and cause the port to transition to the authorized or unauthorized state based on the IEEE 802.1x authentication exchange between the switch and the client.

force-authorized

Disable IEEE 802.1x authentication on the interface and cause the port to transition to the authorized state without any authentication exchange required. The port sends and receives normal traffic without IEEE 802.1x-based authentication of the client.

force-unauthorized

Deny all access through this interface by forcing the port to transition to the unauthorized state, ignoring all attempts by the client to authenticate. The switch cannot provide authentication services to the client through the interface.


Defaults

The default is force-authorized.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

You must enable IEEE 802.1x authentication globally on the switch by using the dot1x system-auth-control global configuration command before enabling IEEE 802.1x authentication on a specific interface.

The IEEE 802.1x protocol is supported on Layer 2 static-access ports.

You can use the auto keyword only if the port is not configured as one of these:

Trunk port—If you try to enable IEEE 802.1x authentication on a trunk port, an error message appears, and IEEE 802.1x is not enabled. If you try to change the mode of an IEEE 802.1x-enabled port to trunk, the port mode is not changed.

Dynamic ports—A port in dynamic mode can negotiate with its neighbor to become a trunk port. If you try to enable IEEE 802.1x authentication on a dynamic port, an error message appears, and IEEE 802.1x authentication is not enabled. If you try to change the mode of an IEEE 802.1x-enabled port to dynamic, the port mode is not changed.

Dynamic-access ports—If you try to enable IEEE 802.1x authentication on a dynamic-access (VLAN Query Protocol [VQP]) port, an error message appears, and IEEE 802.1x authentication is not enabled. If you try to change an IEEE 802.1x-enabled port to dynamic VLAN assignment, an error message appears, and the VLAN configuration is not changed.

EtherChannel port—Do not configure a port that is an active or a not-yet-active member of an EtherChannel as an IEEE 802.1x port. If you try to enable IEEE 802.1x authentication on an EtherChannel port, an error message appears, and IEEE 802.1x authentication is not enabled.

Switched Port Analyzer (SPAN) destination port—You can enable IEEE 802.1x authentication on a SPAN source port but not on a SPAN destination port.

To disable IEEE 802.1x authentication globally on the switch, use the no dot1x system-auth-control global configuration command. To disable IEEE 802.1x authentication on a specific interface, use the no dot1x port-control interface configuration command.

Examples

This example shows how to enable IEEE 802.1x authentication on an interface:

Switch(config)# interface fastethernet0/1
Switch(config-if)# dot1x port-control auto

You can verify your settings by entering the show dot1x [interface interface-id] privileged EXEC command.

Related Commands

Command
Description

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified interface.


dot1x re-authenticate

Use the dot1x re-authenticate privileged EXEC command to manually initiate a re-authentication of the IEEE 802.1x-enabled port.

dot1x re-authenticate {interface interface-id}

Syntax Description

interface interface-id

Slot and port number of the interface to re-authenticate.


Defaults

There is no default setting.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

You can use this command to re-authenticate a client without waiting for the configured number of seconds between re-authentication attempts (re-authperiod) and automatic re-authentication.

Examples

This example shows how to manually re-authenticate the device connected to an interface:

Switch# dot1x re-authenticate interface fastethernet0/1

Related Commands

Command
Description

show dot1x

Displays IEEE 802.1x statistics, administrative status, and operational status for the switch or for the specified interface.


dot1x re-authentication

This is an obsolete command.

In past releases, the dot1x re-authentication global configuration command was used to set the amount of time between periodic re-authentication attempts.

Command History

Release
Modification

12.1(6)EA2

This command was introduced.

12.1(14)EA1

The dot1x reauthentication interface configuration command replaced the dot1x re-authentication global configuration command.


Related Commands

Command
Description

dot1x reauthentication

Sets the number of seconds between re-authentication attempts.

show dot1x

Displays IEEE 802.1x statistics, administrative status, and operational status for the switch or for the specified interface.


dot1x reauthentication

Use the dot1x reauthentication interface configuration command to enable periodic re-authentication of the client. Use the no form of this command to return to the default setting.

dot1x reauthentication

no dot1x reauthentication

Syntax Description

This command has no arguments or keywords.

Defaults

Periodic re-authentication is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(14)EA1

This command was introduced. It replaces the dot1x re-authentication global configuration command (with the hyphen).


Usage Guidelines

You configure the amount of time between periodic re-authentication attempts by using the dot1x timeout reauth-period interface configuration command.

Examples

This example shows how to disable periodic re-authentication of the client:

Switch(config-if)# no dot1x reauthentication

This example shows how to enable periodic re-authentication and to set the number of seconds between re-authentication attempts to 4000 seconds:

Switch(config-if)# dot1x reauthentication
Switch(config-if)# dot1x timeout reauth-period 4000

You can verify your settings by entering the show dot1x [interface interface-id] privileged EXEC command.

Related Commands

Command
Description

dot1x timeout

Sets the number of seconds between re-authentication attempts.

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified interface.


dot1x timeout

Use the dot1x timeout interface configuration command to set the IEEE 802.1x timers. Use the no form of this command to return to the default setting.

dot1x timeout {quiet-period seconds | reauth-period {seconds | server} | server-timeout seconds | supp-timeout seconds | tx-period seconds}

no dot1x timeout {quiet-period | reauth-period | server-timeout | supp-timeout | tx-period}

Syntax Description

quiet-period seconds

Number of seconds that the switch remains in the quiet state following a failed authentication exchange with the client. The range is 1 to 65535.

reauth-period seconds

Set the number of seconds between re-authentication attempts.

The keywords have these meanings:

seconds—Sets the number of seconds from 1 to 65535; the default is 3600 seconds.

server—Sets the number of seconds as the value of the Session-Timeout RADIUS attribute (Attribute[27]).

Note The server keyword is not supported on Catalyst 2950 LRE switches.

server-timeout seconds

Number of seconds that the switch waits for the retransmission of packets by the switch to the authentication server. The range is 1 to 65535.

supp-timeout seconds

Number of seconds that the switch waits for the retransmission of packets by the switch to the client. The range is 1 to 65535.

tx-period seconds

Number of seconds that the switch waits for a response to an EAP-request/identity frame from the client before retransmitting the request. The range is 1 to 65535.


Defaults

These are the defaults:

quiet-period is 60 seconds.

reauth-period is 3600 seconds.

server-timeout is 30 seconds.

supp-timeout is 30 seconds.

tx-period is 30 seconds.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.

12.1(14)EA1

The supp-timeout and server-timeout keywords were added, and the command was changed to the interface configuration mode.

12.1(22)EA5

The reauth-period server keywords were added.


Usage Guidelines

You should change the default values only to adjust for unusual circumstances such as unreliable links or specific behavioral problems with certain clients and authentication servers.

The dot1x timeout reauth-period interface configuration command affects the behavior of the switch only if you have enabled periodic re-authentication by using the dot1x reauthentication interface configuration command.

During the quiet period, the switch does not accept or initiate any authentication requests. If you want to provide a faster response time to the user, enter a number smaller than the default.

Examples

This example shows how to enable periodic re-authentication and to set the number of seconds between re-authentication attempts to 4000 seconds:

Switch(config-if)# dot1x reauthentication
Switch(config-if)# dot1x timeout reauth-period 4000

This example shows how to enable periodic re-authentication and to specify the value of the Session-Timeout RADIUS attribute as the number of seconds between re-authentication attempts:

Switch(config-if)# dot1x reauthentication
Switch(config-if)# dot1x timeout reauth-period server

This example shows how to set the quiet time on the switch to 30 seconds:

Switch(config-if)# dot1x timeout quiet-period 30

This example shows how to set 60 as the number of seconds to wait for a response to an EAP-request/identity frame from the client before re-transmitting the request:

Switch(config-if)# dot1x timeout tx-period 60

This example shows how to set the switch-to-client retransmission time for the EAP request frame to 25 seconds:

Switch(config-if)# dot1x timeout supp-timeout 25

This example shows how to set the switch-to-authentication server retransmission time to 25 seconds:

Switch(config)# dot1x timeout server-timeout 25

This example shows how to return to the default re-authorization period:

Switch(config-if)# no dot1x timeout reauth-period

You can verify your settings by entering the show dot1x [interface interface-id] privileged EXEC command.

Related Commands

Command
Description

dot1x max-req

Sets the maximum number of times that the switch sends an EAP-request/identity frame before restarting the authentication process.

dot1x reauthentication

Enables periodic re-authentication of the client.

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified interface.


duplex

Use the duplex interface configuration command to specify the duplex mode of operation for the switch ports. Use the no form of this command to return to the default setting.

duplex {auto | full | half}

no duplex

Syntax Description

auto

Port automatically detects whether it should run in full- or half-duplex mode.

full

Port is in full-duplex mode.

half

Port is in half-duplex mode.


Defaults

For Fast Ethernet and 10/100/1000 ports, the default is auto.

For the default duplex mode of the Gigabit Interface Converter (GBIC)-module ports, see the documentation that came with your GBIC module.

For small, form-factor pluggable (SFP) Gigabit Ethernet ports on Catalyst 2950 LRE switches, the default is auto.

Command Modes

Interface configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.


Usage Guidelines

Certain ports, such as GBIC module ports, can be configured to be either full duplex or half duplex. The applicability of this command depends on the device to which the switch is attached.

If the speed is set to auto, the switch negotiates with the device at the other end of the link for the speed setting and then forces the speed setting to the negotiated value. The duplex setting remains as configured on each end of the link, which could result in a duplex setting mismatch.

Beginning with Cisco IOS Release 12.1(22)EA1, you can configure the duplex setting when the speed is set to auto.

If both the speed and duplex are set to specific values, autonegotiation is disabled.

For Fast Ethernet ports, setting the port to auto has the same effect as specifying half if the attached device does not autonegotiate the duplex parameter.

The 100BASE-FX ports on Catalyst 2950C-24 switches do not support the duplex interface configuration command. These ports only operate in full-duplex and at 100 Mbps.

You can configure the 10/100/1000 ports on the Catalyst 2950T-24 and Catalyst 2950T-48-SI switches to autonegotiate the duplex mode by using the duplex auto interface configuration command. You can manually set the duplex mode to full by using the duplex full command. The 10/100/1000 ports support the half keyword only when the interface speed is 10 or 100 Mbps.

On Catalyst 2950 Long-Reach Ethernet (LRE) switches, use the duplex command to configure both the MAC and LRE chipsets.

A 10/100/1000 LRE switch port autonegotiates with the device at the other end of the link for the duplex setting and then forces the duplex setting to the negotiated value. A fiber-optic connection (SFP) also autonegotiates with the device at the other end of the link but only accepts a connection at full duplex.

The duplex setting for a SFP Gigabit Ethernet port has a close relationship to the setting for speed. Fiber-optic connections are always forced to 1000 Mbps and full-duplex mode. Copper connections can run at either full- or half-duplex mode for 10 or 100 Mbps but are can only run in full-duplex mode at 1000 Mbps. When you manually set the speed and duplex settings, autonegotiation is disabled, and speed and duplex settings can cause a mismatch.


Note For guidelines on setting the switch speed and duplex parameters, see the software configuration guide for this release.


Examples

This example shows how to set a port to half duplex:

Switch(config)# interface fastethernet0/1
Switch(config-if)# duplex half

This example shows how to set a port to full duplex:

Switch(config)# interface fastethernet0/1
Switch(config-if)# duplex full

You can verify your settings by entering the show interfaces transceiver properties or show running-config privileged EXEC command.

Related Commands

Command
Description

cpe duplex

Sets the duplex setting for customer premises equipment (CPE) Ethernet ports.

local duplex

Sets the duplex mode on an LRE port.

show running-config

Displays the configuration information running on the switch. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.

speed

Sets the port speed.


errdisable detect cause

Use the errdisable detect global configuration command to enable error disable detection. Use the no form of this command to disable this feature.

errdisable detect cause {all | dhcp-rate-limit | dtp-flap | gbic-invalid | link-flap | loopback | pagp-flap | vmps}

no errdisable detect cause {all | dhcp-rate-limit | dtp-flap | gbic-invalid | link-flap | loopback | pagp-flap | vmps}

Syntax Description

all

Enable detection for all error disable causes.

dhcp-rate-limit

Enable detection for the DHCP cause.

dtp-flap

Enable detection for the Dynamic Trunking Protocol (DTP)-flap cause.

gbic-invalid

Enable error detection for an invalid GBIC error-disable cause.

link-flap

Enable detection for the link flap cause.

loopback

Enable detection for the loopback cause.

pagp-flap

Enable detection for the Port Aggregation Protocol (PAgP)-flap cause.

vmps

Enable error detection for the VLAN Membership Policy Server (VMPS).


Defaults

The default is all, enabled for all causes.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.

12.1(9)EA1

The bpduguard, rootguard, and udld keywords were removed. The gbic-invalid keyword was added.

12.1(19)EA1

The dhcp-rate-limit and loopback keywords were added.

12.1(14)EA1

The loopback keyword was added.


Usage Guidelines

A cause (for example, dtp-flap) is the reason why the error-disabled state occurred. When a cause is detected on an interface, the interface is placed in error-disabled state, an operational state similar to link-down state. If you do not enable errdisable recovery for the cause, the interface stays in the error-disabled state until you enter the shutdown and no shutdown interface configuration commands. If you enable the recovery for a cause, the interface is brought out of the error-disabled state and allowed to retry the operation again when all the causes have timed out.

You must enter the shutdown and then the no shutdown commands to manually recover an interface from the error-disabled state.

Examples

This example shows how to enable error disable detection for the link-flap error-disable cause:

Switch(config)# errdisable detect cause link-flap

You can verify your settings by entering the show errdisable detect privileged EXEC command.

Related Commands

Command
Description

errdisable recovery

Configures the recovery mechanism variables.

show errdisable detect

Displays errdisable detection status.

show interfaces trunk

Displays interface status or a list of interfaces in error-disabled state.


errdisable recovery

Use the errdisable recovery global configuration command to configure the recover mechanism variables. Use the no form of this command to return to the default setting.

errdisable recovery {cause {all | bpduguard | channel-misconfig | dhcp-rate-limit | dtp-flap | gbic-invalid | link-flap | loopback | pagp-flap | psecure-violation | security-violation | udld | vmps}} | {interval interval}

no errdisable recovery {cause {all | bpduguard | channel-misconfig | dhcp-rate-limit | dtp-flap | gbic-invalid | link-flap | loopback | pagp-flap | psecure-violation | security-violation | udld | vmps}} | {interval interval}

Syntax Description

cause

Enable error disable to recover from a specific cause.

all

Enable the timer to recover from all error-disable causes.

bpduguard

Enable the timer to recover from the bridge protocol data unit (BPDU)-guard error-disable state.

channel-misconfig

Enable the timer to recover from the EtherChannel misconfiguration error-disable state.

dhcp-rate-limit

Enable the timer to recover from the DHCP error-disable state.

dtp-flap

Enable the timer to recover from the Dynamic Trunking Protocol (DTP)-flap error-disable state.

gbic-invalid

Enable the timer to recover from an invalid GBIC error disable state.

link-flap

Enable the timer to recover from the link-flap error-disable state.

loopback

Enable the timer to recover from the loopback error-disable state.

pagp-flap

Enable the timer to recover from the Port Aggregation Protocol (PAgP)-flap error-disable state.

psecure-violation

Enable the timer to recover from a port security violation disable state.

security-violation

Enable the timer to recover from an IEEE 802.1x violation disable state.

udld

Enable the timer to recover from the UniDirectional Link Detection (UDLD) error-disable state.

vmps

Enable the timer to recover from a VLAN Membership Policy Server (VMPS) error-disable state.

interval interval

Specify the time to recover from specified error-disable state. The range is 30 to 86400 seconds. The same interval is applied to all causes. The default interval is 300 seconds.

Note The errdisable recovery timer initializes at a random differential from the configured interval value. The difference between the actual timeout value and the configured value can be up to 15 percent of the configured interval.



Note Though visible in the command-line help string, the unicast-flood keyword is not supported.


Defaults

Recovery is disabled for all causes.

The default interval is 300 seconds.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.

12.1(9)EA1

The gbic-invalid and psecure-violation keywords were added. The rootguard keyword was removed.

12.1(13)EA1

The channel-misconfig keyword was added.

12.1(19)EA1

The dhcp-rate-limit and loopback keywords were added.


Usage Guidelines

A cause (for example, bpduguard) is defined as the reason why the error-disabled state occurred. When a cause is detected on an interface, the interface is placed in error-disabled state, an operational state similar to link-down state. If you do not enable errdisable recovery for the cause, the interface stays in error-disabled state until you enter a shutdown and no shutdown interface configuration command. If you enable the recovery for a cause, the interface is brought out of the error-disabled state and allowed to retry the operation again when all the causes have timed out.

Otherwise, you must enter the shutdown and then no shutdown commands to manually recover an interface from the error-disabled state.

Examples

This example shows how to enable the recovery timer for the BPDU guard error-disable cause:

Switch(config)# errdisable recovery cause bpduguard

This example shows how to set the timer to 500 seconds:

Switch(config)# errdisable recovery interval 500

You can verify your settings by entering the show errdisable recovery privileged EXEC command.

Related Commands

Command
Description

show errdisable recovery

Displays errdisable recovery timer information.

show interfaces status

Displays interface status.


flowcontrol

Use the flowcontrol interface configuration command to set the receive or send flow-control value for a Gigabit Ethernet interface. When flow control send is on for a device and it detects any congestion at its end, it notifies the link partner or the remote device of the congestion by sending a pause frame. When flow control receive is on for the remote device and it receives a pause frame, it stops sending any data packets. This prevents any loss of data packets during the congestion period.

Use the receive off and send off keywords to disable flow control.

flowcontrol {receive | send} {desired | off | on}


Note This flowcontrol command applies only to switch and module ports operating at 1000 Mbps.


Syntax Description

receive

Sets whether the interface can receive flow-control packets from a remote device.

send

Sets whether the interface can send flow-control packets to a remote device.

desired

When used with receive, allows an interface to operate with an attached device that is required to send flow-control packets or with an attached device that is not required to but can send flow-control packets.
When used with send, the interface sends flow-control packets to a remote device if the remote device supports it.

off

When used with receive, turns off an attached device's ability to send flow-control packets to an interface. When used with send, turns off the local port's ability to send flow-control packets to a remote device.

on

When used with receive, allows an interface to operate with an attached device that is required to send flow-control packets or with an attached device that is not required to but can send flow-control packets.
When used with send, the interface sends flow-control packets to a remote device if the remote device supports it.


Defaults

The defaults for 10/100/1000, GBIC-module ports, and small form-factor pluggable (SFP) -module ports are flowcontrol receive off and flowcontrol send desired.

Command Modes

Interface configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.

12.1(6)EA2

The asymmetric and symmetric keywords were replaced with the receive, send, off, on, and desired keywords.


Usage Guidelines

Use the flowcontrol command only on 10/100/1000, GBIC-module ports, and SFP-module ports.

We strongly recommend that you do not configure IEEE 802.3x flowcontrol when quality of service (QoS) is configured on the switch. Before configuring flowcontrol on an interface, make sure to disable QoS on the switch.

Note that when used with receive, the on and desired keywords have the same result.

When you use the flowcontrol command to set a port to control traffic rates during congestion, you are setting flow control on a port to one of these conditions:

receive on and send on: Flow control operates in both directions; pause frames can be sent by both the local device and the remote device to show link congestion.

receive on and send desired: The port can receive pause frames and is able to send pause frames if the attached device supports them.

receive on and send off: The port cannot send pause frames, but can operate with an attached device that is required to or is able to send pause frames; the port is able to receive pause frames.

receive off and send on: The port sends pause frames if the remote device supports them, but cannot receive pause frames from the remote device.

receive off and send desired: The port cannot receive pause frames, but can send pause frames if the attached device supports them.

receive off and send off: Flow control does not operate in either direction. In case of congestion, no indication is given to the link partner, and no pause frames are sent or received by either device.

Table 2-3 shows the flow control resolution achieved on local and remote ports by a combination of settings. The table assumes that for receive, using the desired keyword has the same results as using the on keyword.

Table 2-3 Flow Control Settings and Local and Remote Port Flow Control Resolution 

Flow Control Settings
Flow Control Resolution
Local Device
Remote Device
Local Device
Remote Device

send on/receive on

send on/receive on

send on/receive off

send desired/receive on

send desired/receive off

send off/receive on

send off/receive off

Sends and receives

Does not send or receive

Sends and receives

Does not send or receive

Sends and receives

Does not send or receive

Sends and receives

Does not send or receive

Sends and receives

Does not send or receive

Receives only

Does not send or receive

send on/receive off

send on/receive on

send on/receive off

send desired/receive on

send desired/receive off

send off/receive on

send off/receive off

Does not send or receive

Does not send or receive

Sends only

Does not send or receive

Sends only

Does not send or receive

Does not send or receive

Does not send or receive

Receives only

Does not send or receive

Receives only

Does not send or receive

send desired/receive on

send on/receive on

send on/receive off

send desired/receive on

send desired/receive off

send off/receive on

send off/receive off

Sends and receives

Receives only

Sends and receives

Receives only

Sends and receives

Does not send or receive

Sends and receives

Sends only

Sends and receives

Sends only

Receives only

Does not send or receive

send desired/receive off

send on/receive on

send on/receive off

send desired/receive on

send desired/receive off

send off/receive on

send off/receive off

Does not send or receive

Does not send or receive

Sends only

Does not send or receive

Sends only

Does not send or receive

Does not send or receive

Does not send or receive

Receives only

Does not send or receive

Receives only

Does not send or receive

send off/receive on

send on/receive on

send on/receive off

send desired/receive on

send desired/receive off

send off/receive on

send off/receive off

Receives only

Receives only

Receives only

Receives only

Receives only

Does not send or receive

Sends and receives

Sends only

Sends and receives

Sends only

Receives only

Does not send or receive

send off/receive off

send on/receive on

send on/receive off

send desired/receive on

send desired/receive off

send off/receive on

send off/receive off

Does not send or receive

Does not send or receive

Does not send or receive

Does not send or receive

Does not send or receive

Does not send or receive

Does not send or receive

Does not send or receive

Does not send or receive

Does not send or receive

Does not send or receive

Does not send or receive


Examples

This example shows how to configure the local port to not support any level of flow control by the remote port:

Switch(config-if)# flowcontrol receive off
Switch(config-if)# flowcontrol send off

You can verify your settings by entering the show interfaces or show flowcontrol privileged EXEC command.

Related Commands

Command
Description

show interfaces flowcontrol

Displays interface input and output flow control settings and status.

show flowcontrol

Displays flow control settings and status for specified interfaces or all interfaces on the switch.


hw-module slot

Use the hw-module slot privileged EXEC command to perform firmware upgrades on Long-Reach Ethernet (LRE) systems.

hw-module slot module-slot-number upgrade lre [force] [{local ctrlr-unit-number | remote interface-id}]

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

module-slot-number

Physical slot that connects the local device (LRE switch) and the remote customer premises equipment (CPE) device for the upgrade.

force

(Optional) LRE binaries update by force, even when the version of the LRE binary on the switch flash memory and the LRE binary in use are the same.

local ctrlr-unit-number

(Optional) The single LRE chipset for a controller at the local end of the LRE Ethernet link.

remote interface-id

(Optional) One or more chipsets on a single CPE device at the remote end of the LRE Ethernet link.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Use the hw-module slot command to start an LRE upgrade. You can start an LRE upgrade by using one of these methods:

Upgrade all LRE local chipsets (controllers) and remote CPE devices by entering the hw-module slot module-slot-number upgrade lre command.

Upgrade a single local LRE controller by entering the hw-module slot module-slot-number lre upgrade local ctrlr-unit-number command.

Upgrade a single remote LRE CPE device by entering the hw-module slot module-slot number lre upgrade remote interface-id command.

You can use the force keyword to upgrade an LRE binary on a local LRE controller or a remote LRE CPE device, even though the device is already running the version of the desired LRE binary. The default behavior is to not upgrade LRE binaries that are already up to date.

During an upgrade, users on the LRE links being upgraded experience a temporary disruption of Ethernet connectivity. All LRE local and remote upgrades run concurrently and take 3 to 6 minutes to complete.

The command-line interface (CLI) is available while an LRE upgrade is in progress.

Once started, an LRE upgrade can only be stopped by physically changing the remote CPE device or by reloading the software on the Ethernet switch.

In most cases, configuration for upgrades is not necessary.

Examples

This example shows how to start a system-wide LRE upgrade:

Switch# hw-module slot 0 upgrade lre

You are about to start an LRE upgrade on all LRE interfaces.
Users on LRE links being upgraded will experience a temporary
disruption of Ethernet connectivity.

Start LRE upgrade ? [yes]:

Starting remote upgrade on CPE Lo0/1.
Starting remote upgrade on CPE Lo0/2
Starting remote upgrade on CPE Lo0/3
Starting remote upgrade on CPE Lo0/4
Starting remote upgrade on CPE Lo0/5
Starting remote upgrade on CPE Lo0/6
Starting remote upgrade on CPE Lo0/7
Starting remote upgrade on CPE Lo0/8
Starting upgrade on local controller LongReachEthernet 0
Starting remote upgrade on CPE Lo0/9

<output truncated>

Starting remote upgrade on CPE Lo0/23
Starting remote upgrade on CPE Lo0/24
Starting upgrade on local controller LongReachEthernet 2

This example shows how to start an LRE upgrade on a single LRE controller in a switch. Specifying the interface-id as longreachethernet 0 causes an LRE upgrade to run on controller 0 in the switch.

Switch# hw-module slot 0 upgrade lre local longreachethernet 0
You are about to start an LRE upgrade on local controller LongReachEthernet 0.
Users on LRE links being upgraded will experience a temporary
disruption of Ethernet connectivity.

Start LRE upgrade ? [yes]:

Starting Upgrade on local controller LongReachEthernet 0

This example shows how to start an LRE upgrade on a single CPE device. Specifying the interface-id as longreachethernet 0 causes an LRE upgrade to run on the CPE device connected to the LRE port 1.

Switch# hw-module slot 0 upgrade lre remote longreachethernet0/1

You are about to start an LRE upgrade on CPE Lo0/1.
Users on LRE links being upgraded will experience a temporary
disruption of Ethernet connectivity.

Start LRE upgrade ? [yes]:

Starting remote upgrade on CPE Lo0/1

This example shows what happens when you attempt to update current firmware without using the force option:

Switch# hw-module slot 0 upgrade lre remote longreachethernet0/1

You are about to start an LRE upgrade on CPE Lo0/1.
Users on LRE links being upgraded will experience a temporary
disruption of Ethernet connectivity.

Start LRE upgrade ? [yes]:

No upgrade required on CPE Lo0/1

This example shows how to use the force option when you attempt to update current firmware on a CPE:

Switch# hw-module slot 0 upgrade lre force remote longreachethernet0/1

You are about to start an LRE upgrade on CPE Lo0/1.
Users on LRE links being upgraded will experience a temporary
disruption of Ethernet connectivity.

Start LRE upgrade ? [yes]:

Starting remote upgrade on CPE Lo0/1

Switch#

Related Commands

Command
Description

controller longreachethernet

Allows you to enter controller mode.

show lre upgrade

Displays the LRE binaries present on the system flash memory, the upgrade status on all ports in the switch, or the binaries on local and remote ends on all ports.


interface

Use the interface global configuration command to configure an interface type, create a switch virtual interface to be used as the management VLAN interface, and to enter interface configuration mode.

interface {interface-id | vlan number}

no interface {interface-id | vlan number}

Syntax Description

interface-id

Specify the interface type and number.

vlan number

VLAN number from 1 to 4094 to be used as the management VLAN.


Defaults

The default management VLAN interface is VLAN 1.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.


Usage Guidelines

When creating a management VLAN interface, a space between vlan and number is accepted.

Only one management VLAN interface can be active.

You cannot delete the management VLAN 1 interface.

You can use the no shutdown interface configuration command to shut down the active management VLAN interface and to enable a new one.

You can configure the management VLAN interface on static-access and trunk ports.

Examples

This example shows how enter interface configuration mode for an interface:

Switch(config)# interface fastethernet0/2
Switch(config-if)#

This example shows how to change the management VLAN from the default management VLAN to VLAN 3. This series of commands should only be entered from the service port. If these commands are entered through a Telnet session, the shutdown command disconnects the session, and there is no way to use IP to access the system.

Switch# configure terminal
Switch(config)# interface vlan 3
Switch(config-if)# ip address 172.20.128.176 255.255.255.0
Switch(config-if)# no shutdown
Switch(config-if)# exit

You can verify your settings by entering the show interfaces and show interfaces vlan vlan-id privileged EXEC commands.

Related Commands

Command
Description

show interfaces

Displays the administrative and operational status of a switching (nonrouting) port.

shutdown

Disables a port and shuts down the management VLAN.


interface port-channel

Use the interface port-channel global configuration command to access or create the port-channel logical interface for Layer 2 interfaces. Use the no form of this command to remove the port channel.

interface port-channel port-channel-number

no interface port-channel port-channel-number

Syntax Description

port-channel-number

Port-channel number. The range is 1 to 6.


Defaults

No port-channel logical interfaces are defined.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

Only one port channel in a channel group is allowed.

Follow these guidelines when you use the interface port-channel command:

If you want to use the Cisco Discovery Protocol (CDP), you must configure it only on the physical interface and not on the port-channel interface.

On the port-channel interface, if you do not assign a static MAC address or if you assign a static MAC address and then later remove it, the switch automatically assigns a MAC address to the interface.

Examples

This example shows how to create a port-channel interface with a port-channel number of 5:

Switch(config)# interface port-channel 5

You can verify your settings by entering the show running-config or show etherchannel channel-group-number detail privileged EXEC command.

Related Commands

Command
Description

channel-group

Assigns an Ethernet interface to an EtherChannel group.

show etherchannel

Displays EtherChannel information for a channel.

show running-config

Displays the configuration information running on the switch. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


interface range

Use the interface range global configuration command to enter interface range configuration mode and to execute a command on multiple ports at the same time. Use the no form of this command to remove an interface range.

interface range {port-range | macro name}

no interface range {port-range | macro name}

Syntax Description

port-range

Port range. For a list of valid values for port-range, see the "Usage Guidelines" section.

macro name

Specify the name of a macro.


Defaults

This command has no default setting.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

From the interface range configuration mode, all interface parameters that you enter are applied to all interfaces within the range.

For VLANs, you can use the interface range command only on existing VLAN interfaces. To display VLAN interfaces, enter the show running-config privileged EXEC command. VLANs not displayed cannot be used in the interface range command. The commands that you enter under the interface range command are applied to all existing VLAN interfaces in the range.

All configuration changes made to an interface range are saved to NVRAM, but the interface range itself is not saved to NVRAM.

You can enter the interface range in two ways:

Specifying up to five interface ranges

Specifying a previously defined interface-range macro

You can define up to five interface ranges with a single command, with each range separated by a comma (,).

All interfaces in a range must be the same type; that is, all Fast Ethernet ports, all Gigabit Ethernet ports, all EtherChannel ports, all Long-Reach Ethernet (LRE) ports, or all VLANs.

These are the valid values for port-range type and interface:

vlan vlan-id, where vlan-id is from 1 to4094

port-channel port-channel-number, where port-channel-number is from 1 to 6

fastethernet interface-id

gigabitethernet interface-id

longreachethernet interface-id

For physical interfaces, the interface-id is defined as a slot/number (where slot is always 0 for the switch), and the range is entered as type 0/number - number (for example, fastethernet0/1 - 2). You can also enter multiple ranges.

When you define a range, you must enter a space before and after the hyphen (-):

interface range fastethernet0/1 - 2

When you define multiple ranges, you must enter a space before and after the comma (,):

interface range fastethernet0/3 - 7 , gigabitethernet0/1

You cannot specify both a macro and an interface range in the same command.

A single interface can also be specified in port-range. (The command is then similar to the interface interface-id global configuration command.)


Note For more information about configuring interface ranges, see the software configuration guide for this release.


Examples

This example shows how to use the interface range command to enter interface range configuration mode and to enter commands for two ports:

Switch(config)# interface range fastethernet0/1 - 2
Switch(config-if-range)#

This example shows how to use a port-range macro macro1 for the same function. The advantage is that you can reuse the macro1 until you delete it.

Switch(config)# define interface-range macro1 fastethernet0/1 - 2
Switch(config)# interface range macro macro1
Switch(config-if-range)#

Related Commands

Command
Description

show running-config

Displays the configuration information running on the switch. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


interleave

Use the interleave interface configuration command to set the interleave block size on the Long-Reach Ethernet (LRE) interfaces. Use the no form of this command to return to the default setting.

interleave {downstream value | upstream value}

no interleave {downstream value | upstream value}

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

downstream value

Value at the local end of the link. Valid block size entries are 0, 1, 2, 8, or 16.

upstream value

Value at the remote end of the link. Valid block size entries are 0, 1, 2, 8, or 16.


Defaults

The default is 0 for low latency (LL) profiles and 16 for non-LL profiles.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ4

This command was introduced.


Usage Guidelines

The interleave delay is applicable only when the non-LL profiles are used. Existing LL profiles are supported.

Different ports with the same profile can have different interleave settings.

A lower value of interleave block size indicates less tolerance to noise and causes a lower latency of frame transmission. For example, lower values of interleave block size can be used for voice applications. A higher value of interleave block size indicates higher tolerance to noise and causes higher latency in the frame transmission. For example, higher values of interleave block size can be used for data applications.

If a lower latency of frame transmission is required, you can use a lower interleave value but you will have less tolerance to noise.

For information on configuring the interleave delay, see the switch software configuration guide for this release.

Examples

This example shows how to specify an interleave value of 2 for both upstream and downstream ends of the link:

Switch(config-if)# interleave upstream 2 downstream 2

You can verify your settings by entering the show controllers lre status interleave privileged EXEC command.

Related Commands

Command
Description

show controllers lre status interleave

Displays the interleave block size values on the LRE interfaces.


ip access-group

Use the ip access-group interface configuration command to control access to an interface. Use the no form of this command to remove an access group from an interface.

ip access-group {access-list-number | name} in

no ip access-group {access-list-number | name} in

This command is available on physical interfaces only if your switch is running the enhanced software image (EI).

Syntax Description

access-list-number

Number of the IP access control list (ACL). The range is 1 to 199 and 1300 to 2699.

name

Name of an IP ACL, specified in the ip access-list command.


Defaults

No ACL is applied to the interface.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

You can apply IP ACLs only to ingress interfaces. If a MAC access group is already defined for an interface, you cannot apply this command to the interface.

The ACLs can be standard or extended.

For standard ACLs, after receiving a packet, the switch checks the packet source address. If the source address matches a defined address in the ACL and the list permits the address, the switch forwards the packet.

For extended ACLs, after receiving the packet, the switch checks the match conditions in the ACL. If the conditions are matched, the switch forwards the packet.

If the specified ACL does not exist, the switch forwards all packets.

IP access groups can be separated on Layer 2 and Layer 3 interfaces.


Note For more information about configuring IP ACLs, see the "Configuring Network Security with ACLs" chapter in the software configuration guide for this release.


Examples

This example shows how to apply a numbered ACL to an interface:

Switch(config)# interface fastethernet0/1
Switch(config-if)# ip access-group 101 in

You can verify your settings by entering the show access-lists or show ip access-lists privileged EXEC command.

Related Commands

Command
Description

access-list (IP extended)

Defines an extended IP ACL.

access-list (IP standard)

Defines a standard IP ACL.

deny (access-list configuration)

Configures conditions for an IP ACL.

ip access-list

Defines an IP ACL.

permit (access-list configuration)

Configures conditions for an IP ACL.

show access-lists

Displays ACLs configured on the switch.

show ip access-lists

Displays IP ACLs configured on the switch.


ip access-list

Use the ip access-list global configuration command to create an IP access control list (ACL) to be used for matching packets to an ACL whose name or number you specify and to enter access-list configuration mode. Use the no form of this command to delete an existing IP ACL and to return to global configuration mode.

ip access-list {extended | standard} {access-list-number | name}

no ip access-list {extended | standard} {access-list-number | name}

This command is available on physical interfaces only if your switch is running the enhanced software image (EI).

Syntax Description

access-list-number

Number of an ACL.

For standard IP ACLs, the range is 1 to 99 and 1300 to 1999.

For extended IP ACLs, the range 100 to 199 and 2000 to 2699.

name

Name of an ACL.

The ACL name must begin with an alphabetic character to prevent ambiguity with numbered ACLs. A name also cannot contain a space or quotation mark.


Defaults

No named or numbered IP ACLs are defined.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

Use this command to enter access-list configuration mode and to specify the name or number of the IP ACL for which you want to create or modify ACL match criteria. In this mode, you must enter the permit and deny commands to configure the permit and deny access conditions for this list.

Use the ip access-list command and its subcommands to define packet classification and marking as part of a globally-named service policy applied on a per-interface basis or as an IP access group applied on a per-interface basis.

Specifying standard or extended with the ip access-list command determines the prompt that you get when you enter access-list configuration mode.


Note For more information about configuring IP ACLs, see the "Configuring Network Security with ACLs" chapter in the software configuration guide for this release.


Examples

This example shows how to configure a standard ACL named Internetfilter1:

Switch(config)# ip access-list standard Internetfilter1
Switch(config-std-nacl)# permit 192.5.34.0  0.0.0.255
Switch(config-std-nacl)# permit 192.5.32.0  0.0.0.255
Switch(config-std-nacl)# exit

This example shows how to configure an extended ACL named Internetfilter2:

Switch(config)# ip access-list extended Internetfilter2
Switch(config-ext-nacl)# permit any 128.8.10.0  0.0.0.255 eq 80
Switch(config-ext-nacl)# permit any 128.5.8.0  0.0.0.255 eq 80
Switch(config-ext-nacl)# exit


Note In these examples, all other IP access is implicitly denied.


You can verify your settings by entering the show access-lists or show ip access-lists privileged EXEC command.

Related Commands

Command
Description

deny (access-list configuration)

Configures conditions for an IP ACL.

ip access-group

Controls access to an interface.

permit (access-list configuration)

Configures conditions for an IP ACL.

service-policy

Applies a policy map to the input of an interface.

show access-lists

Displays ACLs configured on the switch.

show ip access-lists

Displays IP ACLs configured on the switch.


ip address

Use the ip address interface configuration command to set an IP address for a switch. Use the no form of this command to remove an IP address or to disable IP processing.

ip address ip-address subnet-mask

no ip address ip-address subnet-mask

Syntax Description

ip-address

IP address.

subnet-mask

Mask for the associated IP subnet.


Defaults

No IP address is defined for the switch.

Command Modes

Interface configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.


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. The default for the management VLAN is VLAN 1, but you can configure a different VLAN as the management VLAN.

If you remove the IP address through a Telnet or Secure Shell (SSH) session, your connection to the switch is lost.

If your switch receives its IP address from a Bootstrap Protocol (BOOTP) or a DHCP server and you remove the switch IP address by using the no ip address command, IP processing is disabled, and the BOOTP or DHCP server cannot reassign the address.

Examples

This example shows how to configure the IP address for the switch on a subnetted network:

Switch(config)# interface vlan 1
Switch(config-if)# ip address 172.20.128.2 255.255.255.0

You can verify your settings by entering the show running-config privileged EXEC command.

Related Commands

Command
Description

show running-config

Displays the configuration information running on the switch. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


ip dhcp snooping

Use the ip dhcp snooping global configuration command to globally enable DHCP snooping. Use the no form of this command to return to the default setting.

ip dhcp snooping

no ip dhcp snooping

Syntax Description

This command has no arguments or keywords.

Defaults

DHCP snooping is disabled.

Command Modes

Global configuration

Command History

Release
Modification

12.1(19)EA1

This command was introduced.


Usage Guidelines

You must globally enable DHCP snooping for any DHCP snooping configuration to take effect.

DHCP snooping is not active until snooping is enabled on a VLAN by using the ip dhcp snooping vlan vlan-id global configuration command.

Examples

This example shows how to enable DHCP snooping:

Switch(config)# ip dhcp snooping

You can verify your settings by entering the show ip dhcp snooping privileged EXEC command.

Related Commands

Command
Description

ip dhcp snooping vlan

Enables DHCP snooping on a VLAN.

show ip dhcp snooping

Displays the DHCP snooping configuration.

show ip dhcp snooping binding

Displays the DHCP snooping binding information.


ip dhcp snooping information option

Use the ip dhcp snooping information option global configuration command to enable DHCP option-82 data insertion. Use the no form of this command to disable DHCP option-82 data insertion.

ip dhcp snooping information option

no ip dhcp snooping information option

Syntax Description

This command has no arguments or keywords.

Defaults

DHCP option-82 data insertion is enabled.

Command Modes

Global configuration

Command History

Release
Modification

12.1(19)EA1

This command was introduced.


Usage Guidelines

You must globally enable DHCP snooping by using the ip dhcp snooping global configuration command for any DHCP snooping configuration to take effect.

When the option-82 feature is enabled and a switch receives a DHCP request from a host, it adds the option-82 information in the packet. The option-82 information contains the switch MAC address (the remote ID suboption) and the port identifier, vlan-mod-port, from which the packet is received (circuit ID suboption). The switch forwards the DHCP request that includes the option-82 field to the DHCP server.

When the DHCP server receives the packet, it can use the remote ID, the circuit ID, or both to assign IP addresses and implement policies, such as restricting the number of IP addresses that can be assigned to a single remote ID or a circuit ID. Then the DHCP server echoes the option-82 field in the DHCP reply.

The DHCP server unicasts the reply to the switch if the request was relayed to server by the switch. When the client and server are on the same subnet, the server broadcasts the reply. The switch inspects the remote ID and possibly the circuit ID fields to verify that it originally inserted the option-82 data. The switch removes the option-82 field and forwards the packet to the switch port that connects to the DHCP host that sent the DHCP request.

Examples

This example shows how to enable DHCP option-82 data insertion:

Switch(config)# ip dhcp snooping information option

You can verify your settings by entering the show ip dhcp snooping privileged EXEC command.

Related Commands

Command
Description

show ip dhcp snooping

Displays the DHCP snooping configuration.

show ip dhcp snooping binding

Displays the DHCP snooping binding information.


ip dhcp snooping information option allow-untrusted

Use the ip dhcp snooping information option allow-untrusted global configuration command on an aggregation switch to configure it to accept DHCP packets with option-82 information that are received on untrusted ports that might be connected to an edge switch. Use the no form of this command to configure the switch to drop these packets from the edge switch.

ip dhcp snooping information option allow-untrusted

no ip dhcp snooping information option allow-untrusted

Syntax Description

This command has no arguments or keywords.

Defaults

The switch drops DHCP packets with option-82 information that are received on untrusted ports that might be connected to an edge switch.

Command Modes

Global configuration

Command History

Release
Modification

12.1(22)EA3

This command was introduced.


Usage Guidelines

You might want an edge switch to which a host is connected to insert DHCP option-82 information at the edge of your network. You might also want to enable DHCP security features, such as DHCP snooping, IP source guard, or dynamic Address Resolution Protocol (ARP) inspection, on an aggregation switch. However, if DHCP snooping is enabled on the aggregation switch, the switch drops packets with option-82 information that are received on an untrusted port and does not learn DHCP snooping bindings for connected devices on a trusted interface.

If the edge switch to which a host is connected inserts option-82 information and you want to use DHCP snooping on an aggregation switch, enter the ip dhcp snooping information option allow-untrusted command on the aggregation switch. The aggregation switch can learn the bindings for a host even though the aggregation switch receives DHCP snooping packets on an untrusted port. You can also enable DHCP security features on the aggregation switch. The port on the edge switch to which the aggregation switch is connected must be configured as a trusted port.


Note Do not enter the ip dhcp snooping information option allow-untrusted command on an aggregation switch to which an untrusted device is connected. If you enter this command, an untrusted device might spoof the option-82 information.


Examples

This example shows how to configure an access switch to not check the option-82 information in untrusted packets from an edge switch and to accept the packets:

Switch(config)# ip dhcp snooping information option allow-untrusted

You can verify your settings by entering the show ip dhcp snooping privileged EXEC command.

Related Commands

Command
Description

show ip dhcp snooping

Displays the DHCP snooping configuration.

show ip dhcp snooping binding

Displays the DHCP snooping binding information.


ip dhcp snooping limit rate

Use the ip dhcp snooping limit rate interface configuration command to configure the number of DHCP messages an interface can receive per second. Use the no form of this command to return to the default setting.

ip dhcp snooping limit rate rate

no ip dhcp snooping limit rate

Syntax Description

rate

Number of DHCP messages an interface can receive per second. The range is
1 to 4294967294.


Defaults

DHCP snooping rate limiting is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(19)EA1

This command was introduced.


Usage Guidelines

Normally, the rate limit applies to untrusted interfaces. If you want to configure rate limiting for trusted interfaces, keep in mind that trusted interfaces might aggregate DHCP traffic on multiple VLANs (some of which might not be snooped) in the switch, and you will need to adjust the interface rate limits to a higher value.

If the rate limit is exceeded, the interface is error-disabled. If you enabled error recovery by entering the errdisable recovery dhcp-rate-limit global configuration command, the interface retries the operation again when all the causes have timed out. If the error-recovery mechanism is not enabled, the interface stays in the error-disabled state until you enter the shutdown and no shutdown interface configuration commands.

Examples

This example shows how to set a message rate limit of 150 messages per second on an interface:

Switch(config-if)# ip dhcp snooping limit rate 150

You can verify your settings by entering the show ip dhcp snooping privileged EXEC command.

Related Commands

Command
Description

errdisable recovery

Configures the recover mechanism.

show ip dhcp snooping

Displays the DHCP snooping configuration.

show ip dhcp snooping binding

Displays the DHCP snooping binding information.


ip dhcp snooping trust

Use the ip dhcp snooping trust interface configuration command to configure a port as trusted for DHCP snooping purposes. Use the no form of this command to return to the default setting.

ip dhcp snooping trust

no ip dhcp snooping trust

Syntax Description

This command has no arguments or keywords.

Defaults

DHCP snooping trust is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(19)EA1

This command was introduced.


Usage Guidelines

Configure ports that are connected to a DHCP server or to other switches or routers as trusted. Configure ports that are connected to DHCP clients as untrusted.

Examples

This example shows how to enable DHCP snooping trust on a port:

Switch(config-if)# ip dhcp snooping trust

You can verify your settings by entering the show ip dhcp snooping privileged EXEC command.

Related Commands

Command
Description

show ip dhcp snooping

Displays the DHCP snooping configuration.

show ip dhcp snooping binding

Displays the DHCP snooping binding information.


ip dhcp snooping vlan

Use the ip dhcp snooping vlan global configuration command to enable DHCP snooping on a VLAN. Use the no form of this command to disable DHCP snooping on a VLAN.

ip dhcp snooping vlan vlan-id [vlan-id]

no ip dhcp snooping vlan vlan-id [vlan-id]

Syntax Description

vlan vlan-id [vlan-id]

Specify a VLAN ID or range of VLANs on which to enable DHCP snooping. The range is 1 to 4094.

You can enter a single VLAN ID identified by VLAN ID number, a series of VLAN IDs separated by commas, a range of VLAN IDs separated by hyphens, or a range of VLAN IDs separated by entering the starting and ending VLAN IDs separated by a space.


Defaults

DHCP snooping is disabled on all VLANs.

Command Modes

Global configuration

Command History

Release
Modification

12.1(19)EA1

This command was introduced.


Usage Guidelines

You must first globally enable DHCP snooping before enabling DHCP snooping on a VLAN.

Examples

This example shows how to enable DHCP snooping on VLAN 10:

Switch(config)# ip dhcp snooping vlan 10

You can verify your settings by entering the show ip dhcp snooping privileged EXEC command.

Related Commands

Command
Description

show ip dhcp snooping

Displays the DHCP snooping configuration.

show ip dhcp snooping binding

Displays the DHCP snooping binding information.


ip igmp filter

Use the ip igmp filter interface configuration command to control whether or not all hosts on a Layer 2 interface can join one or more IP multicast groups by applying an Internet Group Management Protocol (IGMP) profile to the interface. Use the no form of this command to remove the specified profile from the interface.

ip igmp filter profile number

no ip igmp filter

Syntax Description

profile number

The IGMP profile number to be applied. The range is 1 to 4294967295.


Defaults

No IGMP filters are applied.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(9)EA1

This command was introduced.


Usage Guidelines

You can apply IGMP filters only to Layer 2 physical interfaces; you cannot apply IGMP filters to routed ports, switch virtual interfaces (SVIs), or ports that belong to an EtherChannel group.

An IGMP profile can be applied to one or more switch port interfaces, but one port can have only one profile applied to it.

Examples

This example shows how to apply IGMP profile 22 to an interface.

Switch(config)# interface fastethernet0/1
Switch(config-if)# ip igmp filter 22

You can verify your setting by using the show running-config interface interface-id privileged EXEC command.

Related Commands

Command
Description

ip igmp profile

Configures the specified IGMP profile number.

show ip igmp profile

Displays the characteristics of the specified IGMP profile.

show running-config interface interface-id

Displays the running configuration on the switch interface, the IGMP profile (if any) that is applied to an interface. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


ip igmp max-groups

Use the ip igmp max-groups interface configuration command to set the maximum number of Internet Group Management Protocol (IGMP) groups that a Layer 2 interface can join or to configure the IGMP throttling action when the maximum number of entries is in the forwarding table. Use the no form of this command to set the maximum back to the default, which is to have no maximum limit, or to return to the default throttling action, which is to drop the report.

ip igmp max-groups {number | action {deny | replace}}

no ip igmp max-groups {number | action}

Syntax Description

number

The maximum number of IGMP groups that an interface can join. The range is 0 to 4294967294. The default is no limit.

action {deny | replace}

Set the throttling action. The keywords have these meanings:

deny—When the maximum number of entries is in the IGMP snooping forwarding table, drop the next IGMP join report. This is the default action.

replace—When the maximum number of entries is in the IGMP snooping forwarding table, replace the existing group with the new group for which the IGMP report was received.


Defaults

The default maximum number of groups is no limit.

After the switch learns the maximum number of IGMP group entries on an interface, the default throttling action is to drop the next IGMP report that the interface receives and to not add an entry for the IGMP group to the interface.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(9)EA1

This command was introduced.

12.1(19)EA1

The action {deny | replace} keywords were added.


Usage Guidelines

You can use this command only on Layer 2 physical interfaces and on logical EtherChannel interfaces. You cannot set IGMP maximum groups or configure the IGMP throttling action for ports that belong to an EtherChannel group.

Follow these guidelines when configuring the IGMP throttling action:

If you configure the throttling action as deny and set the maximum group limitation, the entries that were previously in the forwarding table are not removed but are aged out. After these entries are aged out and the maximum number of entries is in the forwarding table, the switch drops the next IGMP report received on the interface.

If you configure the throttling action as replace and set the maximum group limitation, the entries that were previously in the forwarding table are removed. When the maximum number of entries is in the forwarding table, the switch replaces a randomly selected multicast entry with the received IGMP report.

When the maximum group limitation is set to the default (no maximum), entering the ip igmp max-groups {deny | replace} command has no effect.

Examples

This example shows how to limit to 25 the number of IGMP groups that an interface can join:

Switch(config)# interface fastethernet0/1
Switch(config-if)# ip igmp max-groups 25

This example shows how to configure the switch to replace the existing group with the new group for which the IGMP report was received when the maximum number of entries is in the forwarding table:

Switch(config)# interface gigabitethernet0/1
Switch(config-if)# ip igmp max-groups action replace

You can verify your setting by using the show running-config interface interface-id privileged EXEC command.

Related Commands

Command
Description

show running-config interface interface-id

Displays the running configuration on the switch interface, including the maximum number of IGMP groups that an interface can join and the throttling action. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


ip igmp profile

Use the ip igmp profile global configuration command to create an Internet Group Management Protocol (IGMP) profile and enter igmp profile configuration mode. From this mode, you can specify the configuration of the IGMP profile to be used for filtering IGMP membership reports from a switchport. Use the no form of this command to delete the IGMP profile.

ip igmp profile profile number

no ip igmp profile profile number

Syntax Description

profile number

The IGMP profile number being configured. The range is 1 to 4294967295.


Defaults

No IGMP profiles are defined. When configured, the default action for matching an IGMP profile is to deny matching addresses.

Command Modes

Global configuration

Command History

Release
Modification

12.1(9)EA1

This command was introduced.


Usage Guidelines

When you are in IGMP profile configuration mode, you can create the profile by using these commands:

deny: specifies that matching addresses are denied; this is the default condition.

exit: exits from igmp-profile configuration mode.

no: negates a command or resets to its defaults.

permit: specifies that matching addresses are permitted.

range: specifies a range of IP addresses for the profile. This can be a single IP address or a range with a start and an end address.

When entering a range, enter the low IP multicast address, a space, and the high IP multicast address.

You can apply an IGMP profile to one or more Layer 2 interfaces, but each interface can have only one profile applied to it.

Examples

This example shows how to configure IGMP profile 40 that permits the specified range of IP multicast addresses:

Switch # configure terminal
Switch(config)# ip igmp profile 40
Switch(config-igmp-profile)# permit
Switch(config-igmp-profile)# range 233.1.1.1 233.255.255.255

You can verify your settings by using the show ip igmp profile privileged EXEC command.

Related Commands

Command
Description

ip igmp filter

Applies the IGMP profile to the specified interface.

show ip igmp profile

Displays the characteristics of all IGMP profiles or the specified IGMP profile number.


ip igmp snooping

Use the ip igmp snooping global configuration command to globally enable Internet Group Management Protocol (IGMP) snooping. Use the no form of this command to disable IGMP snooping.

ip igmp snooping

no ip igmp snooping

Syntax Description

This command has no arguments or keywords.


Note Though visible in the command-line help string, the tcn keyword is not supported.


Defaults

IGMP snooping is globally enabled.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.


Usage Guidelines

When IGMP snooping is globally enabled, IGMP snooping is enabled on all the existing VLAN interfaces. When IGMP snooping is globally disabled, IGMP snooping is disabled on all the existing VLAN interfaces.

The configuration is saved in NVRAM.

Examples

This example shows how to globally enable IGMP snooping:

Switch(config)# ip igmp snooping

To verify your settings, enter the show ip igmp snooping privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping vlan

Enables IGMP snooping on a VLAN interface.

ip igmp snooping vlan immediate-leave

Enables IGMP Immediate-Leave processing.

ip igmp snooping vlan mrouter

Configures a Layer 2 port as a multicast router port.

ip igmp snooping vlan static

Configures a Layer 2 port as a member of a group.

show ip igmp snooping

Displays the IGMP snooping configuration.


ip igmp snooping mrouter learn pim v2

Use the ip igmp snooping mrouter learn pim v2 global configuration command to enable multicast router detection by Protocol-Independent Multicast protocol version 2 (PIMv2) packets when Internet Group Management Protocol (IGMP) snooping is enabled. Use the no form of this command to disable multicast router detection by PIMv2 packets.

ip igmp snooping mrouter learn pim v2

no ip igmp snooping mrouter learn pim v2

Syntax Description

This command has no arguments or keywords.

Defaults

Multicast router discovery using PIMv2 packets is enabled.

Command Modes

Global configuration

Command History

Release
Modification

12.1(20)EA2

This command was introduced.


Usage Guidelines

When IGMP snooping is globally enabled, PIMv2 packets and IGMP query packets are used for multicast router discovery and sent to the switch CPU. This is the default condition. Use the no ip igmp snooping mrouter learn pim v2 global configuration command to disable multicast router discovery by PIMv2.

To prevent PIMv2 packets from being sent to the switch CPU, you must also disable source-only learning on the switch. Source-only learning sends IP multicast data packets to the CPU and PIMv2 packets are treated as IP multicast data. Use the no ip igmp snooping source-only learning global configuration command to disable source-only learning.

Examples

This example shows how to prevent PIMv2 packets from being sent to the CPU, by disabling source-only learning and PIMv2 multicast router detection:

Switch(config)# no ip igmp snooping source-only-learning
Switch(config)# no ip igmp snooping mrouter learn pim v2

You can verify your settings by entering the show running-config | include mrouter learn pim v2 privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping

Globally enables IGMP snooping.

ip igmp snooping source-only-learning

Enable IGMP snooping source-only learning. To prevent PIMv2 packets from being sent to the CPU, you must also use the no form of this command to disable source-only-learning.

show running-config | include mrouter learn pim v2

Displays the configuration information running on the switch. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


ip igmp snooping report-suppression

Use the ip igmp snooping report-suppression global configuration command to enable Internet Group Management Protocol (IGMP) report suppression. Use the no form of this command to disable IGMP report suppression and forward all IGMP reports to multicast routers.

ip igmp snooping report-suppression

no ip igmp snooping report-suppression

Syntax Description

This command has no arguments or keywords.

Defaults

IGMP report suppression is enabled.

Command Modes

Global configuration

Command History

Release
Modification

12.1(14)EA1

This command was introduced.


Usage Guidelines

IGMP report suppression is supported only when the multicast query has IGMPv1 and IGMPv2 reports. This feature is not supported when the query includes IGMPv3 reports.

The switch uses IGMP report suppression to forward only one IGMP report per multicast router query to multicast devices. When IGMP router suppression is enabled (the default), the switch sends the first IGMP report from all hosts for a group to all the multicast routers. The switch does not send the remaining IGMP reports for the group to the multicast routers. This feature prevents duplicate reports from being sent to the multicast devices.

If the multicast router query includes requests only for IGMPv1 and IGMPv2 reports, the switch forwards only the first IGMPv1 or IGMPv2 report from all hosts for a group to all the multicast routers. If the multicast router query also includes requests for IGMPv3 reports, the switch forwards all IGMPv1, IGMPv2, and IGMPv3 reports for a group to the multicast devices.

If you disable IGMP report suppression by entering the no ip igmp snooping report-suppression command, all IGMP reports are forwarded to all the multicast routers.

Examples

This example shows how to disable report suppression:

Switch(config)# no ip igmp snooping report-suppression

This example shows how to enable report suppression:

Switch(config)# ip igmp snooping report-suppression

You can verify your settings by entering the show ip igmp snooping privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping

Globally enables IGMP snooping. IGMP snooping must be globally enabled in order to be enabled on a VLAN.

show ip igmp snooping

Displays the IGMP snooping configuration of the switch or the VLAN.


ip igmp snooping source-only-learning

Use the ip igmp snooping source-only-learning global configuration command to enable IP multicast-source-only learning on the switch and optionally set the aging time of the forwarding-table entries that are learned. Use the no form of this command to disable IP multicast-source-only learning or to disable aging.

ip igmp snooping source-only-learning [age-timer value]

no ip igmp snooping source-only-learning [age-timer]

Syntax Description

age-timer

(Optional) Configure the aging time of the forwarding-table entries that the switch learns by using the source-only learning method.

time

Aging time is seconds. The range is 0 to 2880 seconds. If you set time to 0, aging of the forward-table entries is disabled.


Defaults

IP multicast-source-only learning is enabled.

The aging feature is enabled. The default is 600 seconds (10 minutes).

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)EA1

This command was introduced.


Usage Guidelines

When IP multicast-source-only learning is enabled, the switch learns the IP multicast group from the IP multicast data stream and only forwards traffic to the multicast router ports.


Note We strongly recommend that you do not disable IP multicast-source-only learning. IP multicast-source-only learning should be disabled only if your network is not composed of IP multicast-source-only networks and if disabling this learning method improves the network performance.


In a source-only network, switch ports are connected to multicast source ports and multicast router ports. The switch ports are not connected to hosts that send IGMP join or leave messages.

The switch learns about IP multicast groups from the IP multicast data stream by using the source-only learning method. The switch forwards traffic only to the multicast router ports. You can disable source-only learning by using the no ip igmp snooping source-only learning global configuration command.

The aging time only affects the forwarding-table entries that the switch learns by using the source-only learning method. If the aging time is too long or is disabled, the forwarding table is filled with unused multicast addresses that the switch learned by using source-only learning or by using the IGMP join messages. When the switch receives traffic for new IP multicast groups, it floods the packet to all ports in the same VLAN. This unnecessary flooding can impact switch performance.

To disable the aging of the forwarding-table entries, enter the ip igmp snooping source-only-learning age-timer 0 global configuration command. If aging is disabled and you want to delete multicast addresses that the switch learned by using source-only learning, re-enable aging of the forwarding-table entries. The switch can now age out the multicast addresses that were learned by the source-only learning method and that re not in use.

If you disable source-only learning, the aging time has no effect on the switch.

Examples

This example shows how to disable source-only learning:

Switch(config)# no ip igmp snooping source-only-learning

This example shows how to enable source-only learning:

Switch(config)# ip igmp snooping source-only-learning

This example shows how to set the aging time as 1200 seconds (20 minutes):

Switch(config)# ip igmp snooping source-only-learning age-timer 1200

This example shows how to disable aging of the forward-table entries:

Switch(config)# ip igmp snooping source-only-learning age-timer 0

You can verify your settings by entering the show running-config | include source-only-learning privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping

Globally enables IGMP snooping. IGMP snooping must be globally enabled in order to be enabled on a VLAN.

show running-config | include source-only-learning

Displays the configuration information running on the switch. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference for Release 12.1 > Cisco IOS File Management Commands > Configuration File Commands.


ip igmp snooping vlan

Use the ip igmp snooping vlan global configuration command to enable Internet Group Management Protocol (IGMP) snooping on a specific VLAN. Use the no form of this command to disable IGMP snooping on a VLAN interface.

ip igmp snooping vlan vlan-id

no ip igmp snooping vlan vlan-id

Syntax Description

vlan-id

VLAN ID. The range is 1 to 4094.


Defaults

IGMP snooping is enabled when each VLAN is created.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.


Usage Guidelines

This command automatically configures the VLAN if it is not already configured. The configuration is saved in NVRAM.

Examples

This example shows how to enable IGMP snooping on VLAN 2:

Switch(config)# ip igmp snooping vlan 2

This example shows how to disable IGMP snooping on VLAN 2:

Switch(config)# no ip igmp snooping vlan 2

You can verify your settings by entering the show ip igmp snooping vlan privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping

Globally enables IGMP snooping. IGMP snooping must be globally enabled in order to be enabled on a VLAN.

ip igmp snooping vlan immediate-leave

Enables IGMP Immediate-Leave processing.

ip igmp snooping vlan mrouter

Configures a Layer 2 port as a multicast router port.

ip igmp snooping vlan static

Configures a Layer 2 port as a member of a group.

show ip igmp snooping

Displays the IGMP snooping configuration.


ip igmp snooping vlan immediate-leave

Use the ip igmp snooping vlan immediate-leave global configuration command to enable Internet Group Management Protocol (IGMP) Immediate-Leave processing on a VLAN interface. Use the no form of this command to disable Immediate-Leave processing on the VLAN interface.

ip igmp snooping vlan vlan-id immediate-leave

no ip igmp snooping vlan vlan-id immediate-leave

Syntax Description

vlan-id

VLAN ID value. The range is 1 to 4094.


Defaults

IGMP Immediate-Leave processing is disabled.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.


Usage Guidelines

Use the Immediate-Leave feature only when there is only one IP multicast receiver present on every port in the VLAN. The Immediate-Leave configuration is saved in NVRAM.

The Immediate-Leave feature is supported only with IGMP version 2 hosts.

Examples

This example shows how to enable IGMP Immediate-Leave processing on VLAN 1:

Switch(config)# ip igmp snooping vlan 1 immediate-leave

This example shows how to disable IGMP Immediate-Leave processing on VLAN 1:

Switch(config)# no ip igmp snooping vlan 1 immediate-leave

You can verify your settings by entering the show ip igmp snooping vlan privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping

Enables IGMP snooping.

ip igmp snooping vlan mrouter

Configures a Layer 2 port as a multicast router port.

show ip igmp snooping

Displays the IGMP snooping configuration.

ip igmp snooping vlan static

Configures a Layer 2 port as a member of a group.

show mac address-table multicast

Displays the Layer 2 multicast entries for a VLAN.


ip igmp snooping vlan last-member-query interval

Use the ip igmp snooping vlan last-member-query-interval global configuration command to globally enable the Internet Group Management Protocol (IGMP) configurable-leave timer. Use the no form of this command to return the IGMP configurable-leave timer to the default setting (100 milliseconds).

ip igmp snooping vlan vlan-id last-member-query-interval time

no ip igmp snooping vlan vlan-id last-member-query-interval

Syntax Description

vlan-id

VLAN ID value. The range is 1 to 4094.

time

Interval time out in seconds. The range is 100 to 5000 milliseconds.


t

Defaults

The default timeout setting is 100 milliseconds.

Command History

Release
Modification

12.1(22)EA3

This command was introduced.


Usage Guidelines

When IGMP snooping is globally enabled, IGMP snooping is enabled on all the existing VLAN interfaces. When IGMP snooping is globally disabled, IGMP snooping is disabled on all the existing VLAN interfaces.

The configuration is saved in NVRAM.

Examples

This example shows how to globally enable the IGMP configurable-leave timer:

Switch(config)# ip igmp snooping vlan vlan-id last-member-query-interval time

To verify your settings, enter the show ip igmp snooping privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping vlan

Enables IGMP snooping on a VLAN interface.

ip igmp snooping vlan immediate-leave

Enables IGMP Immediate-Leave processing.

ip igmp snooping vlan mrouter

Configures a Layer 2 port as a multicast router port.

ip igmp snooping vlan static

Configures a Layer 2 port as a member of a group.

show ip igmp snooping

Displays the IGMP snooping configuration.


ip igmp snooping vlan mrouter

Use the ip igmp snooping vlan mrouter global configuration command to add a multicast router port and to configure the multicast router learning method. Use the no form of this command to remove the configuration.

ip igmp snooping vlan vlan-id mrouter {interface interface-id | learn {cgmp | pim-dvmrp}}

no ip igmp snooping vlan vlan-id mrouter {interface interface-id | learn {cgmp | pim-dvmrp}}

Syntax Description

vlan vlan-id

Specify the VLAN ID. The range is 1 to 4094.

interface interface-id

Specify the interface of the member port that is configured to a static router port.

learn {cgmp | pim-dvmrp}

Specify the multicast router learning method. The keywords have these meanings:

cgmp—Set the switch to learn multicast router ports by snooping on Cisco Group Management Protocol (CGMP) packets.

pim-dvmrp—Set the switch to learn multicast router ports by snooping on IGMP queries and Protocol-Independent Multicasting-Distance Vector Multicast Routing Protocol (PIM-DVMRP) packets.


Defaults

The default learning method is pim-dvmrp.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.


Usage Guidelines

The CGMP learning method is useful for controlling traffic in Cisco router environments.

The configured learning method is saved in NVRAM.

Static connections to multicast routers are supported only on switch ports.

Examples

This example shows how to configure an interface as a multicast router port:

Switch(config)# ip igmp snooping vlan 1 mrouter interface fastethernet0/1

This example shows how to specify the multicast router learning method as CGMP:

Switch(config)# no ip igmp snooping vlan 1 mrouter learn cgmp

You can verify your settings by entering the show ip igmp snooping mrouter privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping

Globally enables Internet Group Management Protocol (IGMP) snooping.

ip igmp snooping vlan

Enables IGMP snooping on the VLAN interface.

ip igmp snooping vlan immediate-leave

Configures IGMP Immediate-Leave processing.

ip igmp snooping vlan static

Configures a Layer 2 port as a member of a group.

show ip igmp snooping mrouter

Displays the statically and dynamically learned multicast router ports.


ip igmp snooping vlan static

Use the ip igmp snooping vlan vlan-id static global configuration command to add a Layer 2 port as a member of a multicast group. Use the no form of this command to remove the configuration.

ip igmp snooping vlan vlan-id static mac-address interface interface-id

no ip igmp snooping vlan vlan-id static mac-address interface interface-id

Syntax Description

vlan vlan-id

Specify the VLAN ID. The range is 1 to 4094.

static mac-address

Specify the static group MAC address.

interface interface-id

Specify the interface configured to a static router port.


Defaults

None configured.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.


Usage Guidelines

The command is used to statically configure the IP multicast group member ports.

The static ports and groups are saved in NVRAM.

Static connections to multicast routers are supported only on switch ports.

Examples

This example shows how to statically configure a host on an interface:

Switch(config)# ip igmp snooping vlan 1 static 0100.5e02.0203 interface fastethernet0/1
Configuring port FastEthernet 0/1 on group 0100.5e02.0203

You can verify your settings by entering the show mac address-table multicast privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping

Enables Internet Group Management Protocol (IGMP) snooping.

ip igmp snooping vlan

Enables IGMP snooping on the VLAN interface.

ip igmp snooping vlan immediate-leave

Configures IGMP Immediate-Leave processing.

ip igmp snooping vlan mrouter

Configures a Layer 2 port as a multicast router port.

show mac address-table multicast

Displays the Layer 2 multicast entries for a VLAN.


ip ssh

Use the ip ssh global configuration command to configure the switch to run Secure Shell (SSH) version 1 or SSH version 2. Use the no form of this command to return to the default setting.

ip ssh version [1 | 2]

no ip ssh [1 | 2]

This command is available only when your switch is running the cryptographic (encrypted) software image.

Syntax Description

1

(Optional) Configure the switch to run SSH version 1 (SSHv1).

2

(Optional) Configure the switch to run SSH version 2 (SSHv1).


Defaults

The default version is the latest SSH version supported by the SSH client.

Command Modes

Global configuration

Command History

Release
Modification

12.1(19)EA1

This command was introduced.


Usage Guidelines

If you do not enter this command or if you do not specify a keyword, the SSH server selects the latest SSH version supported by the SSH client. For example, if the SSH client supports SSHv1 and SSHv2, the SSH server selects SSHv2.

The switch supports an SSHv1 or SSHv2 server. It also supports an SSHv1 client. For more information about the SSH server and the SSH client, see the software configuration guide for this release.

A Rivest, Shamir, and Adelman (RSA) key pair generated by an SSHv1 server can be used by an SSHv2 server, and the reverse.

Examples

This example shows how to configure the switch to run SSH version 2:

Switch(config)# ip ssh version 2

You can verify your settings by entering the show ip ssh or show ssh privileged EXEC command.

Related Commands

Command
Description

show ip ssh

Displays if the SSH server is enabled and displays the version and configuration information for the SSH server. For syntax information, select Cisco IOS Release 12.2 Configuration Guides and Command References > Cisco IOS Security Command Reference, Release 12.2 > Other Security Features > Secure Shell Commands.

show ssh

Displays the status of the SSH server. For syntax information, select Cisco IOS Release 12.2 Configuration Guides and Command References > Cisco IOS Security Command Reference, Release 12.2 > Other Security Features > Secure Shell Commands.


lacp port-priority

Use the lacp port-priority interface configuration command to set the port priority for the Link Aggregration Control Protocol (LACP). Use the no form of this command to return to the default setting.

lacp port-priority priority-value

no lacp port-priority

Syntax Description

priority-value

Port priority for LACP. The range is from 1 to 65535.


Defaults

The default priority value is 32768.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(12c)EA1

This command was introduced.


Usage Guidelines

This command only takes effect on EtherChannel interfaces that are already configured for LACP.

The lacp port-priority interface configuration command determines which ports are bundled and which ports are put in hot-standby mode when there are more than eight ports in an LACP channel group.

An LACP channel group can have up to 16 Ethernet ports of the same type. Up to eight ports can be active, and up to eight ports can be in standby mode.

In port-priority comparisons, a numerically lower value has a higher priority: When there are more than eight ports in an LACP channel-group, the eight ports with the numerically lowest values (highest priority values) for LACP port priority are bundled into the channel group, and the lower-priority ports are put in hot-standby mode. If two or more ports have the same LACP port priority (for example, they are configured with the default setting of 65535) an internal value for the port number determines the priority.


Note The LACP port priorities are only effective if the ports are on the switch that controls the LACP link. See the lacp system-priority global configuration command for determining which switch controls the link.


Use the show lacp internal privileged EXEC command to to display LACP port priorities and internal port number values.

For more information about configuring LACP on physical interfaces, see the "Configuring EtherChannels" chapter in the software configuration guide for this release.

Examples

This example shows set the port priority for LACP:

Switch(config)# lacp port-priority 32764

You can verify your settings by entering the show etherchannel privileged EXEC command.

Related Commands

Command
Description

lacp system-priority

Globally sets the LACP priority.


lacp system-priority

Use the lacp system-priority global configuration command to set the system priority for Link Aggregration Control Protocol (LACP). Use the no form of this command to return to the default setting.

lacp system-priority priority-value

no lacp system-priority

Syntax Description

priority-value

System priority for LACP. The range is from 1 to 65535.


Defaults

The default priority value is 32768.

Command Modes

Global configuration

Command History

Release
Modification

12.1(12c)EA1

This command was introduced.


Usage Guidelines

The lacp system-priority command determines which switch in an LACP link controls port priorities.

An LACP channel group can have up to 16 Ethernet ports of the same type. Up to eight ports can be active, and up to eight ports can be in standby mode. When there are more than eight ports in an LACP channel-group, the switch on the controlling end of the link uses port priorities to determine which ports are bundled into the channel and which ports are put in hot-standby mode. Port priorities on the other switch (the noncontrolling end of the link) are ignored.

In priority comparisons, numerically lower values have higher priority. Therefore, the system with the numerically lower value (higher priority value) for LACP system priority becomes the controlling system. If both switches have the same LACP system priority (for example, they are both configured with the default setting of 32768), the LACP system ID (the switch MAC address) determines which switch is in control.

The lacp system-priority command applies to all LACP EtherChannels on the switch.

Use the show etherchannel summary privileged EXEC command to see which ports are in the hot-standby mode (denoted with an H port-state flag in the output display).

For more information about configuring LACP on physical interfaces, see the "Configuring Etherchannels" chapter in the software configuration guide for this release.

Examples

This example shows set the system priority for LACP:

Switch(config)# lacp system-priority 32764

You can verify your settings by entering the show lacp sys-id privileged EXEC command.

Related Commands

Command
Description

lacp port-priority

Sets the LACP priority for a specific port.


link monitor

Use the link monitor interface configuration command to enable Long-Reach Ethernet (LRE) link monitoring on a port. Use the no form of this command to disable LRE link monitoring on a port.

link monitor

no link monitor

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

This command has no arguments or keywords.

Defaults

LRE monitoring is enabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

If the link is shut down, link monitor data is not collected.

Examples

This example shows how to enable LRE link monitoring on an LRE port:

Switch# configure terminal
Switch(config)# interface longreachethernet0/1
Switch(config-if)# link monitor

Related Commands

Command
Description

clear controllers lre link monitor

Deletes LRE link monitor data.

link monitor logging

Enables link monitor event logging per port.

link monitor threshold snr

Sets a signal-to-noise margin for the LRE link monitor.

link monitor threshold rserr

Sets a Reed-Solomon error threshold for the LRE link monitor.

show controllers lre link monitor

Displays LRE link monitor information.


link monitor logging

Use the link monitor logging interface configuration command to enable Long-Reach Ethernet (LRE) link monitoring event logging. Use the no form of this command to disable LRE link monitor logging.

link monitor logging

no link monitor logging

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

This command has no arguments or keywords.

Defaults

LRE link monitoring event logging is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Events are logged in the system log when a configured threshold is crossed.

Examples

This example shows how to enable LRE link monitoring logging on an LRE port:

Switch# configure terminal
Switch(config)# interface longreachethernet0/2
Switch(config-if)# link monitor logging

Related Commands

Command
Description

clear controllers lre link monitor

Deletes LRE link monitor data.

link monitor

Enables the LRE link monitor on a port.

link monitor threshold snr

Sets a signal-to-noise margin for the LRE link monitor.

link monitor threshold rserr

Sets a Reed-Solomon error threshold for the LRE link monitor.

show controllers lre link monitor

Displays the LRE link monitor information.


link monitor threshold rserr

Use the link monitor threshold rserr interface configuration command to establish threshold values for Reed-Solomon errors. Use the no form of this command to return to the default setting.

link monitor threshold rserr {downstream value | upstream value}

no link monitor threshold rserr {downstream value | upstream value}

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

downstream value

Number of the Reed-Solomon errors allowed per second at the remote end of the link. The range is 0 to 25000.

upstream value

Number of the Reed-Solomon errors allowed per second at the local end of the link. The range is 0 to 25000.


Defaults

The default is 1000 errors per second.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

To compute threshold values, calculate the number of frames that can be sent for a particular bandwidth based on the LRE profile. Use the show controller lre status profile privileged EXEC command to determine the downstream and upstream data rates. Divide the downstream data rate by the length of an LRE frame (216 bytes) multiplied by 8 (8 bits per byte).

For example, a link is running LRE-10, which has a downstream data rate of 12.5 Mbps.

((12500000)/(261*8))=5986

If you configure the downstream Reed-Solomon error threshold to 5986, an alarm counter increments when the threshold is exceeded.

Examples

This example shows how to configure a threshold for Reed-Solomon errors at 4000 errors per second downstream and 3000 errors per second upstream:

Switch# configure terminal
Switch(config)# interface longreachethernet0/1
Switch(config-if)# link monitor threshold rserr downstream 4000 
Switch(config-if)# link monitor threshold rserr upstream 3000

Related Commands

Command
Description

clear controllers lre link monitor

Deletes LRE link monitor data.

link monitor

Enables the LRE link monitor on a port.

link monitor logging

Enables link monitor event logging per port.

link monitor threshold snr

Sets a signal-to-noise margin for the LRE link monitor.

show controllers lre link monitor

Displays the LRE link monitor information.

show controllers lre status

Displays the LRE link statistics and profile information on a switch LRE port, including link state, link duration, profile name, and data rates.


link monitor threshold snr

Use the link monitor threshold snr interface configuration command to establish threshold values for signal-to-noise ratio (SNR) errors. Use the no form of this command to return to the default setting.

link monitor threshold snr {downstream value | upstream value}

no link monitor threshold snr {downstream value | upstream value}

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

downstream value

Value of the SNR, measured in decibels (dB), at the remote end of the link. The range is 0 to 10.

upstream value

Value of the SNR, measured in dB, at the local end of the link. The range is 0 to 10.


Defaults

The default is 2 dB.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

The default theoretical SNR value added to the threshold value is compared to the value in the LRE chipset.

Examples

This example shows how to configure the SNR threshold as 6 dB downstream and 4 dB upstream:

Switch# configure terminal
Switch(config)# interface longreachethernet0/1
Switch(config-if)# link monitor threshold snr downstream 6
Switch(config-if)# link monitor threshold snr upstream 4

Related Commands

Command
Description

clear controllers lre link monitor

Deletes LRE link monitor data.

link monitor

Enables the LRE link monitor on a port.

link monitor logging

Enables link monitor event logging per port.

link monitor threshold rserr

Sets a Reed-Solomon error threshold for the LRE link monitor.

show controllers lre link monitor

Displays the LRE link monitor information.


local duplex

Use the local duplex interface configuration command to specify the duplex mode of operation for a Long-Reach Ethernet (LRE) port. Use the no form of this command to return to the default setting.

local duplex {full | half}

no local duplex

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

full

Port is in full-duplex mode.

half

Port is in half-duplex mode.


Defaults

The default is half.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

This command only sets the duplex mode on an LRE port. To set the duplex mode on a customer premises equipment (CPE) Ethernet link, use the cpe duplex interface configuration command; to set the duplex mode of the Gigabit Ethernet ports, use the duplex interface configuration command.

Examples

This example shows how to set LRE port 1 to full duplex:

Switch(config)# interface longreachethernet0/1
Switch(config-if)# local duplex full

You can verify your settings by entering the show running-config privileged EXEC command.

Related Commands

Command
Description

cpe duplex

Specifies the duplex mode of CPE ports.

cpe speed

Sets the speed of CPE ports.

duplex

Specifies the duplex mode of Gigabit Ethernet ports.

local speed

Specifies the speed of LRE ports.

speed

Specifies the speed of Gigabit Ethernet ports.


local speed

Use the local speed interface configuration command to specify the speed of a Long-Reach Ethernet (LRE) interface. Use the no form of this command to return to the default setting.

local speed {10 | 100}

no local speed

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

10

Specify that the LRE port run at 10 Mbps.

100

Specify that the LRE port run at 100 Mbps.


Defaults

The default is 100 Mbps.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

This command sets the speed only on an LRE link. To set the speed on a customer premises equipment (CPE) Ethernet link, use the cpe speed interface configuration command. To set the speed of the Gigabit Ethernet ports, use the speed interface configuration command.

Examples

This example shows how to set LRE port 1 to 100 Mbps:

Switch(config)# interface longreachehernet1/1
Switch(config-if)# local speed 100

You can verify your settings by entering the show running-config privileged EXEC command.

Related Commands

Command
Description

cpe duplex

Specifies the duplex mode of CPE Ethernet ports.

cpe speed

Specifies the speed of CPE Ethernet ports.

duplex

Specifies the duplex mode of Gigabit Ethernet ports.

local duplex

Specifies the duplex mode of operation for LRE ports.

speed

Specifies the speed of Gigabit Ethernet ports.


logging lre

Use the logging lre interface configuration command to specify the mode in which to log Long-Reach Ethernet (LRE) events. Use the no form of this command to disable logging of events.

logging lre {event | extended | normal}

no logging lre {event | extended | normal}

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

event

Log events only.

extended

Log events and all possible parameters.

normal

Log events and some typical parameters.


Defaults

The default is normal.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

This command is not needed for normal operation of the switch. However, it can be used as a diagnostic tool to analyze switch activity.

The maximum number of events that can be logged on a per-port basis is 50. The log overwrites itself when it is full.

Examples

This example shows how to set logging for events:

Switch (config)# interface longreachethernet0/1
Switch(config-if)# logging lre event

Related Commands

Command
Description

clear controllers lre log

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

show controllers lre log

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


lre profile

Use the lre profile global configuration command to assign a Long-Reach Ethernet (LRE) profile to all switch LRE ports. Use the no form of this command to remove the profile.

lre profile profile-name

no lre profile profile-name

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

profile-name

Name of the profile. The profile name can be a Cisco-supplied profile or a user-created profile. For more details on Cisco-supplied profiles, see the software configuration guide for this release.


Defaults

The default for the Catalyst 2950ST-8 LRE and 2950ST-24 LRE switches is LRE-10. The default for the Catalyst 2950ST-24 LRE 997 switch is LRE-6.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

Unless you assign a profile, the switch uses the default global profile. The LRE-10 profile allows the upstream and downstream transmission rate on the LRE link to be 12.5 Mbps. The LRE-6 profile allows the upstream and downstream transmission rate on the LRE link to be 6.25 Mbps. Profiles assigned at the port level have priority over profiles assigned at the global level.

When assigning profiles to LRE ports, keep these considerations in mind:

The default profile might not be the best choice for your environment.

When you assign a different profile to a port, the port applies and uses the newly-assigned profile.

If a Catalyst 2950ST-8 LRE or 2950ST-24 LRE switch is used with equipment directly connected to a public switched telephone network (PSTN) without a public branch exchange (PBX) between the LRE switch and the public telephone lines, Cisco recommends that you use either the LRE-998-15-4-M2 or LRE-997-10-4-M2 profiles globally.

Examples

This example shows how to specify the LRE-8 profile on a Catalyst 2950ST-8 LRE or 2950ST-24 LRE switch:

Switch# configure terminal
Switch(config)# lre profile lre-8

You can verify your settings by entering the show controllers lre profile details privileged EXEC command.

Related Commands

Command
Description

profile (sequence configuration)

Adds an LRE profile to a rate selection sequence.

show controllers lre profile

Displays LRE profile information.


lre rate selection sequence

Use the lre rate selection sequence global configuration command to assign the rate selection sequence for the entire switch. Use the no form of the command to delete the assigned sequence.

lre rate selection sequence sequence-name

no lre rate selection sequence sequence-name

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

sequence-name

Name of the rate selection sequence being applied.


Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

This command applies a sequence to all ports that have rate selection enabled. The command is rejected if the sequence is not configured with a profile.

When rate selection is enabled, profiles and sequences follow a predefined priority scheme that determines the rate for a port or for the entire switch. In general, sequences have priority over standalone profiles, and port configurations have priority over global configurations. These are the priority levels with rate selection enabled, from highest to lowest:

1. Per-port sequence

2. Global sequence

3. Port profile

4. Global profile

For further details on profiles, sequences, and their priority scheme, see the switch software configuration guide for this release.

Examples

This example shows how to specify the sequence named lre-seq-upstream:

Switch# configure terminal
Switch(config)# lre rate selection sequence lre-seq-upstream

Related Commands

Command
Description

lre rate selection sequence

Assigns a sequence to the entire switch.

lre sequence

Creates user-defined rate selection sequences.

rate selection

Enables rate selection on a specific port.

rate selection sequence

Assigns a rate selection sequence for a specific port.

show controllers lre sequence

Displays the list of sequences.


lre sequence

Use the lre sequence global configuration command to define a new sequence and to enter sequence configuration mode. Use the no form of this command to delete a user-configured sequence.

lre sequence sequence-name

no lre sequence sequence-name

This command is available only on Catalyst 2950 Long-Reach Ethernet (LRE) switches.

Syntax Description

sequence-name

Name of the sequence being created or modified.


Defaults

No default is defined.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.


Usage Guidelines

This command creates a new sequence when the sequence name specified in the command does not match any of the existing configured sequences. When the sequence name specified in the command matches a configured sequence, a new sequence is not created.

The profiles can be edited from the sequence configuration mode. However, the system-defined sequences cannot be edited. If the sequence specified in this command is a system-defined sequence, the command is rejected. An error message appears if the sequence name matches the name of a system-defined sequence. Use the exit command to return to global configuration mode.

Examples

This example shows how to specify the a user-defined sequence called myseq:

Switch# configure terminal
Switch(config)# lre sequence myseq
Switch(config-seq)#

This example shows how to create a user-defined sequence called corpseq, with two profiles in that sequence:

Switch# configure terminal
Switch(config)# lre sequence corpseq
Switch(config-seq)# profile lre-15-5
Switch(config-seq)# profile lre-15-3
Switch(config-seq)# exit
Switch(config)#

This example shows the error message that appears when you try to edit a system-defined sequence:

Switch(config)# lre sequence lre-seq-complete-reach

Error:Sequence LRE-SEQ-COMPLETE-REACH is a system defined sequence. Cannot edit this 
sequence
Switch>(config)#

This example shows how to delete a user-defined sequence:

Switch# configure terminal
Switch(config)# no lre sequence myseq
Switch(config-seq)# exit
Switch(config)#

Related Commands

Command
Description

lre rate selection sequence

Assigns sequences globally.

profile (interface configuration)

Adds a profile to a sequence.

profile (sequence configuration)

Adds a profile to a sequence.


lre syslog

Use the lre syslog global configuration command to enable a Long-Reach Ethernet (LRE) switch to send the switch debugging messages to the LRE logging process and to the system message logging process. Use the no form of this command to disable the syslog export feature.

lre syslog

no lre syslog

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

This command has no arguments or keywords.

Defaults

The syslog export feature is disabled.

Command Modes

Global configuration

Command History

Release
Modification

12.1(14)EA1

This command was introduced.


Usage Guidelines

Before enabling the syslog export feature, follow these guidelines:

Make sure that LRE logging is enabled.

Make sure that the console severity in the system message logging configuration is set to debugging. For more information, see the "Configuring System Message Logging" chapter in the software configuration guide for this release.

In software releases earlier than Cisco IOS Release 12.1(14)EA1, the switch sends information only to the LRE logging process. To display the LRE events, use the show controllers lre log privileged EXEC command.

For more information, see the "Configuring LRE" chapter in the software configuration guide for this release.

Examples

This example shows how to enable the syslog export feature:

Switch(config)# lre syslog

Related Commands

Command
Description

show controllers lre log

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


lre upbo

Use the lre upbo global configuration command to configure the reference TX power level on the Long-Reach Ethernet (LRE) customer premises equipment (CPE) device. Use the no form of this command to return t to the default setting.

lre upbo {noise-model | offset value}

no lre upbo {noise-model | offset value}

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

noise-model

Specify the noise model. See Table 2-4 in the "Usage Guidelines" section for the supported values. Values are not case sensitive.

offset value

Specify the offset value. The range is 300 to 800.

The offset value is calculated with reference to -140 decibels referenced to 1 milliwatt per hertz (dBm/Hz). For example, if you require a reference power spectral density (PSD) of -95.0 dBm/Hz, you need to enter an offset of 45.0 (-95.0 - [-140] = 45.0).

Note The LRE CPE PSD offset value is in 10*decibel (dB) (for example, 450 means 45.0 dB)


Defaults

The default is the ETSI-E noise model.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ4

This command was introduced.


Usage Guidelines

The upstream power back-off mechanism allows for normalization of the upstream receive power levels by requiring the CPE devices on shorter lines to transmit at a lower power level than the CPEs on longer lines. You can change the upstream power back-off values by either selecting a standard noise model or by setting an offset value for the default reference PSD.


Note The reference PSD number is based on an upstream carrier frequency of 4.8 MHz.


Table 2-4 shows the supported values for the noise models:

Table 2-4 Supported Values for Noise Model 

ETSI Noise Model
Supported Value for noise-model
PSD

A

ETSI-A

-108.7106 dBm/Hz

B

ETSI-B

-108.7106 dBm/Hz

C

ETSI-C

-93.6154 dBm/Hz

D

ETSI-D

-104.7232 dBm/Hz

E

ETSI-E

-107.0455 dBm/Hz

F

ETSI-F

-90.6138 dBm/Hz


You can use the offset values to adjust the CPE transmit reference PSD relative to the default reference of -140 dBm/Hz. Only reference PSD values greater than -140 dBm/Hz are supported. A zero value for the offset corresponds to a reference PSD of -140 dBm/Hz.

The smallest offset is 30 dBm/Hz and the corresponding value is 300.


Caution Changing the noise model while the switch is functioning in a network can disrupt the network operation.

When you enter the lre upbo command, all LRE links are reset to the up state.

Before configuring the reference TX power level, follow these guidelines:

Verify how this command affects the network in a lab environment.

Make sure all the CPEs in the production network are running the same LRE binary version. Use the show controllers lre cpe version privileged EXEC command to display the binary version on the all CPE device interfaces.

Examples

This example shows how to set the noise model to ETSI-A:

Switch# configure terminal
Switch(config)# lre upbo etsi-a

This example shows how to set the offset value to 450 (45.0 dB):

Switch# configure terminal
Switch(config)# lre upbo offset 450

Related Commands

Command
Description

show controllers lre cpe

Displays information about the LRE CPE devices connected to an LRE switch.

show controllers lre status psd

Displays the LRE line status parameters.


lre upgrade default family

Use the lre upgrade default family global configuration command to define a map between a Long-Reach Ethernet (LRE) device and an LRE binary. Use the no form of this command to return to the default setting.

lre upgrade default family device-family {model model {revision revision | binary LRE binary} | binary LRE binary}

no lre upgrade default family device-family {model model {revision revision | binary LRE binary} | binary LRE binary}

This command is available only on Catalyst 2950 LRE switches.

Syntax Description

device-family

Type of device that contains the chipset to be upgraded. Valid values are cisco575-lre, cisco585-lre, cisco576-lre997, and cisco2950-lre.

model model

Specify the model number of the device family; for example, a model can be cisco585-lre.

revision revision

(Optional) Specify the revision of the target device.

binary LRE binary

(Optional only if it is entered with the model keyword) Specify the LRE binary file being applied.


Defaults

No default is defined. The system selects the binary file.

Command Modes

Global configuration

Command History

Release
Modification

12.1(11)YJ

This command was introduced.

12.1(11)YJ4

The cisco576-lre997 value was added.


Usage Guidelines

Use the lre upgrade default family device-family binary configuration command to override the default behavior for upgrading LRE firmware. Use this command when you want to upgrade all CPE devices or local controllers of a given family to an LRE binary version.


Note The name of the LRE binary must be entered as it appears in the flash memory. Use the show lre upgrade binaries command to determine the flash filename of an LRE binary.


Examples

This example shows how to configure all CISCO585-LRE CPE devices to upgrade with the LRE binary file CISCO-585-LRE_vdslsngl_51.00.00:

Switch(config)# lre upgrade default family cisco585-lre binary 
cisco585-lre_vdslsngl_51.00.00.bin

Related Commands

Command
Description

controller longreachethernet

Allows you to enter controller submode.

show lre upgrade

Displays the LRE upgrade information.

upgrade binary

Configures upgrades on either end of an LRE link.

upgrade preserve

Prevents an upgrade of the local CPE controller and all remote CPE devices connected to it.


mac access-group

Use the mac access-group interface configuration command to apply a named extended MAC access control list (ACL) to an interface. Use the no form of this command to remove a MAC ACL from an interface.

mac access-group name in

no mac access-group name in

This command is available only if your switch is running the enhanced software image (EI).

Syntax Description

name

Name of the MAC extended ACL.


Defaults

No MAC ACL is applied to the interface.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

You can apply MAC ACLs only to ingress interfaces. If an IP access group is already defined for an interface, you cannot apply this command to the interface.

After receiving the packet, the switch checks the match conditions in the ACL. If the conditions are matched, the switch forwards the packet.

If the specified ACL does not exist, the switch forwards all packets.


Note For more information about configuring MAC extended ACLs, see the "Configuring Network Security with ACLs" chapter in the software configuration guide for this release.


Examples

This example shows how to apply a MAC extended ACL named macacl2 to an interface:

Switch(config)# interface fastethernet0/1
Switch(config-if)# mac access-group macacl2 in

You can verify your settings by entering the show mac access-group privileged EXEC command.

Related Commands

Command
Description

{deny (MAC access-list configuration) | permit (MAC access-list configuration)}

Configures a MAC ACL.

show access-lists

Displays the ACLs configured on the switch.

show mac access-group

Displays the MAC ACLs configured on the switch.


mac access-list extended

Use the mac access-list extended global configuration command to create an access control list (ACL) based on MAC addresses. Using this command changes the mode to extended MAC access-list configuration mode. Use the no form of this command to return to the default setting.

mac access-list extended name

no mac access-list extended name

This command is available only if your switch is running the enhanced software image (EI).

Syntax Description

name

Assign a name to the MAC extended ACL.


Defaults

No MAC ACLs are created.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.


Usage Guidelines

MAC-named extended ACLs are used with the mac access-group interface configuration command and class maps.


Note For more information about configuring MAC extended ACLs, see the "Configuring Network Security with ACLs" chapter in the software configuration guide for this release.


Examples

This example shows how to enter extended MAC access-list configuration mode and to create a MAC extended ACL named mac1:

Switch(config)# mac access-list extended mac1
Switch(config-ext-macl)#

This example shows how to delete the MAC extended ACL named mac1:

Switch(config)# no mac access-list extended mac1

You can verify your settings by entering the show access-lists privileged EXEC command.

Related Commands

Command
Description

class-map

Creates a class map to be used for matching packets to the class whose name you specify and to enter class-map configuration mode.

{deny (MAC access-list configuration) | permit (MAC access-list configuration)}

Configures a MAC ACL.

mac access-group

Applies a MAC ACL to an interface.

show access-lists

Displays the ACLs configured on the switch.


mac address-table aging-time

Use the mac address-table aging-time global configuration command to set the length of time that a dynamic entry remains in the MAC address table after the entry is used or updated. Use the no form of this command to return to the default setting. The aging time applies to all VLANs.

mac address-table aging-time [0 | 10-1000000]

no mac address-table aging-time [0 | 10-1000000]


Note Beginning with Cisco IOS Release 12.1(11)EA1, the mac address-table aging-time command replaces the mac-address-table aging-time command (with the hyphen).


Syntax Description

0

This value disables aging. Static address entries are never aged or removed from the table.

10-100000

Aging time in seconds. The range is 10 to 1000000 seconds.


Defaults

The default is 300 seconds.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.

12.1(6)EA2

The aging-time values were modified.

12.1(11)EA1

The mac-address-table aging-time command was replaced by the mac address-table aging-time command.


Usage Guidelines

If hosts do not send continuously, increase the aging time to record the dynamic entries for a longer time. This reduces the possibility of flooding when the hosts send again.

Examples

This example shows how to set the aging time to 200 seconds:

Switch(config)# mac address-table aging-time 200

This example shows how to disable aging in VLAN 1.

Switch(config)# mac address-table aging-time 0

This example shows how to set aging time to 450 seconds for all VLANs for which the user did not specify aging time:

Switch(config)# mac address-table aging-time 450

You can verify your settings by entering the show mac address-table privileged EXEC command.

Related Commands

Command
Description

clear mac address-table

Deletes dynamic entries from the MAC address table.

show mac address-table

Displays the MAC address table.

show mac address-table aging-time

Displays the MAC address table aging time for all VLANs or the specified VLAN.


mac address-table notification

Use the mac address-table notification global configuration command to enable the MAC notification feature and to configure the notification-trap interval or history table. Use the no form of this command to disable this feature.

mac address-table notification [history-size size | interval interval]

no mac address-table notification [history-size size | interval interval]


Note Beginning with Cisco IOS Release 12.1(11)EA1, the mac address-table notification command replaces the mac-address-table notification command (with the hyphen).


Syntax Description

history-size size

(Optional) Configures the maximum number of entries in the MAC notification history table. The range is 0 to 500.

interval interval

(Optional) Configures the notification-trap interval in seconds. The range is 0 to 2147483647. The switch sends the notification traps when this amount of time has elapsed.


Defaults

The MAC notification feature is disabled.

The default trap-interval value is 1 second.

The default number of entries in the history table is 1.

Command Modes

Global configuration

Command History

Release
Modification

12.1(6)EA2

This command was introduced.

12.1(11)EA1

The mac-address-table notification command was replaced by the mac address-table notification command.


Usage Guidelines

The MAC address notification feature sends Simple Network Management Protocol (SNMP) traps to the network management system (NMS) whenever a MAC address is added or deleted from the forwarding tables. MAC notifications are generated only for dynamic and secure MAC addresses. Events are not generated for self addresses, multicast addresses, or other static addresses.

When you configure the history-size option, the existing MAC address history table is deleted, and a new table is created.

You enable the MAC address notification feature by using the mac address-table notification command. You must also enable MAC address notification traps on an interface by using the snmp trap mac-notification interface configuration command, and configure the switch to send MAC address traps to the NMS by using the snmp-server enable traps mac-notification global configuration command.

Examples

This example shows how to enable the MAC notification feature:

Switch(config)# mac address-table notification

This example shows how to set the notification-trap interval to 60 seconds:

Switch(config)# mac address-table notification interval 60

This example shows how to set the number of entries in the history table to 32:

Switch(config)# mac address-table notification history-size 32

You can verify your settings by entering the show mac address-table notification privileged EXEC command.

Related Commands

Command
Description

clear mac address-table notification

Clears the MAC address notification global counters.

show mac address-table notification

Displays the MAC address notification settings for all interfaces or the specified interface.

snmp-server enable traps

Sends the SNMP MAC notification traps when the mac-notification keyword is appended.

snmp trap mac-notification

Enables the SNMP MAC notification trap on a specific interface.


mac address-table static

Use the mac address-table static global configuration command to add static addresses to the MAC address table. Use the no form of this command to remove static entries from the MAC address table.

mac address-table static mac-addr vlan vlan-id interface interface-id

no mac address-table static mac-addr vlan vlan-id [interface interface-id]


Note Beginning with Cisco IOS Release 12.1(11)EA1, the mac address-table static command replaces the mac-address-table static command (with the hyphen).


Syntax Description

mac-addr

Destination MAC address (unicast or multicast) to add to the address table. Packets with this destination address received in the specified VLAN are forwarded to the specified interface.

vlan vlan-id

Specify the VLAN for which the packet with the specified MAC address is received. The range is 1 to 4094.

interface interface-id

Interface to which the received packet is forwarded. Valid interfaces include physical ports and port channels.


Defaults

None configured.

Command Modes

Global configuration

Command History

Release
Modification

12.0(5.2)WC(1)

This command was introduced.

12.1(6)EA2

The interface keyword and parameters were changed.

12.1(11)EA1

The mac-address-table static command was replaced by the mac address-table static command.


Usage Guidelines

Follow these guidelines when using this feature:

A static unicast MAC address can be assigned to one interface.

A static multicast MAC address can be assigned to one interface.

Examples

This example shows how to add the static address 0004.5600.67ab to the MAC address table:

Switch(config)# mac address-table static 0004.5600.67ab vlan 1 interface fastethernet0/2

This example shows how to add the static address c2f3.220a.12f4 to the MAC address table. When a packet is received in VLAN 4 with this MAC address as its destination, the packet is forwarded to the specified interface.

Switch(config)# mac address-table static c2f3.220a.12f4 vlan 4 interface 
gigabitethernet0/1

You can verify your settings by entering the show mac address-table privileged EXEC command.

Related Commands

Command
Description

clear mac address-table

Deletes entries from the MAC address table.

mac address-table aging-time

Sets the length of time that a dynamic entry remains in the MAC address table after the entry is used or updated.

show mac address-table

Displays the MAC address table.

show mac address-table static

Displays static MAC address table entries only.


mac address-table static drop

Use the mac address-table static drop global configuration command to enable unicast MAC address filtering and to configure the switch to drop traffic with a specific source or destination MAC address. Use the no form of this command to return to the default setting.

mac address-table static mac-addr vlan vlan-id drop

no mac address-table static mac-addr vlan vlan-id

Syntax Description

mac-addr

Unicast source or destination MAC address. Packets with this MAC address are dropped.

vlan vlan-id

Specify the VLAN for which the packet with the specified MAC address is received. The range is 1 to 4094.


Defaults

Unicast MAC address filtering is disabled. The switch does not drop traffic for specific source or destination MAC addresses.

Command Modes

Global configuration

Command History

Release
Modification

12.1(19)EA1

This command was introduced.


Usage Guidelines

Follow these guidelines when using this feature:

Multicast MAC addresses, broadcast MAC addresses, and router MAC addresses are not supported. Packets that are forwarded to the CPU are also not supported.

If you add a unicast MAC address as a static address and configure unicast MAC address filtering, the switch either adds the MAC address as a static address or drops packets with that MAC address, depending on which command was entered last. The second command that you entered overrides the first command.

For example, if you enter the mac address-table static mac-addr vlan vlan-id interface interface-id global configuration command followed by the mac address-table static mac-addr vlan vlan-id drop command, the switch drops packets with the specified MAC address as a source or destination.

If you enter the mac address-table static mac-addr vlan vlan-id drop global configuration command followed by the mac address-table static mac-addr vlan vlan-id interface interface-id command, the switch adds the MAC address as a static address.

Examples

This example shows how to enable unicast MAC address filtering and to configure the switch to drop packets that have a source or destination address of c2f3.220a.12f4. When a packet is received in VLAN 4 with this MAC address as its source or destination, the packet is dropped.

Switch(config)# mac address-table static c2f3.220a.12f4 vlan 4 drop

This example shows how to disable unicast MAC address filtering:

Switch(config)# no mac address-table static c2f3.220a.12f4 vlan 4 

You can verify your setting by entering the show mac address-table static privileged EXEC command.

Related Commands

Command
Description

show mac address-table static

Displays only static MAC address table entries.


macro apply

Use the macro apply interface configuration command to apply a macro to an interface or to apply and trace a macro configuration on an interface.

macro {apply | trace} macro-name [parameter {value}] [parameter {value}]
[
parameter {value}]

Syntax Description

apply

Apply a macro to the specified interface.

trace

Use the trace keyword to apply a macro to an interface and to debug the macro.

macro-name

Specify the name of the macro.

parameter value

(Optional) Specify unique parameter values that are specific to the interface. You can enter up to three keyword-value pairs. Parameter keyword matching is case sensitive. All matching occurrences of the keyword are replaced with the corresponding value.


Defaults

This command has no default setting.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(19)EA1

This command was introduced.

12.1(20)EA1

The parameter value keywords were added.


Usage Guidelines

You can use the macro trace macro-name interface configuration command to apply and show the macros running on an interface or to debug the macro to find any syntax or configuration errors.

If a command fails because of a syntax error or a configuration error when you apply a macro, the macro continues to apply the remaining commands to the interface.

When creating a macro that requires the assignment of unique values, use the parameter value keywords to designate values specific to the interface.

Keyword matching is case sensitive. All matching occurrences of the keyword are replaced with the corresponding value. Any full match of a keyword, even if it is part of a larger string, is considered a match and is replaced by the corresponding value.

Some macros might contain keywords that require a parameter value. You can use the macro apply macro-name ? command to view a list of any required values in the macro. If you apply a macro without entering the keyword values, the commands are invalid and are not applied.

There are Cisco-default Smartports macros embedded in the switch software. You can display these macros and the commands they contain by using the show parser macro user EXEC command.

Follow these guidelines when you apply a Cisco-default Smartports macro on an interface:

Display all macros on the switch by using the show parser macro user EXEC command. Display the contents of a specific macro by using the show parser macro name macro-name user EXEC command.

Keywords that begin with $ mean that a unique parameter value is required. Append the Cisco-default macro with the required values by using the parameter value keywords.

The Cisco-default macros use the $ character to help identify required keywords. There is no restriction on using the $ character to define keywords when you create a macro.

When you apply a macro to an interface, the macro name is automatically added to the interface. You can display the applied commands and macro names by using the show running-configuration interface interface-id user EXEC command.

A macro applied to an interface range behaves the same way as a macro applied to a single interface. When you use an interface range, the macro is applied sequentially to each interface within the range. If a macro command fails on one interface, it is still applied to the remaining interfaces.

You can delete a macro-applied configuration on an interface by entering the default interface interface-id interface configuration command.

Examples

After you have created a macro by using the macro name global configuration command, you can apply it to an interface. This example shows how to apply a user-created macro called duplex to an interface:

Switch(config-if)# macro apply duplex

To debug a macro, use the macro trace interface configuration command to find any syntax or configuration errors in the macro as it is applied to an interface. This example shows how troubleshoot the user-created macro called duplex on an interface:

Switch(config-if)# macro trace duplex
Applying command...`duplex auto'
%Error Unknown error.
Applying command...`speed nonegotiate'

This example shows how to display the Cisco-default cisco-desktop macro and how to apply the macro and set the access VLAN ID to 25 on an interface:

Switch# show parser macro cisco-desktop
--------------------------------------------------------------
Macro name : cisco-desktop
Macro type : default

# Basic interface - Enable data VLAN only
# Recommended value for access vlan (AVID) should not be 1
switchport access vlan $AVID
switchport mode access

# Enable port security limiting port to a single
# MAC address -- that of desktop
switchport port-security
switchport port-security maximum 1

# Ensure port-security age is greater than one minute
# and use inactivity timer
switchport port-security violation restrict
switchport port-security aging time 2
switchport port-security aging type inactivity

# Configure port as an edge network port
spanning-tree portfast
spanning-tree bpduguard enable
--------------------------------------------------------------
Switch#
Switch# configure terminal
Switch(config)# interface fastethernet0/4
Switch(config-if)# macro apply cisco-desktop $AVID 25

Related Commands

Command
Description

macro description

Adds a description about the macros that are applied to an interface.

macro global

Applies a macro on a switch or applies and traces a macro on a switch.

macro global description

Adds a description about the macros that are applied to the switch.

macro name

Creates a macro.

show parser macro

Displays the macro definition for all macros or for the specified macro.


macro description

Use the macro description interface configuration command to enter a description about which macros are applied to an interface. Use the no form of this command to remove the description.

macro description text

no macro description text

Syntax Description

description text

Enter a description about the macros that are applied to the specified interface.


Defaults

This command has no default setting.

Command Modes

Interface configuration

Command History

Release
Modification

12.1(19)EA1

This command was introduced.


Usage Guidelines

Use the description keyword to associate comment text, or the macro name, with an interface. When multiple macros are applied on a single interface, the description text will be from the last applied macro.

This example shows how to add a description to an interface:

Switch(config-if)# macro description duplex settings

You can verify your settings by entering the show parser macro description privileged EXEC command.

Related Commands

Command
Description

macro apply

Applies a macro on an interface or applies and traces a macro on an interface.

macro global

Applies a macro on a switch or applies and traces a macro on a switch

macro global description

Adds a description about the macros that are applied to the switch.

macro name

Creates a macro.

show parser macro

Displays the macro definition for all macros or for the specified macro.


macro global

Use the macro global global configuration command to apply a macro to a switch or to apply and trace a macro configuration on a switch.

macro global {apply | trace} macro-name [parameter {value}] [parameter {value}]
[
parameter {value}]

Syntax Description

apply

Apply a macro to the switch.

trace

Use the trace keyword to apply a macro to a switch and to debug the macro.

macro-name

Specify the name of the macro.

parameter value

(Optional) Specify unique parameter values that are specific to the switch. You can enter up to three keyword-value pairs. Parameter keyword matching is case sensitive. All matching occurrences of the keyword are replaced with the corresponding value.


Defaults

This command has no default setting.

Command Modes

Global configuration

Command History