Cisco ME 3400E Ethernet Access Switch
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.2(44)EY

This command was introduced.


Usage Guidelines

This command requires access to a RADIUS server.


Note We recommend that you enter the dot1x reauthentication 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 accounting dot1x
Switch(config)# aaa accounting dot1x default start-stop group radius
Switch(config)#

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.

aaa-new-model

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

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

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, see the Cisco IOS Security Command Reference, Release 12.2 > Authentication, Authorization, and Accounting > Authentication Commands.

show running-config

Displays the operating configuration. For syntax information, use this link to the Cisco IOS Release 12.2 Command Reference listing page: http://www.cisco.com/en/US/products/sw/iosswrel/ps1835/prod_command_reference_list.html
Select the Cisco IOS Commands Master List, Release 12.2 to navigate to the command.


action

Use the action access-map configuration command to set the action for the VLAN access map entry. Use the no form of this command to set the action to the default value, which is to forward.

action {drop | forward}

no action

Syntax Description

drop

Drop the packet when the specified conditions are matched.

forward

Forward the packet when the specified conditions are matched.


Defaults

The default action is to forward packets.

Command Modes

Access-map configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You enter access-map configuration mode by using the vlan access-map global configuration command.

If the action is drop, you should define the access map, including configuring any access control list (ACL) names in match clauses, before applying the map to a VLAN, or all packets could be dropped.

In access-map configuration mode, use the match access-map configuration command to define the match conditions for a VLAN map. Use the action command to set the action that occurs when a packet matches the conditions.

The drop and forward parameters are not used in the no form of the command.

Examples

This example shows how to identify and apply a VLAN access map vmap4 to VLANs 5 and 6 that causes the VLAN to forward an IP packet if the packet matches the conditions defined in access list al2:

Switch(config)# vlan access-map vmap4
Switch(config-access-map)# match ip address al2
Switch(config-access-map)# action forward
Switch(config-access-map)# exit
Switch(config)# vlan filter vmap4 vlan-list 5-6

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

Related Commands

Command
Description

access-list {deny | permit}

Configures a standard numbered ACL. For syntax information, select Cisco IOS IP Command Reference, Volume 1 of 3:Addressing and Services, Release 12.2 > IP Services Commands.

ip access-list

Creates a named access list. For syntax information, select Cisco IOS IP Command Reference, Volume 1 of 3:Addressing and Services, Release 12.2 > IP Services Commands.

mac access-list extended

Creates a named MAC address access list.

match (access-map configuration)

Defines the match conditions for a VLAN map.

show vlan access-map

Displays the VLAN access maps created on the switch.

vlan access-map

Creates a VLAN access map.


alarm-contact

Use the alarm-contact global configuration command to configure triggers and severity levels for external alarms. Use the no form of this command to remove the configuration.

alarm-contact {contact-number {description string | severity {critical | major | minor} | trigger {closed | open}} | all {severity {critical | major | minor} | trigger {closed | open}}

no alarm-contact {contact-number {description | severity | trigger} | all {severity | trigger}

contact-number

Configure a specific alarm contact number. The range is 1 to 4.

description string

Add a description for the alarm contact number. The description string can be up to 80 alphanumeric characters in length and is included in the system message generated when the alarm is triggered.

all

Configure all alarm contacts.

severity

Set the severity level that is set when the alarm is triggered. The severity is included in the alarm notification. Entering no alarm-contact severity sets the severity to minor.

critical

Set severity level as critical.

major

Set severity level as major.

minor

Set severity level as minor.

trigger

Set the state that triggers the alarm, whether the connected circuit is open or closed. Entering no alarm-contact trigger sets the trigger to closed.

closed

Specify that the alarm is triggered when the contact is closed.

open

Specify that the alarm is triggered when the contact is open.


Defaults

No alarms are configured.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

The no alarm-contact contact-number description sets the description to an empty string.

The no alarm-contact {contact-number | all} severity sets the alarm-contact severity to minor.

The no alarm-contact {contact-number | all} trigger sets the external alarm-contact trigger to closed.

Examples

This example shows how to configure alarm contact number 1 to report a critical alarm when the contact is open.

Switch(config)# alarm-contact 1 description main_lab_door
Switch(config)# alarm-contact 1 severity critical 
Switch(config)# alarm-contact 1 trigger open
Dec  4 10:34:09.049: %PLATFORM_ENV-1-EXTERNAL_ALARM_CONTACT_ASSERT: Alarm asserted: 
main_lab_door

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

Switch# show env alarm-contact
ALARM CONTACT 1
   Status:      asserted
   Description: main_lab_door
   Severity:    critical
   Trigger:     open

This example shows how to configure clear alarm contact number 1 and the show command outputs.

Switch(config)# no alarm-contact 1 description
Dec  4 10:39:33.621: %PLATFORM_ENV-1-EXTERNAL_ALARM_CONTACT_CLEAR: Alarm cleared: 
main_lab_door Dec  4 10:39:33.621: %PLATFORM_ENV-1-EXTERNAL_ALARM_CONTACT_ASSERT: Alarm 
asserted: external alarm contact 1

Switch(config)# no alarm-contact 1 severity
Dec  4 10:39:46.774: %PLATFORM_ENV-1-EXTERNAL_ALARM_CONTACT_CLEAR: Alarm cleared: external 
alarm contact 1 Dec  4 10:39:46.774: %PLATFORM_ENV-1-EXTERNAL_ALARM_CONTACT_ASSERT: Alarm 
asserted: external alarm contact 1

Switch(config)# no alarm-contact 1 trigger open
Dec  4 10:39:56.547: %PLATFORM_ENV-1-EXTERNAL_ALARM_CONTACT_CLEAR: Alarm cleared: external 
alarm contact 1

Switch(config)# end
Switch# show env alarm-contact
ALARM CONTACT 1
   Status:      not asserted
   Description: external alarm contact 1
   Severity:    minor
   Trigger:     closed
Switch# show hard led
SWITCH: 1
SYSTEM: GREEN
MGMT: GREEN
ALARM 1: BLACK
ALARM 2: BLACK
ALARM 3: BLACK
ALARM 4: BLACK

Related Commands

Command
Description

show env alarm-contact

Displays the alarm setting and status for the switch.


archive download-sw

Use the archive download-sw privileged EXEC command to download a new image from a TFTP server to the switch and to overwrite or keep the existing image.

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

Syntax Description

/force-reload

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

/imageonly

Download only the software image but not the HTML files associated with the embedded device manager. The HTML 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.

/no-version-check

Download the software image without checking to prevent installing an incompatible image.

/overwrite

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

/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 an HTTP server:
http://[[username:password]@]{hostname | host-ip}[/directory]/image-name.tar

The syntax for a secure HTTP server:
https://[[username:password]@]{hostname | host-ip}[/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

The current software image is not overwritten with the downloaded image.

Both the software image and HTML 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.

Compatibility of the version on the image to be downloaded is checked.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

The /imageonly option removes the HTML files for the existing image if the existing image is being removed or replaced. Only the Cisco IOS image (without the HTML files) is downloaded.

Using the /safe or /leave-old-sw option can cause the new image download to fail if there is insufficient flash memory. If leaving the software in place prevents the new image from fitting in flash memory due to space constraints, an error results.

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" section.


Note Use the /no-version-check option with care. This option allows an image to be downloaded without first confirming that it is not incompatible with the switch.


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

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.

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 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, list files in a tar file, or 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 filesystem:
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

None

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

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

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

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

Switch# archive tar /table flash:image_name-mz.122-release.tar 
info (219 bytes)
image_name-mz.122-release/(directory)
image_name-mz.122-release(610856 bytes)
image_name-mz.122-release/info (219 bytes)
info.ver (219 bytes)

This example shows how to display only the html directory and its contents:

Switch# archive tar /table flash:image_name-mz.122-release.tar 
image_name-mz.122-release/html
image_name-mz.122-release/html/ (directory)
image_name-mz.122-release/html/const.htm (556 bytes)
image_name-mz.122-release/html/xhome.htm (9373 bytes)
image_name-mz.122-release/html/menu.css (1654 bytes)
<output truncated>

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

 

Downloads a new image from a TFTP server 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 switch image to a server.

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

Syntax Description

/version version_string

(Optional) Specify the specific 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

Uploads the currently running image from the flash: file system.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

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

The files are uploaded in this sequence: the Cisco IOS image, the HTML files, and info. 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

 

Downloads a new image to the switch.

archive tar

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


arp access-list

Use the arp access-list global configuration command to define an Address Resolution Protocol (ARP) access control list (ACL) or to add clauses to the end of a previously defined list. Use the no form of this command to delete the specified ARP access list.

arp access-list acl-name

no arp access-list acl-name

Syntax Description

acl-name

Name of the ACL.


Defaults

No ARP access lists are defined.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

After entering the arp access-list command, you enter ARP access-list configuration mode, and these configuration commands are available:

default: returns a command to its default setting.

deny: specifies packets to reject. For more information, see the "deny (ARP access-list configuration)" section.

exit: exits ARP access-list configuration mode.

no: negates a command or returns to the default settings.

permit: specifies packets to forward. For more information, see the "permit (ARP access-list configuration)" section.

Use the permit and deny access-list configuration commands to forward and to drop ARP packets based on the specified matching criteria.

When the ARP ACL is defined, you can apply it to a VLAN by using the ip arp inspection filter vlan global configuration command. ARP packets containing only IP-to-MAC address bindings are compared to the ACL. All other types of packets are bridged in the ingress VLAN without validation. If the ACL permits a packet, the switch forwards it. If the ACL denies a packet because of an explicit deny statement, the switch drops the packet. If the ACL denies a packet because of an implicit deny statement, the switch compares the packet to the list of DHCP bindings (unless the ACL is static, which means that packets are not compared to the bindings).

Examples

This example shows how to define an ARP access list and to permit both ARP requests and ARP responses from a host with an IP address of 1.1.1.1 and a MAC address of 0000.0000.abcd:

Switch(config)# arp access-list static-hosts
Switch(config-arp-nacl)# permit ip host 1.1.1.1 mac host 00001.0000.abcd
Switch(config-arp-nacl)# end

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

Related Commands

Command
Description

deny (ARP access-list configuration)

Denies an ARP packet based on matches compared against the DHCP bindings.

ip arp inspection filter vlan

Permits ARP requests and responses from a host configured with a static IP address.

permit (ARP access-list configuration)

Permits an ARP packet based on matches compared against the DHCP bindings.

show arp access-list

Displays detailed information about ARP access lists.


bandwidth

Use the bandwidth policy-map class configuration command to configure class-based weighted fair queuing (CBWFQ) by setting the output bandwidth for a policy-map class. Use the no form of this command to remove the bandwidth setting for the class.

bandwidth {rate | percent value | remaining percent value}

no bandwidth [rate | percent value | remaining percent value]

Syntax Description

rate

Set the bandwidth rate for the class in kilobits per second (kbps). The range is from 64 to 1000000.

percent value

Set the bandwidth for the class as a percent of the total bandwidth. The range is from 1 to 100 percent.

remaining percent value

Set the bandwidth for the class as a percent of the remaining bandwidth. The range is from 1 to 100 percent.


Defaults

No bandwidth is defined.

Command Modes

Policy-map class configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You use the bandwidth policy-map class command to control output traffic. The bandwidth command specifies the bandwidth for traffic in that class. CBWFQ derives the weight for packets belonging to the class from the bandwidth allocated to the class and uses the weight to ensure that the queue for that class is serviced fairly. Bandwidth settings are not supported in input policy maps.

When you configure bandwidth for a class of traffic as an absolute rate (kbps) or a percentage of bandwidth (percent value), it represents the minimum bandwidth guarantee or committed information rate (CIR) for that traffic class. This means that the traffic class gets at least the bandwidth specified in the command, but is not limited to that bandwidth. Any excess bandwidth on the port is allocated to each class in the same ratio as the configured CIR rates.

When you enter the bandwidth remaining percent command, hard bandwidths are not guaranteed, and only relative bandwidths are assured. Class bandwidths are always proportional to the specified bandwidth percentages configured for the port.

When you configure bandwidth in an output policy, you must specify the same units in each bandwidth configuration; that is, all absolute values (rates) or percentages.

The total rate of the minimum bandwidth guarantees for each queue of the policy cannot exceed the total speed for the interface. If the percent keyword is used, the sum of the class bandwidth percentages cannot exceed 100 percent.

Using the queue-limit command to modify the default queue limit is especially important on higher-speed interfaces so that they meet the minimum bandwidth guarantees required by the interface.

You cannot use the bandwidth policy-map class configuration command to configure CBWFQ and the shape average command to configure class-based shaping for the same class in a policy map.

You cannot configure bandwidth in a class that includes priority queuing (configured with the priority policy-map class configuration command).

Examples

This example shows how to set the precedence of output queues by setting bandwidth in kilobits per second. The classes outclass1, outclass2, and outclass3 get a minimum of 50000, 20000, and 10000 kbps. The class class-default at a minimum gets the remaining bandwidth.

Switch(config)# policy-map out-policy
Switch(config-pmap)# class outclass1
Switch(config-pmap-c)# bandwidth 50000
Switch(config-pmap-c)# exit
Switch(config-pmap)# class outclass2
Switch(config-pmap-c)# bandwidth 20000
Switch(config-pmap-c)# exit
Switch(config-pmap)# class outclass3
Switch(config-pmap-c)# bandwidth 10000
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Switch(config)# interface fastethernet 0/1
Switch(config-if)# service-policy output out-policy
Switch(config-if)# exit

This example shows how to set the precedence of output queues by allocating percentages of the total available bandwidth to each traffic class.The classes outclass1, outclass2, and outclass3 get a minimum of 50, 20, and 10 percent. The class class-default at a minimum gets 20 percent.

Switch(config)# policy-map out-policy
Switch(config-pmap)# class outclass1
Switch(config-pmap-c)# bandwidth percent 50
Switch(config-pmap-c)# exit
Switch(config-pmap)# class outclass2
Switch(config-pmap-c)# bandwidth percent 20
Switch(config-pmap-c)# exit
Switch(config-pmap)# class outclass3
Switch(config-pmap-c)# bandwidth percent 10
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Switch(config)# interface fastethernet 0/1
Switch(config-if)# service-policy output out-policy
Switch(config-if)# exit

This example shows how to set outclass1 as a priority queue, with outclass2, and outclass3 getting 50 and 20 percent, respectively, of the bandwidth remaining after the priority queue is serviced. The class class-default gets the remaining 30 percent with no guarantees.

Switch(config)# policy-map out-policy
Switch(config-pmap)# class outclass1
Switch(config-pmap-c)# priority
Switch(config-pmap-c)# exit
Switch(config-pmap)# class outclass2
Switch(config-pmap-c)# bandwidth remaining percent 50
Switch(config-pmap-c)# exit
Switch(config-pmap)# class outclass3
Switch(config-pmap-c)# bandwidth remaining percent 20
Switch(config-pmap-c)# exit
Switch(config-pmap)# exit
Switch(config)# interface fastethernet 0/1
Switch(config-if)# service-policy output out-policy
Switch(config-if)# exit

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

Related Commands

Command
Description

class

Defines a traffic classification match criteria for the specified class-map name.

policy-map

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

show policy-map

Displays quality of service (QoS) policy maps.


boot config-file

Use the boot config-file global configuration command to specify the filename that Cisco IOS 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

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

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 A, "Cisco ME 3400E Ethernet Access 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. Use the no form of this command to return to the default setting.

boot enable-break

no boot enable-break

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled. The automatic boot process cannot be interrupted by pressing the Break key on the console.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

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. The break key is different for each operating system:

On a SUN work station running UNIX, Ctrl-C is the break key.

On a PC running Windows 2000, Ctrl-Break is the break key.

This command changes the setting of the ENABLE_BREAK environment variable. For more information, see Appendix A, "Cisco ME 3400E Ethernet Access 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 patch the functionality of the boot loader. Use the no form of this command to return to the default.

boot helper filesystem:/file-url ...

no boot helper

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

This command was introduced.


Usage Guidelines

This variable is used only for internal development and testing.

Filenames and directory names are case sensitive.

This command changes the setting of the HELPER environment variable. For more information, see Appendix A, "Cisco ME 3400E Ethernet Access 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 Cisco IOS that are loaded. 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

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

This command was introduced.


Usage Guidelines

This variable is used only for internal development and testing.

Filenames and directory names are case sensitive.

This command changes the setting of the HELPER_CONFIG_FILE environment variable. For more information, see Appendix A, "Cisco ME 3400E Ethernet Access 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 manually booting the switch during the next boot cycle. Use the no form of this command to return to the default setting.

boot manual

no boot manual

Syntax Description

This command has no arguments or keywords.

Defaults

Manual booting is disabled.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

The next time you reboot the system, the switch is in boot loader mode, which is shown by the switch: prompt. To boot 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 A, "Cisco ME 3400E Ethernet Access 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 Cisco IOS 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.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Filenames are case sensitive.

Examples

This example shows how to specify the name of the private configuration file to be 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 Cisco IOS image to load during the next boot cycle. Use the no form of this command to return to the default setting.

boot system filesystem:/file-url ...

no boot system

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 boot 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 continuing the search in the original directory.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

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 never 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 A, "Cisco ME 3400E Ethernet Access 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 port to an EtherChannel group. Use the no form of this command to remove an Ethernet port 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


Note Link Aggregation Control Protocol (LACP.) and Port Aggregation Protocol (PAgP) are available only on network node interfaces (NNIs) or enhanced network interfaces (ENIs). The active, auto, desirable, and passive keywords are not visible on user network interfaces (UNIs).


Syntax Description

channel-group-number

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

mode

Specify the EtherChannel mode.

active

Unconditionally enable LACP

Active mode places a port into a negotiating state in which the port initiates negotiations with other ports by sending LACP packets. A channel is formed with another port group in either the active or passive mode.

auto

Enable the PAgP only if a PAgP device is detected.

Auto mode places a port into a passive negotiating state in which the port responds to PAgP packets it receives but does not start 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 a port into an active negotiating state in which the port starts negotiations with other ports 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) Use in PAgP mode with the auto or desirable keyword when 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.

passive

Enable LACP only if a LACP device is detected.

Passive mode places a port into a negotiating state in which the port 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.


Defaults

No channel groups are assigned.

No mode is configured.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

For Layer 2 EtherChannels, you do not have to create a port-channel interface first by using the interface port-channel global configuration command before assigning a physical port to a channel group. Instead, you can use the channel-group interface configuration command. It automatically creates the port-channel interface when the channel group gets its first physical port if the logical interface is not already created. If you create the port-channel interface first, the channel-group-number can be the same as the port-channel-number, or you can use a new number. If you use a new number, the channel-group command dynamically creates a new port channel.

If the port is a UNI or an ENI, you must use the no shutdown interface configuration command to enable it before using the channel-group command. UNIs and ENIs are disabled by default. NNIs are enabled by default.

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

You create Layer 3 port channels by using the interface port-channel command followed by the no switchport interface configuration command. You should manually configure the port-channel logical interface before putting the interface into the channel group.

After you configure an EtherChannel, configuration changes that you make on the port-channel interface apply to all the physical ports assigned to the port-channel interface. Configuration changes applied to the physical port affect only the port where you apply the configuration. To change the parameters of all ports in an EtherChannel, apply configuration commands to the port-channel interface, for example, spanning-tree commands or commands to configure a Layer 2 EtherChannel as a trunk.

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. A 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 port to a channel group, and to use the port for transmission. Both ends of the link cannot be set to silent.

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


Caution You should exercise care when setting the mode to on (manual configuration). All ports configured in the on mode are bundled in the same group and are forced to have similar characteristics. If the group is misconfigured, packet loss or spanning-tree loops might occur.

Do not configure an EtherChannel in both the PAgP and LACP modes. EtherChannel groups running PAgP and LACP can coexist on the same switch. Individual EtherChannel groups can run either PAgP or LACP, but they cannot interoperate.


Note PAgP and LACP are available only on NNIs and ENIs.


If you set the protocol by using the channel-protocol interface configuration command, the setting is not overridden by the channel-group interface configuration command.

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 on an EtherChannel port, an error message appears, and IEEE 802.1x is not enabled.

Do not configure a secure port as part of an EtherChannel or an EtherChannel port as a secure port.

For a complete list of configuration guidelines, see the "Configuring EtherChannels" chapter in the software configuration guide for this release.


Caution Do not enable Layer 3 addresses on the physical EtherChannel ports. Do not assign bridge groups on the physical EtherChannel ports because it creates loops.

Examples

This example shows how to configure an EtherChannel. It assigns two static-access ports in VLAN 10 to channel 5 with the PAgP mode desirable:

Switch# configure terminal 
Switch(config)# interface range gigabitethernet0/1 -2 
Switch(config-if-range)# switchport mode access
Switch(config-if-range)# switchport access vlan 10
Switch(config-if-range)# channel-group 5 mode desirable 
Switch(config-if-range)# end 

This example shows how to configure an EtherChannel. It assigns two static-access ports in VLAN 10 to channel 5 with the LACP mode active:

Switch# configure terminal 
Switch(config)# interface range gigabitethernet0/1 -2 
Switch(config-if-range)# switchport mode access
Switch(config-if-range)# switchport access vlan 10
Switch(config-if-range)# channel-group 5 mode active 
Switch(config-if-range)# end 

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

Related Commands

Command
Description

channel-protocol

Restricts the protocol used on a port to manage channeling.

interface port-channel

Accesses or creates the port channel.

show etherchannel

Displays EtherChannel information for a channel.

show lacp

Displays LACP channel-group information.

show pagp

Displays PAgP channel-group information.

show running-config

Displays the operating configuration. For syntax information, use this link to the Cisco IOS Release 12.2 Command Reference listing page: http://www.cisco.com/en/US/products/sw/iosswrel/ps1835/prod_command_reference_list.html
Select the Cisco IOS Commands Master List, Release 12.2 to navigate to the command.


channel-protocol

Use the channel-protocol interface configuration command to restrict the protocol used on a port to manage channeling. Use the no form of this command to return to the default setting.

channel-protocol {lacp | pagp}

no channel-protocol

Syntax Description

lacp

Configure an EtherChannel with the Link Aggregation Control Protocol (LACP).

pagp

Configure an EtherChannel with the Port Aggregation Protocol (PAgP).


Defaults

No protocol is assigned to the EtherChannel.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Use the channel-protocol command only to restrict a channel to LACP or PAgP. If you set the protocol by using the channel-protocol command, the setting is not overridden by the channel-group interface configuration command.


Note PAgP and LACP are available only on network node interfaces (NNIs) and enhanced network interfaces (ENIs).


If the port is a user network interface (UNI) or an ENI, you must use the no shutdown interface configuration command to enable it before using the channel-protocol command. UNIs and ENIs are disabled by default. NNIs are enabled by default.

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

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

PAgP and LACP are not compatible; both ends of a channel must use the same protocol.

Examples

This example shows how to specify LACP as the protocol that manages the EtherChannel:

Switch(config-if)# channel-protocol lacp

You can verify your settings by entering the show etherchannel [channel-group-number] protocol privileged EXEC command.

Related Commands

Command
Description

channel-group

Assigns an Ethernet port to an EtherChannel group.

show etherchannel protocol

Displays protocol information the EtherChannel.


class

Use the class policy-map configuration command to specify the name of the class whose policy you want to create or to change or to specify the system default class before you configure a policy and to enter policy-map class configuration mode. Use the no form of this command to remove the class from a policy map.

class {class-map-name| class-default}

no class {class-map-name| class-default}

Syntax Description

class-map-name

Name of a class map created by using the class-map global configuration command.

class-default

The system default class. This class matches all unclassified traffic. You cannot create or delete the default class.


Defaults

No policy map classes are defined.

Command Modes

Policy-map configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Before using the class class-map-name command in policy-map configuration mode, you must create the class by using the class-map class-map-name global configuration command. The class class-default is the class to which traffic is directed if that traffic does not match any of the match criteria in the configured class maps.

Use the policy-map global configuration command to identify the policy map and to enter policy-map configuration mode. After specifying a policy map, you can configure a policy for new classes or modify a policy for any existing classes in that policy map.

An input policy map can have a maximum of 64 classes, plus class-default.

You attach the policy map to a port by using the service-policy interface configuration command.

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

bandwidth: specifies the bandwidth allocated for a class belonging to a policy map. For more information, see the bandwidth command.

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

no: returns a command to its default setting.

police: defines an individual policer or aggregate 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 and police aggregate (policy-map class configuration) policy-map class commands.

priority: sets the strict scheduling priority for this class or, when used with the police keyword, sets priority with police. For more information, see the priority policy-map class command.

queue-limit: sets the queue maximum threshold for Weighted Tail Drop (WTD). For more information, see the queue-limit command.

service-policy: configures a QoS service policy to attach to a parent policy map for an input or output policy. For more information, see the service-policy (policy-map class configuration) command.

set: specifies a value to be assigned to the classified traffic. For more information, see the set commands.

shape average: specifies the average traffic shaping rate. For more information, see the shape average command.

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

Examples

This example shows how to create a policy map called policy1, define a class class1, and enter policy-map class configuration mode to set a criterion for the class.

Switch(config)# policy-map policy1
Switch(config-pmap)# class class1
Switch(config-pmap-c)# set dscp 10
Switch(config-pmap-c)# exit

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.

policy-map

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

show policy-map

Displays QoS policy maps.

show policy-map interface [interface-id]

Displays policy maps configured on the specified interface or on all interfaces.


class-map

Use the class-map global configuration command to create a class map to be used for matching packets to a specified criteria and to enter class-map configuration mode. Use the no form of this command to delete an existing class map.

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

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

Syntax Description

match-all

(Optional) Perform a logical-AND of all matching statements under this class map. Packets must meet all of the match criteria.

match-any

(Optional) Perform a logical-OR of the matching statements under this class map. Packets must meet one or more of the match criteria.

class-map-name

Name of the class map.


Defaults

No class maps are defined.

If neither the match-all or the match-any keyword is specified, the default is match-all.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

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

The switch supports a maximum of 1024 unique class maps.

You use the class-map command and class-map configuration mode to define packet classification as part of a globally named service policy applied on a per-port basis. When you configure a class map, you can use one or more match commands to specify match criteria. Packets arriving at either the input or output interface (determined by how you configure the service-policy interface configuration command) are checked against the class-map match criteria to determine if the packet belongs to that class.

A match-all class map means that the packet must match all entries and can have no other match statements.

After you are in class-map configuration mode, these configuration commands are available:

description: describes the class map (up to 200 characters). The show class-map privileged EXEC command displays the description and the name of the class map.

exit: exits QoS class-map configuration mode.

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

no: removes a match statement from a class map.

Examples

This example shows how to configure the class map called class1. By default, the class map is match-all and therefore can contain no other match criteria.

Switch(config)# class-map class1
Switch(config-cmap)# exit

This example shows how to configure a match-any class map with one match criterion, which is an access list called 103. This class map (matching an ACL) is supported only in an input policy map.

Switch(config)# class-map class2
Switch(config-cmap)# match access-group 103
Switch(config-cmap)# exit

This example shows how to delete the class map class1:

Switch(config)# no class-map class1

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

Related Commands

Command
Description

class

Defines a traffic classification match criteria for the specified class-map name.

match access-group

Configures the match criteria for a class map on the basis of the specified access control list (ACL)

match cos

Configures the match criteria for a class map on the basis of the Layer 2 class of service (CoS) marking,

match ip dscp

Configures the match criteria for a class map on the basis of a specific IPv4 Differentiated Service Code Point (DSCP) value.

match ip precedence

Configures the match criteria for a class map on the basis of IPv4 precedence values.

match qos-group

Configures the match criteria for a class map on the basis of a specific quality of service (QoS) group value.

match vlan

Configures the match criteria for a class map in the parent policy of a hierarchical policy map based on a VLAN ID or range of VLAN IDs.

policy-map

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

show class-map

Displays QoS class maps.


clear ip arp inspection log

Use the clear ip arp inspection log privileged EXEC command to clear the dynamic Address Resolution Protocol (ARP) inspection log buffer.

clear ip arp inspection log

Syntax Description

This command has no arguments or keywords.

Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Examples

This example shows how to clear the contents of the log buffer:

Switch# clear ip arp inspection log

You can verify that the log was cleared by entering the show ip arp inspection log privileged command.

Related Commands

Command
Description

arp access-list

Defines an ARP access control list (ACL).

ip arp inspection log-buffer

Configures the dynamic ARP inspection logging buffer.

ip arp inspection vlan logging

Controls the type of packets that are logged per VLAN.

show ip arp inspection log

Displays the configuration and contents of the dynamic ARP inspection log buffer.


clear ip arp inspection statistics

Use the clear ip arp inspection statistics privileged EXEC command to clear the dynamic Address Resolution Protocol (ARP) inspection statistics.

clear ip arp inspection statistics [vlan vlan-range]

Syntax Description

vlan vlan-range

(Optional) Clear statistics for the specified VLAN or VLANs.

You can specify a single VLAN identified by VLAN ID number, a range of VLANs separated by a hyphen, or a series of VLANs separated by a comma. The range is 1 to 4094.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Examples

This example shows how to clear the statistics for VLAN 1:

Switch# clear ip arp inspection statistics vlan 1

You can verify that the statistics were deleted by entering the show ip arp inspection statistics vlan 1 privileged EXEC command.

Related Commands

Command
Description

show ip arp inspection statistics

Displays statistics for forwarded, dropped, MAC validation failure, and IP validation failure packets for all VLANs or the specified VLAN.


clear ip dhcp snooping

Use the clear ip dhcp snooping privileged EXEC command to clear the DHCP binding database agent statistics or the DHCP snooping statistics counters.

clear ip dhcp snooping {binding {* | ip-address | interface interface-id | vlan vlan-id} | database statistics | statistics}

Syntax Description

binding

Clear the DHCP snooping binding database.

*

Clear all automatic bindings.

ip-address

Clear the binding entry IP address.

interface interface-id

Clear the binding input interface.

vlan vlan-id

Clear the binding entry VLAN.

database statistics

Clear the DHCP snooping binding database agent statistics.

database statistics

Clear the DHCP snooping binding database agent statistics.

statistics

Clear the DHCP snooping statistics counter.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

When you enter the clear ip dhcp snooping database statistics command, the switch does not update the entries in the binding database and in the binding file before clearing the statistics.

Examples

This example shows how to clear the DHCP snooping binding database agent statistics:

Switch# clear ip dhcp snooping database statistics 

You can verify that the statistics were cleared by entering the show ip dhcp snooping database privileged EXEC command.

This example shows how to clear the DHCP snooping statistics counters:

Switch# clear ip dhcp snooping statistics 

You can verify that the statistics were cleared by entering the show ip dhcp snooping statistics user EXEC command.

Related Commands

Command
Description

ip dhcp snooping

Enables DHCP snooping on a VLAN.

ip dhcp snooping database

Configures the DHCP snooping binding database agent or the binding file.

show ip dhcp snooping binding

Displays the status of DHCP snooping database agent.

show ip dhcp snooping database

Displays the DHCP snooping binding database agent statistics.

show ip dhcp snooping statistics

Displays the DHCP snooping statistics.


clear ipc

Use the clear ipc privileged EXEC command to clear Interprocess Communications Protocol (IPC) statistics.

clear ipc {queue-statistics | statistics}

Syntax Description

queue-statistics

Clear the IPC queue statistics.

statistics

Clear the IPC statistics.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You can clear all statistics by using the clear ipc statistics command, or you can clear only the queue statistics by using the clear ipc queue-statistics command.

Examples

This example shows how to clear all statistics:

Switch# clear ipc statistics

This example shows how to clear only the queue statistics:

Switch# clear ipc queue-statistics

You can verify that the statistics were deleted by entering the show ipc rpc or the show ipc session privileged EXEC command.

Related Commands

Command
Description

show ipc {rpc | session}

Displays the IPC multicast routing statistics.


clear ipv6 dhcp conflict

Use the clear ipv6 dhcp conflict privileged EXEC command to clear an address conflict from the Dynamic Host Configuration Protocol for IPv6 (DHCPv6) server database.

clear ipv6 dhcp conflict {* | IPv6-address}


Note This command is available only if the switch is running the metro IP access image and you have configured a dual IPv4 and IPv6 Switch Database Management (SDM) template on the switch.


Syntax Description

*

Clear all address conflicts.

IPv6-address

Clear the host IPv6 address that contains the conflicting address.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(50)SE

This command was introduced.


Usage Guidelines

To configure the dual IPv4 and IPv6 template, enter the sdm prefer dual-ipv4-and-ipv6 {default | routing | vlan} global configuration command, and reload the switch.

When you configure the DHCPv6 server to detect conflicts, it uses ping. The client uses neighbor discovery to detect clients and reports to the server through a DECLINE message. If an address conflict is detected, the address is removed from the pool and is not assigned until the administrator removes the address from the conflict list.

If you use the asterisk (*) character as the address parameter, DHCP clears all conflicts.

Examples

This example shows how to clear all address conflicts from the DHCPv6 server database:

Switch# clear ipv6 dhcp conflict *

Related Commands

Command
Description

show ipv6 dhcp conflict

Displays address conflicts found by a DHCPv6 server, or reported through a DECLINE message from a client.


clear l2protocol-tunnel counters

Use the clear l2protocol-tunnel counters privileged EXEC command to clear the protocol counters in protocol tunnel ports.

clear l2protocol-tunnel counters [interface-id]

This command is supported only when the switch is running the metro IP access or metro access image.

Syntax Description

interface-id

(Optional) Specify interface (physical interface or port channel) for which protocol counters are to be cleared.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Use this command to clear protocol tunnel counters on the switch or on the specified interface.

Examples

This example shows how to clear Layer 2 protocol tunnel counters on an interface:

Switch# clear l2protocol-tunnel counters gigabitethernet0/2

Related Commands

Command
Description

show l2protocol-tunnel

Displays information about ports configured for Layer 2 protocol tunneling.


clear lacp

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

clear lacp {channel-group-number counters | counters}


Note LACP is available only on network node interfaces (NNIs) and enhanced network interfaces (ENIs).


Syntax Description

channel-group-number

(Optional) Channel group number. The range is 1 to 48.

counters

Clear traffic counters.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You can clear all counters by using the clear lacp counters command, or you can clear only the counters for the specified channel group by using the clear lacp channel-group-number counters command.

Examples

This example shows how to clear all channel-group information:

Switch# clear lacp counters

This example shows how to clear LACP traffic counters for group 4:

Switch# clear lacp 4 counters

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

Related Commands

Command
Description

show lacp

Displays LACP channel-group information.


clear logging onboard

Use the clear logging onboard privileged EXEC command to clear all the on-board failure logging (OBFL) data except for the uptime and CLI-command information stored in the flash memory.

clear logging onboard [module {slot-number | all}]

Syntax Description

module {slot-number | all}

(Optional) The slot number is always 1 and is not relevant for the ME-3400E. Entering clear logging onboard module 1 or clear logging onboard all has the same result as entering clear logging onboard.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

We recommend that you keep OBFL enabled and do not clear the data stored in the flash memory.

Examples

These examples show how to clear all the OBFL information except for the uptime and CLI-command information:

Switch# clear logging onboard
Clear logging onboard buffer [confirm]
PID: ME-3400E-24TS-M   , VID: 03 , SN: FOC1225U4CY

Switch# clear logging onboard module all
Clear logging onboard buffer [confirm]
PID: ME-3400E-24TS-M   , VID: 03 , SN: FOC1225U4CY

You can verify that the information was cleared by entering the show logging onboard onboard privileged EXEC command.

Related Commands

Command
Description

hw-module module logging onboard

Enables OBFL.

show logging onboard

Displays OBFL information.


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}

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

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

This command was introduced.


Examples

This example shows how to remove a specific MAC address from the dynamic 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 mac address-table move update

Use the clear mac address-table move update privileged EXEC command to clear the mac address-table-move update-related counters.

clear mac address-table move update

This command is supported only when the switch is running the metro IP access or metro access image.

Syntax Description

This command has no arguments or keywords.

Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Examples

This example shows how to clear the mac address-table move update related counters.

Switch# clear mac address-table move update

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

Related Commands

Command
Description

mac address-table move update

Configures MAC address-table move update on the switch.

show mac address-table move update

Displays the MAC address-table move update information on the switch.


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}


Note PAgP is available only on network node interfaces (NNIs) enhanced network interfaces (ENIs).


Syntax Description

channel-group-number

(Optional) Channel group number. The range is 1 to 48.

counters

Clear traffic counters.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You can clear all counters by using the clear pagp counters command, or you can clear only the counters for the specified channel group by using the clear pagp channel-group-number counters command.

Examples

This example shows how to clear all channel-group information:

Switch# clear pagp counters

This example shows how to clear PAgP traffic counters for group 10:

Switch# clear pagp 10 counters

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

Related Commands

Command
Description

show pagp

Displays PAgP channel-group information.


clear policer cpu uni-eni counters

Use the clear policer cpu uni-eni counters privileged EXEC command to clear control-plane policer statistics. The control-plane policer drops or rate-limits control packets from user network interfaces (UNIs) and enhanced network interfaces (ENIs) to protect the CPU from overload.

clear policer cpu uni-eni counters {classification | drop}

Syntax Description

classification

Clear control-plane policer classification counters that maintain statistics by feature.

drop

Clear all frame drop statistics maintained by the control-plane policer.


Command Default

No default is defined.

Command Modes

User EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You can use this command to clear statistics maintained per feature or statistics about dropped frames.

You can enter the show platform policer cpu classification or show policer cpu uni drop command to view feature statistics or dropped frames before and after you use the clear command.

Related Commands

Command
Description

show platform policer cpu classification

Displays CPU policer statistics per feature.

show policer cpu uni-eni

Displays CPU policer information for the switch.


clear port-security

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

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

Syntax Description

all

Delete all secure MAC addresses.

configured

Delete configured secure MAC addresses.

dynamic

Delete secure MAC addresses auto-learned by hardware.

sticky

Delete secure MAC addresses, either auto-learned or configured.

address mac-addr

(Optional) Delete the specified dynamic secure MAC address.

interface interface-id

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

vlan

(Optional) Delete the specified secure MAC address from the specified VLAN. Enter one of these options after you enter the vlan keyword:

vlan-id—On a trunk port, specify the VLAN ID of the VLAN on which this address should be cleared.

access—On an access port, clear the specified secure MAC address on the access VLAN.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Examples

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

Switch# clear port-security all

This example shows how to remove a specific 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 gigabitethernet0/1

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

Switch# clear port-security dynamic

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

Related Commands

Command
Description

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.

show port-security

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


clear rep counters

Use the clear rep counters privileged EXEC command to clear Resilient Ethernet Protocol (REP) counters for the specified interface or all interfaces.

clear rep counters [interface interface-id]

Syntax Description

interface interface-id

(Optional) Specify a REP interface whose counters should be cleared.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(50)SE

This command was introduced.


Usage Guidelines

You can clear all REP counters by using the clear rep counters command, or you can clear only the counters for the interface by using the clear rep counters interface interface-id command.

When you enter the clear rep counters command, only the counters visible in the output of the show interface rep detail command are cleared. SNMP visible counters are not cleared as they are read-only.

Examples

This example shows how to clear all REP counters for all REP interfaces:

Switch# clear rep counters

You can verify that REP information was deleted by entering the show interfaces rep detail privileged EXEC command.

Related Commands

Command
Description

show interfaces rep detail

Displays detailed REP configuration and status information.


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. Valid interfaces include physical network node interfaces (NNIs), enhanced network interfaces (ENIs) on which spanning tree has been enabled, VLANs, and spanning-tree port channels. The VLAN range is 1 to 4094. The port-channel range is 1 to 48.

Note Spanning Tree Protocol (STP) is not supported on user network interfaces (UNIs). Though visible in the command-line help, the command has no effect on UNIs or on ENIs on which STP is not enabled.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

If the interface-id is not specified, spanning-tree counters are cleared for all STP ports.

Examples

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

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 spanning-tree 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 network node interfaces (NNIs), enhanced network interfaces (ENIs) on which spanning tree is enabled, VLANs, and port channels. The VLAN range is 1 to 4094. The port-channel range is 1 to 48.

Note Spanning Tree Protocol (STP) is not supported on user network interfaces (UNIs). Though visible in the command-line help, the command has no effect on UNIs or on ENIs on which STP is not enabled.


Defaults

No default is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


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 a rapid spanning-tree (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. It cannot learn 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 a port:

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

Related Commands

Command
Description

show spanning-tree

Displays spanning-tree state information.

spanning-tree link-type

Overrides the default link-type setting and enables rapid spanning-tree transitions to the forwarding state.


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

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 information was deleted by entering the show vmps statistics privileged EXEC command.

Related Commands

Command
Description

show vmps

Displays the VQP version, reconfirmation interval, retry count, VMPS IP addresses, and the current and primary servers.


conform-action

Use the conform-action policy-map class police configuration command to set multiple actions for a policy-map class for packets that conform to the committed information rate (CIR) or peak information rate (PIR) by having a rate less than the conform burst. Use the no form of this command to cancel the action or to return to the default action.

conform-action {drop | set-cos-transmit {new-cos-value | [cos | dscp | precedence] [table table-map name]} | set-dscp-transmit {new-dscp-value | [cos | dscp | precedence] [table table-map name]} | set-prec-transmit {new-precedence-value | [cos | dscp | precedence] [table table-map name]} | set-qos-transmit qos-group-value | transmit]}

no conform-action {drop | set-cos-transmit {new-cos-value | [cos | dscp | precedence] [table table-map name]} | set-dscp-transmit {new-dscp-value | [cos | dscp | precedence] [table table-map name]} | set-prec-transmit {new-precedence-value | [cos | dscp | precedence] [table table-map name]} | set-qos-transmit qos-group-value | transmit]}

Syntax Description

drop

Drop the packet.

set-cos-transmit new-cos-value

Set a new class of service (CoS) value for the packet and send the packet. This specifies the to-type of the marking action. The range for the new CoS value is 0 to 7.

set-dscp-transmit new-dscp-value

Set a new Differentiated Services Code Point (DSCP) value for the packet and send the packet. This specifies the to-type of the marking action. The range for the new DCSP value is 0 to 63.

set-prec-transmit new-precedence-value

Set a new IP precedence value for the packet and send the packet. This specifies the to-type of the marking action. The range for the new IP precedence value is 0 to 7.

set-qos-transmit qos-group-value

Set a new quality of service (QoS) group value for the packet and send the packet. This specifies the to-type of the marking action. The range for the new QoS value is 0 to 99.

cos

(Optional) Set the packet marking specified in the preceding keyword based on the CoS value of the incoming packet, and send the packet. This specifies the from-type of the enhanced packet-marking action.

dscp

(Optional) Set the packet marking specified in the preceding keyword based on the DSCP value of the incoming packet, and send the packet. This specifies the from-type of the enhanced packet-marking action.

precedence

(Optional) Set the packet marking specified in the preceding keyword based on the IP precedence value of the incoming packet, and send the packet. This specifies the from-type of the enhanced packet-marking action.

table table-map name

(Optional) Used in conjunction with the preceding from-type keyword. Specify the table map to be used for the enhanced packet marking. The to-type of the action is marked based on the from-type parameter of the action using this table map.

transmit

(Optional) Send the packet unmodified.


Defaults

The default conform action is to send the packet.

Command Modes

Policy-map class police configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You configure conform actions for packets when the packet rate is less than the configured conform burst.

If the conform action is set to drop, the exceed and violate actions are automatically set to drop.

You can configure conform-action marking by using enhanced packet marking to modify a QoS marking based on any incoming QoS marking and table maps. The switch also supports simultaneously marking multiple QoS parameters for the same class and configuring conform-action, exceed-action, and violate-action marking.

Access policy-map class police configuration mode by entering the police policy-map class command. See the police policy-map class configuration command for more information.

Use this command to set one or more conform actions for a traffic class.

Examples

This example shows how configure multiple conform actions in a policy map that sets a committed information rate of 23000 bits per second (bps) and a conform burst rate of 10000 bps. The policy map includes multiple conform actions (for DSCP and for Layer 2 CoS) and an exceed action.

Switch(config)# policy-map map1
Switch(config-pmap)# class cos-set-1
Switch(config-pmap-c)# police cir 23000 bc 10000
Switch(config-pmap-c-police)# conform-action set-dscp-transmit 48
Switch(config-pmap-c-police)# conform-action set-cos-transmit 5
Switch(config-pmap-c-police)# exceed-action drop
Switch(config-pmap-c-police)# exit

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

Related Commands

Command
Description

class

Defines a traffic classification match criteria for the specified class-map name.

exceed-action

Defines the action to take on traffic that exceeds the CIR.

policy-map

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

police

Defines a policer for classified traffic.

show policy-map

Displays QoS policy maps.

violate-action

Defines the action to take on traffic with a rate greater than the conform rate plus the exceed burst.


copy logging onboard module

Use the copy logging onboard module privileged EXEC command to copy on-board failure logging (OBFL) data to the local network or a specific file system.

copy logging onboard module [slot-number] destination

Syntax Description

slot-number

(Optional) The slot number is always 1 and is not relevant for the ME-3400E.

destination

Specify the location on the local network or file system to which the system messages are copied.

For destination, specify the destination on the local or network file system and the filename. These options are supported:

The syntax for the local flash file system:
flash:/filename

The syntax for the FTP:
ftp://username:password@host/filename

The syntax for an HTTP server:
http://[[username:password]@]{hostname | host-ip}[/directory]/filename

The syntax for the null file system:
null:/filename

The syntax for the NVRAM:
nvram:/filename

The syntax for the Remote Copy Protocol (RCP): rcp://username@host/filename

The syntax for the switch file system:
system:filename

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

The syntax for the temporary file system:
tmpsys:/filename


Defaults

This command has no default setting.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

For information about OBFL, see the hw-module module logging onboard global configuration command.

Examples

This example shows how to copy the OBFL data messages to the obfl_file file on the flash file system:

Switch# copy logging onboard module flash:obfl_file
OBFL copy successful

Related Commands

Command
Description

hw-module module logging onboard

Enables OBFL.

show logging onboard

Displays OBFL information.


cpu traffic qos

Use the cpu traffic qos global configuration command to configure the quality of service (QoS) marking parameters for CPU-generated traffic. Use the no form of this command to return to the default setting.

cpu traffic qos [cos value | dscp value | precedence value | qos-group value]

no cpu traffic qos [cos value | dscp value | precedence value | qos-group value]

Syntax Description

cos value

(Optional) Set the class of service (CoS) value.The range is from 0 to 7.

dscp value

(Optional) Set the Differentiated Services Code Point (DSCP) value. The range is from 0 to 63. You also can enter a mnemonic name for a commonly used value.

precedence value

(Optional) Set the parameters for each IP precedence value. The range is from 0 to 7. You also can enter a mnemonic name for a commonly used value.

qos-group value

(Optional) Set the parameters for each quality-of-service (QoS) group value. The range is from 0 to 99.


Defaults

The default egress queue value is 2. However, if there is no output policy attached to the port, the CPU-generated traffic is sent through the first non-priority queue defined in the output policy map.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Use the cpu traffic qos global configuration command to mark the control plane traffic that the CPU generates.

You must globally enable mls qos global configuration command on the switch to use the cpu traffic qos feature.

When you mark CPU-generated traffic with CoS, DSCP, IP precedence, or group values, the control protocol traffic is marked with these values, except for Connectivity Fault Management (CFM) traffic and Cisco IOS IP Service Level Agreements (SLAs). Any changes that you make using the cpu traffic qos global configuration command does not affect the CFM traffic or IP SLA CoS markings.

Examples

This example shows how to set the CoS value to 5, for the control plane traffic that the CPU generates.

Switch(config)# cpu traffic qos cos 5

You can verify your settings by entering the show cpu traffic qos privileged EXEC command.

Related Commands

Command
Description

show cpu traffic qos

Displays the QoS output for CPU-generated traffic.


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

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, gigabitethernet 0/1 - 2 is a valid range; gigabitethernet 0/1-2 is not a valid range

Valid values for type and interface:

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

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.

port-channel port-channel-number, where port-channel-number is from 1 to 48

fastethernet module/{first port} - {last port}

gigabitethernet module/{first port} - {last port}

For physical interfaces:

module is always 0.

the range is type 0/number - number (for example, gigabitethernet 0/1 - 2).

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

gigabitethernet0/1 - 2

You can also enter multiple ranges. When you define multiple ranges, you must enter a space after the first entry before the comma (,). The space after the comma is optional, for example:

fastethernet0/3, gigabitethernet0/1 - 2

fastethernet0/3 -4, gigabitethernet0/1 - 2

Examples

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

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

Related Commands

Command
Description

interface range

Executes a command on multiple ports at the same time.

show running-config

Displays the operating configuration. For syntax information, use this link to the Cisco IOS Release 12.2 Command Reference listing page: http://www.cisco.com/en/US/products/sw/iosswrel/ps1835/prod_command_reference_list.html
Select the Cisco IOS Commands Master List, Release 12.2 to navigate to the command.


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.

The syntax for the local flash file system:
flash:

/file-url

The path (directory) and filename to delete.


Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


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 Release 12.1.

Examples

This example shows how to remove the directory that contains the old software image after a successful download of a new image:

Switch# delete /force /recursive flash:/old-image

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

Related Commands

Command
Description

archive download-sw

Downloads a new image to the switch and overwrites or keeps the existing image.


deny (ARP access-list configuration)

Use the deny Address Resolution Protocol (ARP) access-list configuration command to deny an ARP packet based on matches against the DHCP bindings. Use the no form of this command to remove the specified access control entry (ACE) from the access list.

deny {[request] ip {any | host sender-ip | sender-ip sender-ip-mask} mac {any | host sender-mac | sender-mac sender-mac-mask} | response ip {any | host sender-ip | sender-ip sender-ip-mask} [{any | host target-ip | target-ip target-ip-mask}] mac {any | host sender-mac | sender-mac sender-mac-mask} [{any | host target-mac | target-mac target-mac-mask}]} [log]

no deny {[request] ip {any | host sender-ip | sender-ip sender-ip-mask} mac {any | host sender-mac | sender-mac sender-mac-mask} | response ip {any | host sender-ip | sender-ip sender-ip-mask} [{any | host target-ip | target-ip target-ip-mask}] mac {any | host sender-mac | sender-mac sender-mac-mask} [{any | host target-mac | target-mac target-mac-mask}]} [log]

Syntax Description

request

(Optional) Define a match for the ARP request. When request is not specified, matching is performed against all ARP packets.

ip

Specify the sender IP address.

any

Deny any IP or MAC address.

host sender-ip

Deny the specified sender IP address.

sender-ip sender-ip-mask

Deny the specified range of sender IP addresses.

mac

Deny the sender MAC address.

host sender-mac

Deny a specific sender MAC address.

sender-mac sender-mac-mask

Deny the specified range of sender MAC addresses.

response ip

Define the IP address values for the ARP responses.

host target-ip

Deny the specified target IP address.

target-ip target-ip-mask

Deny the specified range of target IP addresses.

mac

Deny the MAC address values for the ARP responses.

host target-mac

Deny the specified target MAC address.

target-mac target-mac-mask

Deny the specified range of target MAC addresses.

log

(Optional) Log a packet when it matches the ACE.


Defaults

There are no default settings. However, at the end of the ARP access list, there is an implicit deny ip any mac any command.

Command Modes

ARP access-list configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You can add deny clauses to drop ARP packets based on matching criteria.

Examples

This example shows how to define an ARP access list and to deny both ARP requests and ARP responses from a host with an IP address of 1.1.1.1 and a MAC address of 0000.0000.abcd:

Switch(config)# arp access-list static-hosts
Switch(config-arp-nacl)# deny ip host 1.1.1.1 mac host 0000.0000.abcd
Switch(config-arp-nacl)# end

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

Related Commands

Command
Description

arp access-list

Defines an ARP access control list (ACL).

ip arp inspection filter vlan

Permits ARP requests and responses from a host configured with a static IP address.

permit (ARP access-list configuration)

Permits an ARP packet based on matches against the DHCP bindings.

show arp access-list

Displays detailed information about ARP access lists.


deny (IPv6 access-list configuration)

Use the deny command in IPv6 access list configuration mode to set deny conditions for an IPv6 access list. Use the no form of this command to remove the deny conditions.

deny {protocol} {source-ipv6-prefix/prefix-length | any | host source-ipv6-address} [operator [port-number]] {destination-ipv6-prefix/prefix-length | any | host destination-ipv6-address} [operator [port-number]] [dscp value] [fragments] [log] [log-input] [routing] [sequence value] [time-range name]

no deny {protocol} {source-ipv6-prefix/prefix-length | any | host source-ipv6-address} [operator [port-number]] {destination-ipv6-prefix/prefix-length | any | host destination-ipv6-address} [operator [port-number]] [dscp value] [fragments] [log] [log-input] [routing] [sequence value] [time-range name]

Internet Control Message Protocol

deny icmp {source-ipv6-prefix/prefix-length | any | host source-ipv6-address} [operator [port-number]] {destination-ipv6-prefix/prefix-length | any | host destination-ipv6-address} [operator [port-number]] [icmp-type [icmp-code] | icmp-message] [dscp value] [log] [log-input] [routing] [sequence value] [time-range name]

Transmission Control Protocol

deny tcp {source-ipv6-prefix/prefix-length | any | host source-ipv6-address} [operator [port-number]] {destination-ipv6-prefix/prefix-length | any | host destination-ipv6-address} [operator [port-number]] [ack] [dscp value] [established] [fin] [log] [log-input] [neq {port | protocol}] [psh] [range {port | protocol}] [rst] [routing] [sequence value] [syn] [time-range name] [urg]

User Datagram Protocol

deny udp {source-ipv6-prefix/prefix-length | any | host source-ipv6-address} [operator [port-number]] {destination-ipv6-prefix/prefix-length | any | host destination-ipv6-address} [operator [port-number]] [dscp value] [log] [log-input] [neq {port | protocol}] [range {port | protocol}] [routing] [sequence value] [time-range name]


Note This command is available only if you have configured a dual IPv4 and IPv6 Switch Database Management (SDM) template on the switch.


Syntax Description

protocol

Name or number of an Internet protocol. It can be one of the keywords ahp, esp, icmp, ipv6, pcp, sctp, tcp, or udp, or an integer in the range from 0 to 255 representing an IPv6 protocol number.

source-ipv6-prefix/prefix-length

The source IPv6 network or class of networks about which to set deny conditions.

This argument must be in the form documented in RFC 2373 where the address is specified in hexadecimal using 16-bit values between colons.

any

An abbreviation for the IPv6 prefix ::/0.

host source-ipv6-address

The source IPv6 host address for which to set deny conditions.

This source-ipv6-address argument must be in the form documented in RFC 2373 where the address is specified in hexadecimal using 16-bit values between colons.

operator [port-number]

(Optional) Specify an operator that compares the source or destination ports of the specified protocol. Operators are lt (less than), gt (greater than), eq (equal), neq (not equal), and range (inclusive range).

If the operator is positioned after the source-ipv6-prefix/prefix-length argument, it must match the source port.

If the operator is positioned after the destination-ipv6-prefix/prefix-length argument, it must match the destination port.

The range operator requires two port numbers. All other operators require one port number.

The optional port-number argument is a decimal number or the name of a TCP or a UDP port. A port number is a number from 0 to 65535. TCP port names can be used only when filtering TCP. UDP port names can be used only when filtering UDP.

destination-ipv6-prefix/
prefix-length

The destination IPv6 network or class of networks for which to set deny conditions.

This argument must be in the form documented in RFC 2373 where the address is specified in hexadecimal using 16-bit values between colons.

host destination-ipv6-address

The destination IPv6 host address for which to set deny conditions.

This destination-ipv6-address argument must be in the form documented in RFC 2373 where the address is specified in hexadecimal using 16-bit values between colons.

dscp value

(Optional) Match a differentiated services code point value against the traffic class value in the Traffic Class field of each IPv6 packet header. The acceptable range is from 0 to 63.

fragments

(Optional) Match non-initial fragmented packets where the fragment extension header contains a non-zero fragment offset. The fragments keyword is an option only if the protocol is ipv6 and the operator [port-number] arguments are not specified.

log

(Optional) Send an informational logging message to the console about the packet that matches the entry. (The level of messages sent to the console is controlled by the logging console command.)

The message includes the access list name and sequence number, whether the packet was denied; the protocol, whether it was TCP, UDP, ICMP, or a number; and, if appropriate, the source and destination addresses and source and destination port numbers. The message is generated for the first packet that matches, and then at 5-minute intervals, including the number of packets denied in the prior 5-minute interval.

Note Logging is not supported for port ACLs.

log-input

(Optional) Provide the same function as the log keyword, but the logging message also includes the receiving interface.

routing

(Optional) Match packets with the routing extension header.

sequence value

(Optional) Specify the sequence number for the access list statement. The acceptable range is from 1 to 4294967295.

time-range name

(Optional) Specify the time range that applies to the deny statement. The name of the time range and its restrictions are specified by the time-range and absolute or periodic commands, respectively.

icmp-type

(Optional) Specify an ICMP message type for filtering ICMP packets. ICMP packets can be filtered by an ICMP message type. The type is a number from 0 to 255.

icmp-code

(Optional) Specify an ICMP message code for filtering ICMP packets. ICMP packets that are filtered by ICMP message type can also be filtered by the ICMP message code. The code is a number from 0 to 255.

icmp-message

(Optional) Specify an ICMP message name for filtering ICMP packets. ICMP packets can be filtered by an ICMP message name or an ICMP message type and code. The possible names are listed in the "Usage Guidelines" section.

ack

(Optional) Only for the TCP protocol: Acknowledgment (ACK) bit set.

established

(Optional) Only for the TCP protocol: Means the connection has been established. A match occurs if the TCP datagram has the ACK or RST bits set. The nonmatching case is that of the initial TCP datagram to form a connection.

fin

(Optional) Only for the TCP protocol: Fin bit set; no more data from sender.

neq {port | protocol}

(Optional) Match only packets that are not on a given port number.

psh

(Optional) Only for the TCP protocol: Push function bit set.

range {port | protocol}

(Optional) Match only packets in the range of port numbers.

rst

(Optional) Only for the TCP protocol: Reset bit set.

syn

(Optional) Only for the TCP protocol: Synchronize bit set.

urg

(Optional) Only for the TCP protocol: Urgent pointer bit set.



Note Although visible in the command-line help strings, the flow-label, routing, and undetermined-transport keywords are not supported.


Defaults

No IPv6 access list is defined.

Command Modes

IPv6 access list configuration

Command History

Release
Modification

12.2(50)SE

This command was introduced.


Usage Guidelines

The deny (IPv6 access-list configuration mode) command is similar to the deny (IPv4 access-list configuration mode) command, but it is IPv6-specific.

Use the deny (IPv6) command after the ipv6 access-list command to enter IPv6 access list configuration mode and to define the conditions under which a packet passes the access list.

Specifying IPv6 for the protocol argument matches the IPv6 header of the packet.

By default, the first statement in an access list is number 10, and the subsequent statements are numbered in increments of 10.

You can add permit, deny, or remark statements to an existing access list without re-entering the entire list. To add a new statement somewhere other than at the end of the list, create a new statement with an appropriate entry number between two existing entry numbers to show where it belongs.


Note Every IPv6 ACL has implicit permit icmp any any nd-na, permit icmp any any nd-ns, and deny ipv6 any any statements as its last match conditions. The two permit conditions allow ICMPv6 neighbor discovery. To disallow ICMPv6 neighbor discovery and to deny icmp any any nd-na or icmp any any nd-ns, there must be an explicit deny entry in the ACL. For the three implicit statements to take effect, an IPv6 ACL must contain at least one entry.

The IPv6 neighbor discovery process uses the IPv6 network layer service. Therefore, by default, IPv6 ACLs implicitly allow IPv6 neighbor discovery packets to be sent and received on an interface. In IPv4, the Address Resolution Protocol (ARP), which is equivalent to the IPv6 neighbor discovery process, uses a separate data-link layer protocol. Therefore, by default, IPv4 ACLs implicitly allow ARP packets to be sent and received on an interface.


Both the source-ipv6-prefix/prefix-length and destination-ipv6-prefix/prefix-length arguments are used for traffic filtering. (The source prefix filters traffic based upon its source; the destination prefix filters traffic based upon its destination.)

The switch supports IPv6 address matching for a full range of prefix lengths.

The fragments keyword is an option only if the protocol is ipv6 and the operator [port-number] arguments are not specified.

This is a list of ICMP message names:

beyond-scope

destination-unreachable

echo-reply

echo-request

header

hop-limit

mld-query

mld-reduction

mld-report

nd-na

nd-ns

next-header

no-admin

no-route

packet-too-big

parameter-option

parameter-problem

port-unreachable

reassembly-timeout

renum-command

renum-result

renum-seq-number

router-advertisement

router-renumbering

router-solicitation

time-exceeded

unreachable

 

Examples

This example configures the IPv6 access list named CISCO and applies the access list to outbound traffic on a Layer 3 interface. The first deny entry prevents all packets that have a destination TCP port number greater than 5000 from leaving the interface. The second deny entry prevents all packets that have a source UDP port number less than 5000 from leaving the interface. The second deny also logs all matches to the console. The first permit entry permits all ICMP packets to leave the interface. The second permit entry permits all other traffic to leave the interface. The second permit entry is necessary because an implicit deny-all condition is at the end of each IPv6 access list.

Switch(config)# ipv6 access-list CISCO
Switch(config-ipv6-acl)# deny tcp any any gt 5000
Switch config-ipv6-acl)# deny ::/0 lt 5000 ::/0 log
Switch(config-ipv6-acl)# permit icmp any any
Switch(config-ipv6-acl)# permit any any
Switch(config-ipv6-acl)# exit
Switch(config)# interface gigabitethernet0/2
Switch(config-if)# no switchport
Switch(config-if)# ipv6 address 2001::/64 eui-64
Switch(config-if)# ipv6 traffic-filter CISCO out

Related Commands

Command
Description

ipv6 access-list

Defines an IPv6 access list and enters IPv6 access list configuration mode.

ipv6 traffic-filter

Filters incoming or outgoing IPv6 traffic on an interface.

permit (IPv6 access-list configuration)

Sets permit conditions for an IPv6 access list.

show ipv6 access-list

Displays the contents of all current IPv6 access lists.


deny (MAC access-list configuration)

Use the deny MAC access-list configuration command to prevent non-IP traffic from being forwarded if the conditions are matched. Use the no form of this command to remove a deny condition from the named MAC access list.

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

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

Syntax Description

any

Keyword to specify to deny any source or destination MAC address.

host src MAC-addr |
src-MAC-addr mask

Define a host MAC address and optional subnet mask. If the source address for a packet matches the defined address, non-IP traffic from that address is denied.

host dst-MAC-addr |
dst-MAC-addr mask

Define a destination MAC address and optional subnet mask. If the destination address for a packet matches the defined address, non-IP traffic to that address is denied.

type mask

(Optional) Use the Ethertype number of a packet with Ethernet II or SNAP encapsulation to identify the protocol of the packet.

The type is 0 to 65535, specified in hexadecimal.

The mask is a mask of don't care bits applied to the Ethertype before testing for a match.

aarp

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

amber

(Optional) Select EtherType DEC-Amber.

cos cos

(Optional) Select a class of service (CoS) number from 0 to 7 to set priority. Filtering on CoS can be performed only in hardware. A warning message reminds the user if the cos option is configured.

dec-spanning

(Optional) Select EtherType Digital Equipment Corporation (DEC) spanning tree.

decnet-iv

(Optional) Select EtherType DECnet Phase IV protocol.

diagnostic

(Optional) Select EtherType DEC-Diagnostic.

dsm

(Optional) Select EtherType DEC-DSM.

etype-6000

(Optional) Select EtherType 0x6000.

etype-8042

(Optional) Select EtherType 0x8042.

lat

(Optional) Select EtherType DEC-LAT.

lavc-sca

(Optional) Select EtherType DEC-LAVC-SCA.

lsap lsap-number mask

(Optional) Use the LSAP number (0 to 65535) of a packet with IEEE 802.2 encapsulation to identify the protocol of the packet.

mask is a mask of don't care bits applied to the LSAP number before testing for a match.

mop-console

(Optional) Select EtherType DEC-MOP Remote Console.

mop-dump

(Optional) Select EtherType DEC-MOP Dump.

msdos

(Optional) Select EtherType DEC-MSDOS.

mumps

(Optional) Select EtherType DEC-MUMPS.

netbios

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

vines-echo

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

vines-ip

(Optional) Select EtherType VINES IP.

xns-idp

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



Note Though visible in the command-line help strings, appletalk is not supported as a matching condition.


To filter IPX traffic, you use the type mask or lsap lsap mask keywords, depending on the type of IPX encapsulation being used. Filter criteria for IPX encapsulation types as specified in Novell terminology and Cisco IOS terminology are listed in Table 2-1.

Table 2-1 IPX Filtering Criteria

IPX Encapsulation Type
Filter Criterion
Cisco IOS Name
Novel Name

arpa

Ethernet II

Ethertype 0x8137

snap

Ethernet-snap

Ethertype 0x8137

sap

Ethernet 802.2

LSAP 0xE0E0

novell-ether

Ethernet 802.3

LSAP 0xFFFF


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

This command was introduced.


Usage Guidelines

You enter MAC-access list configuration mode by using the mac access-list extended global configuration command.

If you use the host keyword, you cannot enter an address mask; if you do not use the host keyword, you must enter an address mask.

When an access control entry (ACE) is added to an access control list, 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.


Note For more information about named MAC extended access lists, see the software configuration guide for this release.


Examples

This example shows how to define the named MAC extended access list 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 access list:

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

This example denies all packets with Ethertype 0x4321:

Switch(config-ext-macl)# deny any any 0x4321 0

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

Related Commands

Command
Description

mac access-list extended

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

permit (MAC access-list configuration)

Permits non-IP traffic to be forwarded if conditions are matched.

show access-lists

Displays access control lists configured on a switch.


diagnostic monitor

Use the diagnostic monitor global configuration command to configure health-monitoring diagnostic testing. Use the no form of this command to disable testing and to return to the default settings.

diagnostic monitor interval test {name | test-id | test-id-range | all} hh:mm:ss milliseconds day

diagnostic monitor test {name | test-id | test-id-range | all}

diagnostic monitor syslog

diagnostic monitor threshold test {name | test-id | test-id-range | all} failure count count

no diagnostic monitor interval test {name | test-id | test-id-range | all}

no diagnostic monitor test {name | test-id | test-id-range | all}

no diagnostic monitor syslog

no diagnostic monitor threshold test {name | test-id | test-id-range | all} failure count count

Syntax Description

interval test

Configure the interval between tests.

test

Specify the tests to be run.

name

Specify the test name. To display the test names in the test-ID list, enter the show diagnostic content privileged EXEC command.

test-id

Specify the ID number of the test. The range is from 1 to 6. To display the test numbers in the test-ID list, enter the show diagnostic content privileged EXEC command.

test-id-range

Specify more than one test with the range of test ID numbers. Enter the range as integers separated by a comma and a hyphen (for example, 1,3-6 specifies test IDs 1, 3, 4, 5, and 6). To display the test numbers in the test-ID list, enter the show diagnostic content privileged EXEC command.

all

Specify all of the diagnostic tests.

hh:mm:ss

Configure the monitoring interval in hours, minutes, and seconds.

hh—Enter the hours from 0 to 24.

mm—Enter the minutes from 0 to 60.

ss—Enter the seconds from 0 to 60.

milliseconds

Configure the monitoring interval (test time) in milliseconds (ms). The range is from 0 to 999 ms.

day

Configure the monitoring interval in the number of days between tests. The range is from 0 to 20 days.

syslog

Enable the generation of a syslog message when a health-monitoring test fails.

threshold test

Configure the failure threshold.

failure count count

Set the failure threshold count. The range for count is from 0 to 99.


Defaults

Monitoring is disabled, and a failure threshold value is not set.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You must configure the failure threshold and the interval between tests before enabling diagnostic monitoring.

Enter the diagnostic monitor test 1 command to enable diagnostic monitoring.

When you enter the diagnostic monitor test {name | test-id | test-id-range | all} command, you must isolate network traffic by disabling all connected ports.

Do not send test packets during the test.

Examples

This example shows how to configure a health-monitoring test:

Switch(config)# diagnostic monitor threshold test 1 failure count 20
Switch(config)# diagnostic monitor interval test 1 12:30:00 750 5

Related Commands

Command
Description

show diagnostic

Displays online diagnostic test results.


diagnostic schedule test

Use the diagnostic schedule test global configuration command to configure the diagnostic test schedule. Use the no form of this command to remove the schedule.

diagnostic schedule test {name | test-id | test-id-range | all | basic | non-disruptive} {daily hh:mm | on mm dd yyyy hh:mm | weekly day-of-week hh:mm}

no diagnostic schedule test {name | test-id | test-id-range | all | basic | non-disruptive} {daily hh:mm | on mm dd yyyy hh:mm | weekly day-of-week hh:mm}

Syntax Description

name

Specify the name of the test. To display the test names in the test-ID list, enter the show diagnostic content privileged EXEC command.

test-id

Specify the ID number of the test. The range is from 1 to 6. To display the test numbers in the test-ID list, enter the show diagnostic content privileged EXEC command.

test-id-range

Specify more than one test with the range of test ID numbers. Enter the range as integers separated by a comma and a hyphen (for example, 1,3-6 specifies test IDs 1, 3, 4, 5, and 6). To display the test numbers in the test-ID list, enter the show diagnostic content privileged EXEC command.

all

Specify all of the diagnostic tests.

basic

Specify the basic on-demand diagnostic tests.

non-disruptive

Specify the nondisruptive health-monitoring tests.

daily hh:mm

Specify the daily scheduling of the diagnostic tests.

hh:mm—Enter the time as a 2-digit number (for a 24-hour clock) for hours:minutes; the colon (:) is required, such as 12:30.

on mm dd yyyy hh:mm

Specify the scheduling of the diagnostic tests on a specific day and time.

For mm dd yyyy:

mm—Spell out the month, such as January, February, and so on, with upper-case or lower-case characters.

dd—Enter the day as a 2-digit number, such as 03 or 16.

yyyy—Enter the year as a 4-digit number, such as 2008.

weekly day-of-week hh:mm

Specify the weekly scheduling of the diagnostic tests.

day-of-week—Spell out the day of the week, such as Monday, Tuesday, and so on, with upper-case or lower-case characters.


Defaults

This command has no default settings.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Examples

This example shows how to schedule diagnostic testing for a specific day and time:

Switch(config)# diagnostic schedule test 1,2,4-6 on november 3 2006 23:10

This example shows how to schedule diagnostic testing to occur weekly at a specific time :

Switch(config)# diagnostic schedule test TestPortAsicMem weekly friday 09:23

Related Commands

Command
Description

show diagnostic

Displays online diagnostic test results.


diagnostic start test

Use the diagnostic start test privileged EXEC command to run an online diagnostic test.

diagnostic start test {name | test-id | test-id-range | all | basic | non-disruptive}

Syntax Description

name

Specify the name of the test. To display the test names in the test-ID list, enter the show diagnostic content privileged EXEC command.

test-id

Specify the ID number of the test. The range is from 1 to 6. To display the test numbers in the test-ID list, enter the show diagnostic content privileged EXEC command.

test-id-range

Specify more than one test with the range of test ID numbers. Enter the range as integers separated by a comma and a hyphen (for example, 1,3-6 specifies test IDs 1, 3, 4, 5, and 6). To display the test numbers in the test-ID list, enter the show diagnostic content privileged EXEC command.

all

Specify all the diagnostic tests.

basic

Specify the basic on-demand diagnostic tests.

non-disruptive

Specify the nondisruptive health-monitoring tests.


Defaults

This command has no default setting.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

After you start the tests by using the diagnostic start command, you cannot stop the testing process.

The switch supports these tests:

ID   Test Name [On-Demand Test Attributes]
---  -------------------------------------------
1    TestPortAsicStackPortLoopback    [B*N****]
2    TestPortAsicLoopback             [B*D*R**]
3    TestPortAsicCam                  [B*D*R**]
4    TestPortAsicRingLoopback         [B*D*R**]
5    TestMicRingLoopback              [B*D*R**]
6    TestPortAsicMem                  [B*D*R**]
---  -------------------------------------------

To identify a test name, use the show diagnostic content privileged EXEC command to display the test ID list. To specify test 3 by using the test name, enter the diagnostic start switch number test TestPortAsicCam privileged EXEC command.

To specify more than one test, use the test-id-range parameter, and enter integers separated by a comma and a hyphen. For example, to specify tests 2, 3, and 4, enter the diagnostic start test 2-4 command. To specify tests 1, 3, 4, 5, and 6, enter the diagnostic start test 1,3-6 command.

Examples

This example shows how to start diagnostic test 1:

Switch# diagnostic start test 1
Switch#
06:27:50: %DIAG-6-TEST_RUNNING: Running TestPortAsicStackPortLoopback{ID=1} ...
06:27:51: %DIAG-6-TEST_OK: TestPortAsicStackPortLoopback{ID=1} has completed
successfully 

This example shows how to start diagnostic test 2. Running this test disrupts the normal system operation and then reloads the switch.

Switch# diagnostic start test 2
Running test(s) 2 will cause the switch under test to reload after completion of
the test list.
Running test(s) 2 may disrupt normal system operation
Do you want to continue? [no]: y
Switch#
00:00:25: %SPANTREE-5-EXTENDED_SYSID: Extended SysId enabled for type vlan 
00:00:29: %SYS-5-CONFIG_I: Configured from memory by console 
00:00:30: %DIAG-6-TEST_RUNNING : Running TestPortAsicLoopback{ID=2} ...
00:00:30: %DIAG-6-TEST_OK: TestPortAsicLoopback{ID=2} has completed successfully

Related Commands

Command
Description

show diagnostic

Displays online diagnostic test results.


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-port 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.2(44)EY

This command was introduced.


Examples

This example shows how to reset the configurable IEEE 802.1x parameters on a port:

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


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]


Note Although visible in the command-line interface help, the multi-domain keyword is not supported.


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

This command was introduced.


Usage Guidelines

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

The dot1x host-mode multi-domain interface configuration command is not supported on the switch. Configuring this command on an interface causes the interface to go into the error-disabled state.

Examples

This example shows how to enable IEEE 802.1x globally, to enable IEEE 802.1x on a port, and to enable multiple-hosts mode:

Switch(config)# dot1x system-auth-control
Switch(config)# interface gigabitethernet0/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 port.


dot1x initialize

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

dot1x initialize interface interface-id

Syntax Description

interface interface-id

Port to be initialized.


Defaults

There is no default setting.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Use this command to initialize the IEEE 802.1x state machines and to set up a fresh environment for authentication. After you enter this command, the port status becomes unauthorized.

There is no no form of this command.

Examples

This example shows how to manually initialize a port:

Switch# dot1x initialize interface gigabitethernet0/2

You can verify the unauthorized port status 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 port.


dot1x max-reauth-req

Use the dot1x max-reauth-req interface configuration command to set the maximum number of times that the switch restarts the authentication process before a port transitions to the unauthorized state. Use the no form of this command to return to the default setting.

dot1x max-reauth-req count

no dot1x max-reauth-req

Syntax Description

count

Number of times that the switch restarts the authentication process before the port transitions to the unauthorized state. The range is 1 to 10.


Defaults

The default is 2 times.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


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 4 as the number of times that the switch restarts the authentication process before the port transitions to the unauthorized state:

Switch(config-if)# dot1x max-reauth-req 4

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 forwards an EAP frame (assuming that no response is received) to the authentication server before restarting the authentication process.

dot1x timeout tx-period

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


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 resends an EAP frame from the authentication server before restarting the authentication process. The range is 1 to 10.


Defaults

The default is 2 times.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


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 from the authentication server 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 tx-period

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


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 port and cause the port to change 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 port and cause the port to change to the authorized state without an authentication exchange. The port sends and receives normal traffic without IEEE 802.1x-based authentication of the client.

force-unauthorized

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


Defaults

The default is force-authorized.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

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

The IEEE 802.1x protocol is supported on Layer 2 static-access ports and Layer 3 routed 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 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, an error message appears, and the port mode is not changed.

Dynamic-access ports—If you try to enable IEEE 802.1x on a dynamic-access (VLAN Query Protocol [VQP]) port, an error message appears, and IEEE 802.1x 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 on an EtherChannel port, an error message appears, and IEEE 802.1x is not enabled.

Switched Port Analyzer (SPAN) and Remote SPAN (RSPAN) destination ports—You can enable IEEE 802.1x on a port that is a SPAN or RSPAN destination port. However, IEEE 802.1x is disabled until the port is removed as a SPAN or RSPAN destination. You can enable IEEE 802.1x on a SPAN or RSPAN source port.

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

Examples

This example shows how to enable IEEE 802.1x on a port:

Switch(config)# interface gigabitethernet0/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 port.


dot1x re-authenticate

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

dot1x re-authenticate interface interface-id

Syntax Description

interface interface-id

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


Defaults

There is no default setting.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

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 a port:

Switch# dot1x re-authenticate interface gigabitethernet0/1

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

This command was introduced.


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 reauth-period

Sets the number of seconds between re-authentication attempts.

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified port.


dot1x system-auth-control

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

dot1x system-auth-control

no dot1x system-auth-control

Syntax Description

This command has no arguments or keywords.

Defaults

IEEE 802.1x is disabled.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

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

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

Examples

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

Switch(config)# dot1x system-auth-control

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

Related Commands

Command
Description

dot1x port-control

Enables manual control of the authorization state of the port.

show dot1x [interface interface-id]

Displays IEEE 802.1x status for the specified port.


dot1x test eapol-capable

Use the dot1x test eapol-capable privileged EXEC command to monitor IEEE 802.1x activity on all the switch ports and to display information about the devices that are connected to the ports that support IEEE 802.1x.

dot1x test eapol-capable [interface interface-id]

Syntax Description

interface interface-id

(Optional) Port to be queried.


Defaults

There is no default setting.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Use this command to test the IEEE 802.1x capability of the devices connected to all ports or to specific ports on a switch.

There is not a no form of this command.

Examples

This example shows how to enable the IEEE 802.1x readiness check on a switch to query a port. It also shows the response received from the queried port verifying that the device connected to it is IEEE 802.1x-capable:

switch# dot1x test eapol-capable interface gigabitethernet1/0/13

DOT1X_PORT_EAPOL_CAPABLE:DOT1X: MAC 00-01-02-4b-f1-a3 on gigabitethernet1/0/13 is EAPOL 
capable

Related Commands

Command
Description

dot1x test timeout timeout

Configures the timeout used to wait for EAPOL response to an IEEE 802.1x readiness query.


dot1x test timeout

Use the dot1x test timeout global configuration command to configure the timeout used to wait for EAPOL response from a port being queried for IEEE 802.1x readiness.

dot1x test timeout timeout

Syntax Description

timeout

Time in seconds to wait for an EAPOL response. The range is from 1 to 65535 seconds.


Defaults

The default setting is 10 seconds.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Use this command to configure the timeout used to wait for EAPOL response.

There is not a no form of this command.

Examples

This example shows how to configure the switch to wait 27 seconds for an EAPOL response:

Switch# dot1x test timeout 27

You can verify the timeout configuration status by entering the show run privileged EXEC command.

Related Commands

Command
Description

dot1x test eapol-capable [interface interface-id]

Checks for IEEE 802.1x readiness on devices connected to all or to specified IEEE 802.1x-capable ports.


dot1x timeout

Use the dot1x timeout interface configuration command to set 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-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

Number of seconds between re-authentication attempts. The range is 1 to 65535.

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 30 to 65535.

supp-timeout seconds

Number of seconds that the switch waits for the retransmission of packets by the switch to the IEEE 802.1x client. The range is 30 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 default settings:

reauth-period is 3600 seconds.

quiet-period is 60 seconds.

tx-period is 30 seconds.

supp-timeout is 30 seconds.

server-timeout is 30 seconds.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


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.

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 4000 as the number of seconds between re-authentication attempts:

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

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

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

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

Switch(config)# dot1x timeout server-timeout 45

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

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

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

You can verify your settings by entering the show dot1x 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

Displays IEEE 802.1x status for all ports.


dot1x violation-mode

Use the dot1x violation-mode interface configuration command to configure the violation modes that occur when a new device connects to a port or when a new device connects to a port after the maximum number of devices are connected to that port.

dot1x violation-mode {shutdown | restrict | protect}

no dot1x violation-mode

Syntax Description

shutdown

Error disables the port or the virtual port on which a new unexpected MAC address occurs.

restrict

Generates a syslog error when a violation error occurs.

protect

Silently discards packets from any new MAC addresses. This is the default setting.


Defaults

By default dot1x violation-mode protect is enabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Examples

This example shows how to configure an IEEE 802.1x-enabled port as error disabled and to shut down when a new device connects to the port:

Switch(config-if)# dot1x violation-mode shutdown

This example shows how to configure an IEEE 802.1x-enabled port to generate a system error message and change the port to restricted mode when a new device connects to the port:

Switch(config-if)# dot1x violation-mode restrict

This example shows how to configure an IEEE 802.1x-enabled port to ignore a new connected device when it is connected to the port:

Switch(config-if)# dot1x violation-mode protect

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


duplex

Use the duplex interface configuration command to specify the duplex mode of operation for a port. Use the no form of this command to return the port to its default value.

duplex {auto | full | half}

no duplex

Syntax Description

auto

Enable automatic duplex configuration; port automatically detects whether it should run in full- or half-duplex mode, depending on the attached device mode.

full

Enable full-duplex mode.

half

Enable half-duplex mode (only for interfaces operating at 10 Mbps or 100 Mbps). You cannot configure half-duplex mode for interfaces operating at 1000 Mbps or 10,000 Mbps.


Defaults

The default is auto for Fast Ethernet and Gigabit Ethernet ports and for 1000BASE-T small form-factor pluggable (SFP) modules.

The default is half for 100BASE-FX MMF SFP modules.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

This command is only available when a 1000BASE-T SFP module or a 100BASE-FX MMF SFP module is in the SFP module slot. All other SFP modules operate only in full-duplex mode.

When a 1000BASE-T SFP module is in the SFP module slot, you can configure duplex mode to auto or full.

When a 100BASE-FX MMF SFP module is in the SFP module slot, you can configure duplex mode to half or full. Although the auto keyword is available, it puts the interface in half-duplex mode (the default) because the 100BASE-FX MMF SFP module does not support autonegotiation.

Certain ports can be configured to be either full duplex or half duplex. Applicability of this command depends on the device to which the switch is attached.

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.

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


Note Half-duplex mode is supported on Gigabit Ethernet interfaces if duplex mode is auto and the connected device is operating at half duplex. However, you cannot configure these interfaces to operate in half-duplex mode.


If both ends of the line support autonegotiation, we highly recommend using the default autonegotiation settings. If one interface supports autonegotiation and the other end does not, configure duplex and speed on both interfaces; do use the auto setting on the supported side.

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.

You can configure the duplex setting when the speed is set to auto.


Caution Changing the interface speed and duplex mode configuration might shut down and re-enable the interface during the reconfiguration.


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 configure an interface for full duplex operation:

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

You can verify your setting by entering the show interfaces privileged EXEC command.

Related Commands

Command
Description

show interfaces

Displays the interface settings on the switch.

speed

Sets the speed on a 10/100 or 10/100/1000 Mbps interface.


errdisable detect cause

Use the errdisable detect cause global configuration command to enable error-disabled detection for a specific cause or all causes. Use the no form of this command to disable the error-disabled detection feature.

errdisable detect cause {all | arp-inspection | dhcp-rate-limit | gbic-invalid | l2ptguard | link-flap | loopback | pagp-flap | small-frame}

no errdisable detect cause {all | arp-inspection | dhcp-rate-limit | gbic-invalid | l2ptguard | link-flap | pagp-flap | small-frame}


Note



Note Although visible in the command line interface, small-frame keyword is not needed on the switch because the existing broadcast storm disable feature correctly handles small frames.


Syntax Description

all

Enable error detection for all error-disable causes.

arp-inspection

Enable error detection for dynamic Address Resolution Protocol (ARP) inspection.

dhcp-rate-limit

Enable error detection for DHCP snooping.

gbic-invalid

Enable error detection for an invalid Gigabit Interface Converter (GBIC) module.

Note This error refers to an invalid small form-factor pluggable (SFP) module.

l2ptguard

Enable error detection for a Layer 2 protocol-tunnel error-disabled cause.

link-flap

Enable error detection for link-state flapping.

loopback

Enable error detection for detected loopbacks.

pagp-flap

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

small-frame

This feature is not required on the switch.


Defaults

Detection is enabled for all causes. All causes, except for per-VLAN error disabling, are configured to shut down the entire port.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

A cause (all, dhcp-rate-limit, and so forth) is the reason why the error-disabled state occurred. When a cause is detected on an interface, the interface is placed in an error-disabled state, an operational state that is similar to a link-down state.

When a port is error-disabled, it is effectively shut down, and no traffic is sent or received on the port. For the BPDU guard and port-security features, you can configure the switch to shut down just the offending VLAN on the port when a violation occurs, instead of shutting down the entire port.

If you set a recovery mechanism for the cause by entering the errdisable recovery global configuration command for the cause, the interface is brought out of the error-disabled state and allowed to retry the operation when all causes have timed out. If you do not set a recovery mechanism, 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-disabled detection for the link-flap error-disabled cause:

Switch(config)# errdisable detect cause link-flap

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

Related Commands

Command
Description

show errdisable detect

Displays errdisable detection information.

show interfaces status err-disabled

Displays interface status or a list of interfaces in the 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 | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit | gbic-invalid | l2ptguard | link-flap | loopback | pagp-flap | psecure-violation | security-violation | small-frame | udld |unicast-flood | vmps} | {interval interval}

no errdisable recovery {cause {all | arp-inspection | bpduguard | channel-misconfig | dhcp-rate-limit | gbic-invalid | l2ptguard | link-flap | loopback | pagp-flap | psecure-violation | security-violation | small-frame | udld |unicast-flood | vmps} | {interval interval}


Note Although visible in the command-line help strings, the storm-control and unicast-flood keywords are not supported. The small-frame keyword is not used because the broadcast-storm disable feature processes small frames


Syntax Description

cause

Enable the error-disabled mechanism to recover from a specific cause.

all

Enable the timer to recover from all error-disabled causes.

bpduguard

Enable the timer to recover from the bridge protocol data unit (BPDU) guard error-disabled state.

arp-inspection

Enable the timer to recover from the Address Resolution Protocol (ARP) inspection error-disabled state.

channel-misconfig

Enable the timer to recover from the EtherChannel misconfiguration error-disabled state.

dhcp-rate-limit

Enable the timer to recover from the DHCP snooping error-disabled state.

gbic-invalid

Enable the timer to recover from an invalid Gigabit Interface Converter (GBIC) module error-disabled state.

Note This error refers to an invalid small form-factor pluggable (SFP) error-disabled state.

l2ptguard

Enable the timer to recover from a Layer 2 protocol tunnel error-disabled state.

link-flap

Enable the timer to recover from the link-flap error-disabled state.

loopback

Enable the timer to recover from a loopback error-disabled state.

pagp-flap

Enable the timer to recover from the Port Aggregation Protocol (PAgP)-flap error-disabled state.

psecure-violation

Enable the timer to recover from a port security violation disabled state.

security-violation

Enable the timer to recover from an IEEE 802.1x-violation disabled state.

small-frame

This keyword is not used.

udld

Enable the timer to recover from the UniDirectional Link Detection (UDLD) error-disabled state.

unicast-flood

Enable the timer to recover from the unicast flood disable state.

vmps

Enable the timer to recover from the VLAN Membership Policy Server (VMPS) error-disabled state.

interval interval

Specify the time to recover from the specified error-disabled state. The range is 30 to 86400 seconds. The same interval is applied to all causes. The default interval is 300 seconds.

Note The error-disabled recovery timer is initialized 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.


Defaults

Recovery is disabled for all causes.

The default recovery interval is 300 seconds.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

A cause (all, bpduguard and so forth) is defined as the reason that 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 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-disabled 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 err-disabled

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


ethernet evc

Use the ethernet evc global configuration command to define an Ethernet virtual connection (EVC) and to enter EVC configuration mode. Use the no form of this command to delete the EVC.

ethernet evc evc-id

no ethernet evc evc-id

Syntax Description

evc-id

The EVC identifier. This can be a string of from 1 to 100 characters.


Defaults

No EVCs are defined.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

After you enter the ethernet evc evc-id command, the switch enters EVC configuration mode, and these configuration commands are available:

default: sets the EVC to its default states.

exit: exits EVC configuration mode and returns to global configuration mode.

no: negates a command or returns a command to its default setting.

oam protocol cfm svlan: configures the Ethernet operation, administration, and maintenance (OAM) protocol as IEEE 802.1ag Connectivity Fault Management (CFM) and sets parameters. See the oam protocol cfm svlan command.

uni count: configures a UNI count for the EVC. See the uni count command.

Examples

This example shows how to define an EVC and to enter EVC configuration mode:

Switch(config)# ethernet evc test1
Switch(config-evc)#

Related Commands

Command
Description

service instance id ethernet evc-id

Configures an Ethernet service instance and attaches an EVC to it.

show ethernet service evc

Displays information about configured EVCs.


ethernet lmi

Use the ethernet lmi global configuration command to configure enable Ethernet Local Management Interface (E-LMI) and to configure the switch as a provider-edge (PE) or customer-edge (CE) device. Use the no form of this command to disable E-LMI globally or to disable E-LMI CE.

ethernet lmi {ce | global}

no ethernet lmi {ce | global}

Syntax Description

Defaults

Ethernet LMI is disabled. When enabled with the global keyword, by default the switch is a PR device.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Use ethernet lmi global command to enable E-LMI globally. Use ethernet lmi ce command to enable the switch as E-LMI CE device.

Ethernet LMI is disabled by default on an interface and must be explicitly enabled by entering the ethernet lmi interface interface configuration command. The ethernet lmi global command enables Ethernet LMI in PE mode on all interfaces for an entire device. The benefit of this command is that you can enable Ethernet LMI on all interfaces with one command instead of enabling Ethernet LMI separately on each interface. To enable the interface in CE mode, you must also enter the ethernet lmi ce global configuration command.

To disable Ethernet LMI on a specific interface after you have entered the ethernet lmi global command, enter the no ethernet lmi interface interface configuration command.

The sequence in which you enter the ethernet lmi interface interface configuration and ethernet lmi global global configuration commands is important. The latest command entered overrides the prior command entered.


Note For information about the ethernet lmi interface configuration command, see the Cisco IOS Carrier Ethernet Command Reference at this URL:
http://www.cisco.com/en/US/docs/ios/cether/command/reference/ce_book.html


To enable the switch as an Ethernet LMI CE device, you must enter both the ethernet lmi global and ethernet lmi ce commands. By default Ethernet LMI is disabled, and, when enabled the switch is in provider-edge mode unless you also enter the ethernet lmi ce command.

When the switch is configured as an Ethernet LMI CE device, these interface configuration commands and keywords are visible, but not supported:

service instance

ethernet uni

ethernet lmi t392

Examples

This example shows how to configure the switch as an Ethernet LMI CE device:

Switch(config)# ethernet lmi global
Switch(config)# ethernet lmi ce

Related Commands

Command
Description

ethernet lmi interface configuration command

Enables Ethernet LMI for a user-network interface.


ethernet lmi ce-vlan map

Use the ethernet lmi ce-vlan map Ethernet service configuration command to configure Ethernet Local Management Interface (E-LMI) parameters. Use the no form of this command to remove the configuration.

ethernet lmi ce-vlan map {vlan-id | any | default | untagged}

no ethernet lmi ce-vlan map {vlan-id | any | default | untagged}

Syntax Description

vlan-id

Enter the customer VLAN ID or VLAN IDs to map to. You can enter a single VLAN ID (the range is 1 to 4094), a range of VLAN IDs separated by a hyphen, or a series of VLAN IDs separated by commas.

any

Map all VLANs (untagged and VLANs 1 to 4094).

default

Map to the default service instance. You can use the default keyword only if you have already mapped the service instance to a VLAN or a group of VLANs.

untagged

Map only untagged VLANs.


Defaults

No E-LMI mapping parameters are defined.

Command Modes

Ethernet service configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Use this command to configure an E-LMI customer VLAN-to-EVC map for a particular user-network interface (UNI).

On an ME-3400E interface configured for VLAN mapping, use the customer VLAN ID (C-VLAN) value when entering the ethernet lmi ce-vlan map vlan-id service instance configuration mode command. Do not use the service-provider VLAN ID (S-VLAN).

E-LMI mapping parameters are related to the bundling characteristics set by entering the ethernet uni {bundle [all-to-one] | multiplex} interface configuration command.

Using the default UNI attribute (bundling and multiplexing) supports multiple EVCs and multiple VLANs.

Entering the ethernet uni bundle command supports only one EVC with one or more VLANs.

Entering the ethernet uni bundle all-to-one command supports multiple VLANs but only one EVC. If you use the ethernet lmi ce-vlan map any Ethernet service configuration command, you must first configure all-to-one bundling on the interface.

Entering the ethernet uni multiplex command supports multiple EVCs with only one VLAN per EVC.

Examples

This example shows how to configure an E-LMI customer VLAN-to-EVC map to map EVC test to customer VLAN 101 in service instance 333 on the interface:

Switch(config-if)# service instance 333 ethernet test
Switch(config-if-srv)# ethernet lmi ce-vlan map 101

Related Commands

Command
Description

service instance id ethernet

Defines an Ethernet service instance and enters Ethernet service configuration mode.

show ethernet service instance

Displays information about configured Ethernet service instances.


ethernet loopback (interface configuration)

Use the ethernet loopback facility interface configuration command to configure per-port loopbacks for testing connectivity across multiple switches. Use the ethernet loopback terminal interface configuration command to test quality of service (QoS). Use the no form of this command to remove the configuration.

ethernet loopback facility [vlan vlan-list] [mac-address {swap | copy}] [timeout {seconds | none}] supported

ethernet loopback terminal [mac-address {swap | copy}] [timeout {seconds | none}] supported

no ethernet loopback

Syntax Description

facility

Configure a facility loopback for connectivity testing.

vlan vlan-list

Configure VLAN loopback for nondisruptive loopback testing.

terminal

Configure a terminal loopback for QoS testing.

mac-address swap

Configure the switch to swap the MAC source and destination addresses for the loopback action.

mac-address copy

Configure the switch to copy the MAC source and destination addresses for the loopback action.

timeout seconds

Configure a loopback timeout period in seconds. The range is from 5 to 300 seconds. The default is 60 seconds.

timeout none

Configure the loop back to not timeout.

supported

Specify that the configured loopback is supported.


Defaults

No loopbacks are configured. If no mac-address option is configured, the default is to copy the source and destination addresses.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.

12.2(50)SE

The vlan and terminal keywords were added.


Usage Guidelines

You can configure Ethernet loopback only on physical ports, not on VLANs or port channels.

A facility loopback puts the port into a state where the link is up, but the line protocol is down for regular traffic. The switch loops back all received traffic.

When you configure VLAN loopback by entering the vlan vlan-list keywords, the other VLANs on the port continue to be switched normally, allowing non-disruptive loopback testing.

The loopback ends after a port event, such as a port shutdown or a change from a switchport to a routed port.

For a terminal loopback, the software sees the port as up, but the link is down, and no packets are sent. Any configuration changes on the port immediately affect the traffic being looped back.

You can configure one loopback per port, and a maximum of two loopbacks per switch. You can configure only on terminal loopback per switch. Therefore, a switch could have one facility loopback and one terminal loopback or two facility loopbacks.

Ethernet loopback interactions with other features:

You cannot configure SPAN and loopback on a switch at the same time. If you try to configure SPAN on any port while loopback is configured on any port, you receive an error message.

The port loopback function shares hardware resources with the VLAN-mapping feature. If not enough TCAM resources are available because of VLAN-mapping configuration, when you attempt to configure loopback, you receive an error message, and the configuration is not allowed.

If loopback is active on a port, you cannot add that port to a Flex Link pair or to an Ether Channel.

After you have configured Ethernet loopback, you enter the ethernet loopback start interface-id privileged EXEC command to begin the loopback. To stop loopback, enter the ethernet loopback stop {interface-id | all} command.

Examples

This example shows how to configure an Ethernet loopback to swap the MAC source and destination addresses, to time out after 30 seconds, to start the loopback process,and to verify the configuration. You must confirm the action before configuring.

Switch(config)# interface gigabitethernet 0/1
Switch(config-if)# ethernet loopback facility mac-address swap timeout 30 supported
Switch(config-if)# end
Switch# ethernet loopback start gigabitethernet 0/1
This is an intrusive loopback.
Therefore, while you test Ethernet connectivity,
you will be unable to pass traffic across that link.
Proceed with Local Loopback? [confirm]

Switch# show ethernet loopback
=====================================
Loopback Session 0  : Interface GI0/1
Direction           : facility
Type                : port
Status              : active
MAC Mode            : swap
Time out            : 30
Time remaining      : 25 seconds

This example shows how to also configure a nondisruptive loopback on a second interface:
Switch(config)# interface fastethernet0/1
Switch(config-if)# ethernet loop facility mac-address swap timeout none supported
Switch(config-if)# exit
Switch(config-if)# interface fastethernet0/2
Switch(config-if)# ethernet loop facility vlan 3 mac-address copy timeout 100 supported 
switch(config-if)# switch mode trunk 
Switch(config-if)# exit 
switch(config)# vlan 3
switch(config-vlan)# end

Switch# show ethernet loopback
=====================================
Loopback Session 0  : Interface Fa0/1
Direction           : facility
Type                : port
Status              : configured
MAC Mode            : swap
Time out            : none
=====================================
Loopback Session 1  : Interface Fa0/2
Direction           : facility
Type                : vlan
Status              : configured
MAC Mode            : copy
Vlan                : 3
Time out            : 100

This example shows how to remove Ethernet loopback facility configuration on two interfaces and to configure Ethernet terminal loopback on an interface.

Switch(config)# interface fastethernet 0/1
switch(config-if)# no ethernet loopback
switch(config-if)# interface fastethernet 0/2       
switch(config-if)# no ethernet loopback
switch(config-if)# exit
switch(config)# default interface range fastethernet 0/1-2 
switch(config)# interface fastethernet 0/1
switch(config-if)# ethernet loop terminal mad-address swap timeout 300 supported 
switch(config-if)# end

Switch# show ethernet loopback 
=====================================
Loopback Session 0  : Interface Fa0/1
Direction           : terminal
Type                : port
Status              : configured
MAC Mode            : swap
Time out            : 300

Related Commands

Command
Description

ethernet loopback (privileged EXEC)

Starts or stops an Ethernet loopback operation on an interface.

show ethernet loopback

Displays the Ethernet loopbacks configured on the switch or the specified interface.


ethernet loopback (privileged EXEC)

Use the ethernet loopback privileged EXEC command to start or stop an Ethernet loopback function on an interface.

ethernet loopback {start interface-id | stop {interface-id | all}}

Syntax Description

start

Start the Ethernet loopback operation configured on the interface.

stop

Stop the Ethernet loopback operation.

interface-id

Specify the interface on which to start or stop the loopback operation.

all

Stop all Ethernet loopback operations on the switch. This keyword is available only after the stop keyword.


Defaults

There is no default.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Before starting or stopping an Ethernet loopback operation, you must configure it on an interface by entering the ethernet loopback interface configuration command. When you start loopback, you see a warning message.

You can configure Ethernet loopback and enter the ethernet loopback start or ethernet loopback stop command only for physical ports, not for VLANs or port channels.

You cannot start VLAN loopback on nontrunk interfaces. You cannot start terminal loopback on routed interfaces.

You can configure only one loopback per port and a maximum of two loopbacks per switch. You can configure only one terminal loopback per switch.

Examples

This example shows how to start a facility port loopback process, to verify it, and then to stop it:

Switch(config)# interface gigabitethernet 0/1
Switch(config-if)# ethernet loopback facility mac-address swap timeout 30 supported
Switch(config-if)# end
Switch# ethernet loopback start gigabitethernet 0/1
This is an intrusive loopback.
Therefore, while you test Ethernet connectivity,
you will be unable to pass traffic across that link.
Proceed with Local Loopback? [confirm]
Switch# show ethernet loopback
=====================================
Loopback Session 0  : Interface Gi0/1
Direction           : facility
Type                : port
Status              : active
MAC Mode            : swap
Time out            : 30
Time remaining      : 25 seconds

Switch# ethernet loop stop all

Dec  4 11:18:44.083: %LINEPROTO-5-UPDOWN: Line protocol on Interface GigabitEthernet0/1, 
changed state to up

Switch# show ethernet loopback 
=====================================
Loopback Session 0  : Interface Gi0/1
Direction           : facility
Type                : port
Status              : configured
MAC Mode            : swap
Time out            : 30

This example shows how to start a VLAN non-intrusive loopback process:

Switch# ethernet loop start fastethernet 0/2
This is a non-intrusive loopback. 
Therefore, while you test Ethernet connectivity on vlan 3, you will be unable to pass 
traffic across it, however, other vlans will be unaffected.
Proceed with Local Loopback? [confirm]

Switch# show ethernet loopback 
=====================================
Loopback Session 1  : Interface Fa0/2
Direction           : facility
Type                : vlan
Status              : active
MAC Mode            : copy
Vlan                : 3
Time out            : 100
Time remaining      : 94 seconds

Related Commands

Command
Description

ethernet loopback (interface configuration)

Configures an Ethernet loopback operation on an interface.

show ethernet loopback

Displays the Ethernet loopbacks configured on the switch or the specified interface.


ethernet oam remote-failure

Use the ethernet oam remote-failure interface configuration or configuration template command to configure Ethernet operations, maintenance, and administration (EOM) remote failure indication. Use the no form of this command to remove the configuration.

ethernet oam remote-failure {critical-event | dying-gasp | link-fault} action error-disable-interface

no ethernet oam remote-failure {critical-event | dying-gasp | link-fault} action

Syntax Description

critical-event

Configure the switch to put an interface in error-disabled mode when an unspecified critical event has occurred.

dying-gasp

Configure the switch to put an interface in error-disabled mode when an unrecoverable condition has occurred.

link-fault

Configure the switch to put an interface in error-disabled mode when the receiver detects a loss of power.


Defaults

Configuration template

Interface configuration

Command Modes

Ethernet service configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You can apply this command to an Ethernet OAM template and to an interface. The interface configuration takes precedence over template configuration. To enter OAM template configuration mode, use the template template-name global configuration command.

The Cisco ME switch does not generate Link Fault or Critical Event OAM PDUs. However, if these PDUs are received from a link partner, they are processed. The switch supports generating and receiving Dying Gasp OAM PDUs when Ethernet OAM is disabled, the interface is shut down, the interface enters the error-disabled state, or the switch is reloading. The switch can also generate and receive Dying Gasp PDUs based on loss of power. The PDU includes a reason code to indicate why it was sent.

You can configure an error-disable action to occur if the remote link goes down, if the remote device is disabled, or if the remote device disables Ethernet OAM on the interface.

For complete command and configuration for the Ethernet OAM protocol, see the Cisco IOS Carrier Ethernet Configuration Guide at this URL:
http://www.cisco.com/en/US/docs/ios/cether/configuration/guide/12_2sr/ce_12_2sr_book.html

For complete syntax of the CFM and Ethernet OAM commands, see the Cisco IOS Carrier Ethernet Command Reference at this URL:
http://www.cisco.com/en/US/docs/ios/cether/command/reference/ce_book.html

Examples

This example shows how to configure an Ethernet OAM template for remote-failure indication when an unrecoverable error has occurred and how to apply it to an interface:

Switch(config)# template oam1
Switch(config-template)# ethernet oam remote-failure dying-gasp action error-disable 
interface
Switch(config-template)# exit
Switch(config)# interface gigabitethernet 0/1
Switch(config-if)# source template oam1
Switch(config-if)# exit

This example shows how to configure an Ethernet OAM remote-failure indication on one interface for unrecoverable errors:

Switch(config)# interface gigabitethernet 0/1
Switch(config-if)# ethernet oam remote-failure dying-gasp action error-disable interface
Switch(config-if)# exit

Related Commands

Command
Description

show ethernet oam status [interface interface-id]

Displays configured Ethernet OAM remote failure conditions on all interfaces or on the specified interface.


ethernet uni

Use the ethernet uni interface configuration command to set UNI bundling attributes. Use the no form of this command to return to the default bundling configuration.

ethernet uni {bundle [all-to-one] | multiplex}

no ethernet uni {bundle | multiplex}

Syntax Description

bundle

Configure the UNI to support bundling without multiplexing. This service supports only one Ethernet virtual connection (EVC) at the UNI with one or multiple customer edge (CE)-VLAN IDs mapped to the EVC.

all-to-one

(Optional) Configure the UNI to support bundling with a single EVC at the UNI and all CE VLANs mapped to that EVC.

multiplex

Configure the UNI to support multiplexing without bundling. The UNI can have one or more EVCs with a single CE-VLAN ID mapped to each EVC.


Defaults

If bundling or multiplexing attributes are not configured, the default is bundling with multiplexing. The UNI then has one or more EVCs with one or more CE VLANs mapped to each EVC.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

The UNI attributes determine the functionality that the interface has regarding bundling VLANs, multiplexing EVCs, and the combination of these.

If you want both bundling and multiplexing services for a UNI, you do not need to configure bundling or multiplexing. If you want only bundling, or only multiplexing, you need to configure it appropriately.

When you configure, change, or remove a UNI service type, the EVC and CE-VLAN ID configurations are checked to ensure that the configurations and the UNI service types match. If the configurations do not match, the command is rejected.

If you intend to use the ethernet lmi ce-vlan map any service configuration command, you must first configure all-to-one bundling on the interface. See the ethernet lmi ce-vlan map section for more information.

Examples

This example shows how to configure bundling without multiplexing:

Switch(config-if)# ethernet uni bundle

To verify UNI service type, enter the show ethernet service interface detail privileged EXEC command.

Related Commands

Command
Description

show ethernet service interface

Displays information about Ethernet service instances on an interface, including service type.


ethernet uni id

Use the ethernet uni interface configuration command to create an Ethernet user-network interface (UNI) ID. Use the no form of this command to remove the UNI ID.

ethernet uni id name

no ethernet uni id

Syntax Description

name

Identify an Ethernet UNI ID. The name should be unique for all UNIs that are part of a given service instance and can be up to 64 characters in length.


Defaults

No UNI IDs are created.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

When you configure a UNI ID on a port, that ID is used as the default name for all maintenance end points (MEPs) configured on the port.

You must enter the ethernet uni id name command on all ports that are directly connected to customer-edge (CE) devices. If the specified ID is not unique on the device, an error message appears.

Examples

This example shows how to identify a unique UNI:

Switch(config-if)# ethernet uni id test2

Related Commands

Command
Description

show ethernet service interface

Displays information about Ethernet service instances on an interface, including service type.


exceed-action

Use the exceed-action policy-map class police configuration command to set multiple actions for a policy-map class for packets with a rate between the committed information rate (CIR) or peak information rate (PIR) conform rate and the conform rate plus the exceed burst. Use the no form of this command to cancel the action or to return to the default action.

exceed-action {drop | set-cos-transmit {new-cos-value | [cos | dscp | precedence] [table table-map name]} | set-dscp-transmit {new-dscp-value | [cos | dscp | precedence] [table table-map name]} | set-prec-transmit {new-precedence-value | [cos | dscp | precedence] [table table-map name]} | set-qos-transmit qos-group-value | transmit]}

no exceed-action {drop | set-cos-transmit {new-cos-value | [cos | dscp | precedence] [table table-map name]} | set-dscp-transmit {new-dscp-value | [cos | dscp | precedence] [table table-map name]} | set-prec-transmit {new-precedence-value | [cos | dscp | precedence] [table table-map name]} | set-qos-transmit qos-group-value | transmit]}

Syntax Description

drop

Drop the packet.

set-cos-transmit new-cos-value

Set a new class of service (CoS) value for the packet and send the packet. This specifies the to-type of the marking action. The range for the new CoS value is 0 to 7.

set-dscp-transmit new-dscp-value

Set a new Differentiated Services Code Point (DSCP) value for the packet and send the packet. This specifies the to-type of the marking action. The range for the new DCSP value is 0 to 63.

set-prec-transmit new-precedence-value

Set a new IP precedence value for the packet and send the packet. This specifies the to-type of the marking action. The range for the new IP precedence value is 0 to 7.

set-qos-transmit qos-group-value

Set a new quality of service (QoS) group value for the packet and send the packet. This specifies the to-type of the marking action. The range for the new QoS value is 0 to 99.

cos

(Optional) Set the packet marking specified in the preceding keyword based on the CoS value of the incoming packet, and send the packet. This specifies the from-type of the enhanced packet-marking action.

dscp

(Optional) Set the packet marking specified in the preceding keyword based on the DSCP value of the incoming packet, and send the packet. This specifies the from-type of the enhanced packet-marking action.

precedence

(Optional) Set the packet marking specified in the preceding keyword based on the IP precedence value of the incoming packet, and send the packet. This specifies the from-type of the enhanced packet-marking action.

table table-map name

(Optional) Used in conjunction with the preceding from-type keyword. Specify the table map to be used for the enhanced packet marking. The to-type of the action is marked based on the from-type parameter of the action using this table map.

transmit

(Optional) Send the packet unmodified.


Defaults

The default action is to drop the packet.

Command Modes

Policy-map class police configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You configure exceed actions for packets when the packet rate is between the configured conform rate and the conform rate plus the exceed burst.

If the conform action is set to drop, the exceed and violate actions are automatically set to drop. If the exceed action is set to drop, the violate action is automatically set to drop.

You can configure exceed-action to send the packet unmodified, mark using explicit values, and use all combinations of enhanced packet marking. Enhanced packet marking provides the ability to modify a QoS marking based on any incoming QoS marking and table maps. The switch also supports the ability to mark multiple QoS parameters for the same class and to simultaneously configure conform-action, exceed-action, and violate-action marking.

Access policy-map class police configuration mode by entering the police policy-map class command. See the police command for more information.

You can use this command to set one or more exceed actions for a traffic class.

Examples

This example shows how configure multiple actions in a policy map that sets an information rate of 23000 bits per second (b/s) and a burst rate of 10000 bps:

Switch(config)# policy-map map1
Switch(config-pmap)# class class1
Switch(config-pmap-c)# police 23000 10000
Switch(config-pmap-c-police)# conform-action transmit 
Switch(config-pmap-c-police)# exceed-action set-prec-transmit prec table 
policed-prec-table-map-name
Switch(config-pmap-c-police)# exit

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

Related Commands

Command
Description

class

Defines a traffic classification match criteria for the specified class-map name.

conform-action

Defines the action to take on traffic that conforms to the CIR.

police

Defines a policer for classified traffic.

policy-map

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

show policy-map

Displays QoS policy maps.

violate-action

Defines the action to take on traffic with a rate greater than the conform rate plus the exceed burst.


flowcontrol

Use the flowcontrol interface configuration command to set the receive flow-control state for an interface. When flow control send is operable and 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 a 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 keywords to disable flow control.

flowcontrol receive {desired | off | on}


Note The Cisco ME switch can only receive pause frames.


Syntax Description

receive

Set whether the interface can receive flow-control packets from a remote device.

desired

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

off

Turn off the ability of an attached device to send flow-control packets to an interface.

on

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


Defaults

The default is flowcontrol receive off.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

The switch does not support sending flow-control pause frames. If the port is a user network interface (UNI) or enhanced network interface (ENI), you must use the no shutdown interface configuration command to enable it before using the flowcontrol command. UNIs and ENIs are disabled by default. Network node interfaces (NNIs) are enabled by default.

Note that 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 or desired: The port cannot send out 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: 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-2 shows the flow control results on local and remote ports for a combination of settings. The table assumes that receive desired has the same results as using the receive on keywords.

Table 2-2 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 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 flow control by the remote port:

Switch(config)# interface gigabitethernet0/1
Switch(config-if)# flowcontrol receive off

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

Related Commands

Command
Description

show interfaces

Displays the interface settings on the switch, including input and output flow control.


hw-module module logging onboard

Use the hw-module module logging onboard global configuration command to enable on-board failure logging (OBFL). Use the no form of this command to disable this feature.

hw-module module [slot-number] logging onboard [message level level]

no hw-module module [slot-number] logging onboard [message level]

Syntax Description

slot-number

(Optional) The slot number is always 1 and is not relevant for the ME-3400E.

message level level

(Optional) Specify the severity of the hardware-related messages that are stored in the flash memory. The range is from 1 to 7 with 1 being the most severe.


Defaults

OBFL is enabled, and all messages appear.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

We recommend that you keep OBFL enabled and do not clear the data stored in the flash memory.

To ensure that the time stamps in the OBFL data logs are accurate, manually set the system clock, or configure it by using Network Time Protocol (NTP).

If you do not enter the message level level parameter, all the hardware-related messages generated by the switch are stored in the flash memory.

The optional slot number is always 1. Entering the hw-module module [slot-number] logging onboard [message level level] command has the same result as entering the hw-module module logging onboard [message level level] command.

Examples

This example shows how to enable OBFL on a switch stack and to specify that all the hardware-related messages are stored in the flash memory:

Switch(config)# hw-module module logging onboard

This example shows how to enable OBFL on a switch and to specify that only severity 1 hardware-related messages are stored in the flash memory:

Switch(config)# hw-module module logging onboard message level 1

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

Related Commands

Command
Description

clear logging onboard

Removes the OBFL data in the flash memory.

show logging onboard

Displays OBFL information.


interface port-channel

Use the interface port-channel global configuration command to access or create the port-channel logical interface. 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 48.


Defaults

No port-channel logical interfaces are defined.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

For Layer 2 EtherChannels, you do not have to create a port-channel interface first before assigning a physical port to a channel group. Instead, you can use the channel-group interface configuration command. It automatically creates the port-channel interface when the channel group gets its first physical port. If you create the port-channel interface first, the channel-group-number can be the same as the port-channel-number, or you can use a new number. If you use a new number, the channel-group command dynamically creates a new port channel.

You create Layer 3 port channels by using the interface port-channel command followed by the no switchport interface configuration command. You should manually configure the port-channel logical interface before putting the interface into the channel group.

Only one port channel in a channel group is allowed.


Caution When using a port-channel interface as a routed port, do not assign Layer 3 addresses on the physical ports that are assigned to the channel group.


Caution Do not assign bridge groups on the physical ports in a channel group used as a Layer 3 port-channel interface because it creates loops. You must also disable spanning tree.

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 port and not on the port-channel interface.


Note CDP is available only on network node interfaces (NNIs) and enhanced network interfaces (ENIs).


Do not configure a port that is an active member of an EtherChannel as an IEEE 802.1x port. If IEEE 802.1x is enabled on a not-yet active port of an EtherChannel, the port does not join the EtherChannel.

For a complete list of configuration guidelines, see the "Configuring EtherChannels" chapter in the software configuration guide for this release.

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 setting by entering the show running-config privileged EXEC or show etherchannel channel-group-number detail privileged EXEC command.

Related Commands

Command
Description

channel-group

Assigns an Ethernet port to an EtherChannel group.

show etherchannel

Displays EtherChannel information for a channel.

show running-config

Displays the operating configuration. For syntax information, use this link to the Cisco IOS Release 12.2 Command Reference listing page: http://www.cisco.com/en/US/products/sw/iosswrel/ps1835/prod_command_reference_list.html
Select the Cisco IOS Commands Master List, Release 12.2 to navigate to the command.


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

This command was introduced.


Usage Guidelines

When you enter interface range configuration mode, all interface parameters you enter are attributed to all interfaces within the range.

For VLANs, you can use the interface range command only on existing VLAN switch virtual interfaces (SVIs). To display VLAN SVIs, enter the show running-config privileged EXEC command. VLANs not displayed cannot be used in the interface range command. The commands entered under interface range command are applied to all existing VLAN SVIs 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

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. However, you can define up to five interface ranges with a single command, with each range separated by a comma.

Valid values for port-range type and interface:

vlan vlan-ID - vlan-ID, where VLAN ID is from 1 to 4094

fastethernet module/{first port} - {last port}, where module is always 0

gigabitethernet module/{first port} - {last port}, where module is always 0

For physical interfaces:

module is always 0

the range is type 0/number - number (for example, gigabitethernet0/1 - 2)

port-channel port-channel-number - port-channel-number, where port-channel-number is from 1 to 48


Note When you use the interface range command with port channels, the first and last port channel number in the range must be active port channels.


When you define a range, you must enter a space between the first entry and the hyphen (-):

interface range gigabitethernet0/1 -2

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

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

You cannot specify both a macro and an interface range in the same command.

A single interface can also be specified in port-range (this would make the command 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 to apply commands to two ports:

Switch(config)# interface range gigabitethernet0/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 macro1 until you delete it.

Switch(config)# define interface-range macro1 gigabitethernet0/1 - 2
Switch(config)# interface range macro macro1
Switch(config-if-range)#

Related Commands

Command
Description

define interface-range

Creates an interface range macro.

show running-config

Displays the operating configuration. For syntax information, use this link to the Cisco IOS Release 12.2 Command Reference listing page: http://www.cisco.com/en/US/products/sw/iosswrel/ps1835/prod_command_reference_list.html
Select the Cisco IOS Commands Master List, Release 12.2 to navigate to the command.


interface vlan

Use the interface vlan global configuration command to create or access a switch virtual interface (SVI) and to enter interface configuration mode. Use the no form of this command to delete an SVI.

interface vlan vlan-id

no interface vlan vlan-id

Syntax Description

vlan-id

VLAN number. The range is 1 to 4094.


Defaults

The default VLAN interface is VLAN 1.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

SVIs are created the first time that you enter the interface vlan vlan-id command for a particular vlan. The vlan-id corresponds to the VLAN-tag associated with data frames on an IEEE 802.1Q encapsulated trunk or the VLAN ID configured for an access port.


Note When you create an SVI, it does not become active until it is associated with a physical port.


If you delete an SVI by entering the no interface vlan vlan-id command, the deleted interface is no longer visible in the output from the show interfaces privileged EXEC command.


Note You cannot delete the VLAN 1 interface.


You can reinstate a deleted SVI by entering the interface vlan vlan-id command for the deleted interface. The interface comes back up, but much of the previous configuration will be gone.

The interrelationship between the number of SVIs configured on a switch and the number of other features being configured might have an impact on CPU utilization due to hardware limitations. You can use the sdm prefer global configuration command to reallocate system hardware resources based on templates and feature tables. For more information, see the sdm prefer command.

Examples

This example shows how to create VLAN ID 23 and enter interface configuration mode:

Switch(config)# interface vlan 23
Switch(config-if)#

You can verify your setting by entering the show interfaces and show interfaces vlan vlan-id privileged EXEC commands.

Related Commands

Command
Description

show interfaces vlan vlan-id

Displays the administrative and operational status of all interfaces or the specified VLAN.


ip access-group

Use the ip access-group interface configuration command to control access to a Layer 2 or Layer 3 interface. Use the no form of this command to remove all access groups or the specified access group from the interface. If the switch is running the metro IP access image, you can also control access to Layer 3 interfaces.

ip access-group {access-list-number | name} {in | out}

no ip access-group [access-list-number | name] {in | out}

Syntax Description

access-list-number

The number of the IP access control list (ACL). The range is 1 to 199 or 1300 to 2699.

name

The name of an IP ACL, specified in the ip access-list global configuration command.

in

Specify filtering on inbound packets.

out

Specify filtering on outbound packets. This keyword is valid only on Layer 3 interfaces.


Defaults

No access list is applied to the interface.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You can apply named or numbered standard or extended IP access lists to an interface. To define an access list by name, use the ip access-list global configuration command. To define a numbered access list, use the access list global configuration command. You can used numbered standard access lists ranging from 1 to 99 and 1300 to 1999 or extended access lists ranging from 100 to 199 and 2000 to 2699.

The switch must be running the metro IP access image for Layer 3 support.

You can use this command to apply an access list to a Layer 2 interface (port ACL) or Layer 3 interface. However, note these limitations for port ACLs:

You can only apply ACLs in the inbound direction; the out keyword is not supported for Layer 2 interfaces.

You can only apply one IP ACL and one MAC ACL per interface.

Port ACLs do not support logging; if the log keyword is specified in the IP ACL, it is ignored.

An IP ACL applied to a Layer 2 interface only filters IP packets. To filter non-IP packets, use the mac access-group interface configuration command with MAC extended ACLs.

You can use router ACLs, input port ACLs, and VLAN maps on the same switch. However, a port ACL always takes precedence. When both an input port ACL and a VLAN map are applied, incoming packets received on ports with the port ACL applied are filtered by the port ACL. Other packets are filtered by the VLAN map.

When an input port ACL is applied to an interface and a VLAN map is applied to a VLAN that the interface is a member of, incoming packets received on ports with the ACL applied are filtered by the port ACL. Other packets are filtered by the VLAN map.

When an input router ACL and input port ACLs exist in an switch virtual interface (SVI), incoming packets received on ports to which a port ACL is applied are filtered by the port ACL. Incoming routed IP packets received on other ports are filtered by the router ACL. Other packets are not filtered.

When an output router ACL and input port ACLs exist in an SVI, incoming packets received on the ports to which a port ACL is applied are filtered by the port ACL. Outgoing routed IP packets are filtered by the router ACL. Other packets are not filtered.

When a VLAN map, input router ACLs, and input port ACLs exist in an SVI, incoming packets received on the ports to which a port ACL is applied are only filtered by the port ACL. Incoming routed IP packets received on other ports are filtered by both the VLAN map and the router ACL. Other packets are filtered only by the VLAN map.

When a VLAN map, output router ACLs, and input port ACLs exist in an SVI, incoming packets received on the ports to which a port ACL is applied are only filtered by the port ACL. Outgoing routed IP packets are filtered by both the VLAN map and the router ACL. Other packets are filtered only by the VLAN map.

You can apply IP ACLs to both outbound or inbound Layer 3 interfaces.

A Layer 3 interface can have one IP ACL applied in each direction.

You can configure only one VLAN map and one router ACL in each direction (input/output) on a VLAN interface.

For standard inbound access lists, after the switch receives a packet, it checks the source address of the packet against the access list. IP extended access lists can optionally check other fields in the packet, such as the destination IP address, protocol type, or port numbers. If the access list permits the packet, the switch continues to process the packet. If the access list denies the packet, the switch discards the packet. If the access list has been applied to a Layer 3 interface, discarding a packet (by default) causes the generation of an Internet Control Message Protocol (ICMP) Host Unreachable message. ICMP Host Unreachable messages are not generated for packets discarded on a Layer 2 interface.

For standard outbound access lists, after receiving a packet and sending it to a controlled interface, the switch checks the packet against the access list. If the access list permits the packet, the switch sends the packet. If the access list denies the packet, the switch discards the packet and, by default, generates an ICMP Host Unreachable message.

If the specified access list does not exist, all packets are passed.

Examples

This example shows how to apply IP access list 101 to inbound packets on a port:

Switch(config)# interface gigabitethernet0/1
Switch(config-if)# ip access-group 101 in

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

Related Commands

Command
Description

access list

Configures a numbered ACL. For syntax information, select Cisco IOS IP Command Reference, Volume 1 of 3:Addressing and Services, Release 12.2 > IP Services Commands

ip access-list

Configures a named ACL. For syntax information, select Cisco IOS IP Command Reference, Volume 1 of 3:Addressing and Services, Release 12.2 > IP Services Commands.

show access-lists

Displays ACLs configured on the switch.

show ip access-lists

Displays IP ACLs configured on the switch. For syntax information, select Cisco IOS IP Command Reference, Volume 1 of 3:Addressing and Services, Release 12.2 > IP Services Commands.

show ip interface

Displays information about interface status and configuration. For syntax information, select Cisco IOS IP Command Reference, Volume 1 of 3:Addressing and Services, Release 12.2 > IP Services Commands.


ip address

Use the ip address interface configuration command to set an IP address for the Layer 2 switch or to set an IP address for each switch virtual interface (SVI) or routed port on the Layer 3 switch. Use the no form of this command to remove an IP address or to disable IP processing.

ip address ip-address subnet-mask [secondary]

no ip address [ip-address subnet-mask] [secondary]


Note You can configure routed ports and SVIs only when the switch is running the metro IP access image.


Syntax Description

ip-address

IP address.

subnet-mask

Mask for the associated IP subnet.

secondary

(Optional) Specifies that the configured address is a secondary IP address. If this keyword is omitted, the configured address is the primary IP address.


Defaults

No IP address is defined.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

If you remove the switch IP address through a Telnet session, your connection to the switch will be lost.

Hosts can find subnet masks using the Internet Control Message Protocol (ICMP) Mask Request message. Routers respond to this request with an ICMP Mask Reply message.

You can disable IP processing on a particular interface by removing its IP address with the no ip address command. If the switch detects another host using one of its IP addresses, it will send an error message to the console.

You can use the optional keyword secondary to specify an unlimited number of secondary addresses. Secondary addresses are treated like primary addresses, except the system never generates datagrams other than routing updates with secondary source addresses. IP broadcasts and ARP requests are handled properly, as are interface routes in the IP routing table.


Note If any router on a network segment uses a secondary address, all other devices on that same segment must also use a secondary address from the same network or subnet. Inconsistent use of secondary addresses on a network segment can very quickly cause routing loops.


When you are routing Open Shortest Path First (OSPF), ensure that all secondary addresses of an interface fall into the same OSPF area as the primary addresses.

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 the DHCP server cannot reassign the address.

A Layer 3 switch can have an IP address assigned to each routed port and SVI. The number of routed ports and SVIs that you can configure is not limited by software; however, the interrelationship between this number and the number of other features being configured might have an impact on CPU utilization due to hardware limitations. You can use the sdm prefer global configuration command to reallocate system hardware resources based on templates and feature tables. For more information, see the sdm prefer command.

Examples

This example shows how to configure the IP address for the Layer 2 switch on a subnetted network:

Switch(config)# interface vlan 1
Switch(config-if)# ip address 172.20.128.2 255.255.255.0

This example shows how to configure the IP address for a Layer 3 port on the switch:

Switch(config)# interface gigabitethernet0/1
Switch(config-if)# no switchport
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 operating configuration. For syntax information, use this link to the Cisco IOS Release 12.2 Command Reference listing page: http://www.cisco.com/en/US/products/sw/iosswrel/ps1835/prod_command_reference_list.html
Select the Cisco IOS Commands Master List, Release 12.2 to navigate to the command.


ip arp inspection filter vlan

Use the ip arp inspection filter vlan global configuration command to permit or deny Address Resolution Protocol (ARP) requests and responses from a host configured with a static IP address when dynamic ARP inspection is enabled. Use the no form of this command to return to the default settings.

ip arp inspection filter arp-acl-name vlan vlan-range [static]

no ip arp inspection filter arp-acl-name vlan vlan-range [static]

Syntax Description

arp-acl-name

ARP access control list (ACL) name.

vlan-range

VLAN number or range.

You can specify a single VLAN identified by VLAN ID number, a range of VLANs separated by a hyphen, or a series of VLANs separated by a comma. The range is 1 to 4094.

static

(Optional) Specify static to treat implicit denies in the ARP ACL as explicit denies and to drop packets that do not match any previous clauses in the ACL. DHCP bindings are not used.

If you do not specify this keyword, it means that there is no explicit deny in the ACL that denies the packet, and DHCP bindings determine whether a packet is permitted or denied if the packet does not match any clauses in the ACL.


Defaults

No defined ARP ACLs are applied to any VLAN.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

When an ARP ACL is applied to a VLAN for dynamic ARP inspection, only the ARP packets with IP-to-MAC address bindings are compared against the ACL. If the ACL permits a packet, the switch forwards it. All other packet types are bridged in the ingress VLAN without validation.

If the switch denies a packet because of an explicit deny statement in the ACL, the packet is dropped. If the switch denies a packet because of an implicit deny statement, the packet is then compared against the list of DHCP bindings (unless the ACL is static, which means that packets are not compared against the bindings).

Use the arp access-list acl-name global configuration command to define the ARP ACL or to add clauses to the end of a predefined list.

Examples

This example shows how to apply the ARP ACL static-hosts to VLAN 1 for dynamic ARP inspection:

Switch(config)# ip arp inspection filter static-hosts vlan 1

You can verify your settings by entering the show ip arp inspection vlan 1 privileged EXEC command.

Related Commands

Command
Description

arp access-list

Defines an ARP ACL.

deny (ARP access-list configuration)

Denies an ARP packet based on matches against the DHCP bindings.

permit (ARP access-list configuration)

Permits an ARP packet based on matches against the DHCP bindings.

show arp access-list

Displays detailed information about ARP access lists.

show ip arp inspection vlan vlan-range

Displays the configuration and the operating state of dynamic ARP inspection for the specified VLAN.


ip arp inspection limit

Use the ip arp inspection limit interface configuration command to limit the rate of incoming Address Resolution Protocol (ARP) requests and responses on an interface. It prevents dynamic ARP inspection from using all of the switch resources if a denial-of-service attack occurs. Use the no form of this command to return to the default settings.

ip arp inspection limit {rate pps [burst interval seconds] | none}

no ip arp inspection limit

Syntax Description

rate pps

Specify an upper limit for the number of incoming packets processed per second. The range is 0 to 2048 packets per second (pps).

burst interval seconds

(Optional) Specify the consecutive interval in seconds, over which the interface is monitored for a high rate of ARP packets.The range is 1 to 15 seconds.

none

Specify no upper limit for the rate of incoming ARP packets that can be processed.


Defaults

The rate is 15 pps on untrusted interfaces, assuming that the network is a switched network with a host connecting to as many as 15 new hosts per second.

The rate is unlimited on all trusted interfaces.

The burst interval is 1 second.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

The rate applies to both trusted and untrusted interfaces. Configure appropriate rates on trunks to process packets across multiple dynamic ARP inspection-enabled VLANs, or use the none keyword to make the rate unlimited.

After a switch receives more than the configured rate of packets every second consecutively over a number of burst seconds, the interface is placed into an error-disabled state.

Unless you explicitly configure a rate limit on an interface, changing the trust state of the interface also changes its rate limit to the default value for that trust state. After you configure the rate limit, the interface retains the rate limit even when its trust state is changed. If you enter the no ip arp inspection limit interface configuration command, the interface reverts to its default rate limit.

You should configure trunk ports with higher rates to reflect their aggregation. When the rate of incoming packets exceeds the user-configured rate, the switch places the interface into an error-disabled state. The error-disable recovery feature automatically removes the port from the error-disabled state according to the recovery setting.

The rate of incoming ARP packets on EtherChannel ports equals the sum of the incoming rate of ARP packets from all the channel members. Configure the rate limit for EtherChannel ports only after examining the rate of incoming ARP packets on all the channel members.

Examples

This example shows how to limit the rate of incoming ARP requests on a port to 25 pps and to set the interface monitoring interval to 5 consecutive seconds:

Switch(config)# interface gigabitethernet1/0/1
Switch(config-if)# ip arp inspection limit rate 25 burst interval 5

You can verify your settings by entering the show ip arp inspection interfaces interface-id privileged EXEC command.

Related Commands

Command
Description

show ip arp inspection interfaces

Displays the trust state and the rate limit of ARP packets for the specified interface or all interfaces.


ip arp inspection log-buffer

Use the ip arp inspection log-buffer global configuration command to configure the dynamic Address Resolution Protocol (ARP) inspection logging buffer. Use the no form of this command to return to the default settings.

ip arp inspection log-buffer {entries number | logs number interval seconds}

no ip arp inspection log-buffer {entries | logs}

Syntax Description

entries number

Number of entries to be logged in the buffer. The range is 0 to 1024.

logs number interval seconds

Number of entries needed in the specified interval to generate system messages.

For logs number, the range is 0 to 1024. A 0 value means that the entry is placed in the log buffer, but a system message is not generated.

For interval seconds, the range is 0 to 86400 seconds (1 day). A 0 value means that a system message is immediately generated (and the log buffer is always empty).


Defaults

When dynamic ARP inspection is enabled, denied or dropped ARP packets are logged.

The number of log entries is 32.

The number of system messages is limited to 5 per second.

The logging-rate interval is 1 second.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

A value of 0 is not allowed for both the logs and the interval keywords.

The logs and interval settings interact. If the logs number X is greater than interval seconds Y, X divided by Y (X/Y) system messages are sent every second. Otherwise, one system message is sent every Y divided by X (Y/X) seconds. For example, if the logs number is 20 and the interval seconds is 4, the switch generates system messages for five entries every second while there are entries in the log buffer.

A log buffer entry can represent more than one packet. For example, if an interface receives many packets on the same VLAN with the same ARP parameters, the switch combines the packets as one entry in the log buffer and generates a system message as a single entry.

If the log buffer overflows, it means that a log event does not fit into the log buffer, and the output display for the show ip arp inspection log privileged EXEC command is affected. A -- in the output display appears in place of all data except the packet count and the time. No other statistics are provided for the entry. If you see this entry in the display, increase the number of entries in the log buffer, or increase the logging rate.

Examples

This example shows how to configure the logging buffer to hold up to 45 entries:

Switch(config)# ip arp inspection log-buffer entries 45

This example shows how to configure the logging rate to 20 log entries per 4 seconds. With this configuration, the switch generates system messages for five entries every second while there are entries in the log buffer.

Switch(config)# ip arp inspection log-buffer logs 20 interval 4

You can verify your settings by entering the show ip arp inspection log privileged EXEC command.

Related Commands

Command
Description

arp access-list

Defines an ARP access control list (ACL).

clear ip arp inspection log

Clears the dynamic ARP inspection log buffer.

ip arp inspection vlan logging

Controls the type of packets that are logged per VLAN.

show ip arp inspection log

Displays the configuration and contents of the dynamic ARP inspection log buffer.


ip arp inspection trust

Use the ip arp inspection trust interface configuration command to configure an interface trust state that determines which incoming Address Resolution Protocol (ARP) packets are inspected. Use the no form of this command to return to the default setting.

ip arp inspection trust

no ip arp inspection trust

Syntax Description

This command has no arguments or keywords.

Defaults

The interface is untrusted.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

The switch does not check ARP packets that it receives on the trusted interface; it simply forwards the packets.

For untrusted interfaces, the switch intercepts all ARP requests and responses. It verifies that the intercepted packets have valid IP-to-MAC address bindings before updating the local cache and before forwarding the packet to the appropriate destination. The switch drops invalid packets and logs them in the log buffer according to the logging configuration specified with the ip arp inspection vlan logging global configuration command.

Examples

This example shows how to configure a port to be trusted:

Switch(config)# interface gigabitethernet0/1
Switch(config-if)# ip arp inspection trust 

You can verify your setting by entering the show ip arp inspection interfaces interface-id privileged EXEC command.

Related Commands

Command
Description

ip arp inspection log-buffer

Configures the dynamic ARP inspection logging buffer.

show ip arp inspection interfaces

Displays the trust state and the rate limit of ARP packets for the specified interface or all interfaces.

show ip arp inspection log

Displays the configuration and contents of the dynamic ARP inspection log buffer.


ip arp inspection validate

Use the ip arp inspection validate global configuration command to perform specific checks for dynamic Address Resolution Protocol (ARP) inspection. Use the no form of this command to return to the default settings.

ip arp inspection validate {[src-mac] [dst-mac] [ip [allow zeros]]}

no ip arp inspection validate [src-mac] [dst-mac] [ip [allow zeros]]

Syntax Description

src-mac

Compare the source MAC address in the Ethernet header against the sender MAC address in the ARP body. This check is performed on both ARP requests and responses.

When enabled, packets with different MAC addresses are classified as invalid and are dropped.

dst-mac

Compare the destination MAC address in the Ethernet header against the target MAC address in ARP body. This check is performed for ARP responses.

When enabled, packets with different MAC addresses are classified as invalid and are dropped.

ip

Compare the ARP body for invalid and unexpected IP addresses. Addresses include 0.0.0.0, 255.255.255.255, and all IP multicast addresses.

Sender IP addresses are compared in all ARP requests and responses. Target IP addresses are checked only in ARP responses.

allow-zeros

Modifies the IP validation test so that ARPs with a sender address of 0.0.0.0 (ARP probes) are not denied.


Defaults

No checks are performed.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You must specify at least one of the keywords. Each command overrides the configuration of the previous command; that is, if a command enables src-mac and dst-mac validations, and a second command enables IP validation only, the src-mac and dst-mac validations are disabled as a result of the second command.

The allow-zeros keyword interacts with ARP access control lists (ACLs) in this way:

If you configure an ARP ACL to deny ARP probes, they are dropped even if the allow-zero keyword is specified.

If you configure an ARP ACL that specifically permits ARP probes and configure the ip arp inspection validate ip command, ARP probes are dropped unless you enter the allow-zeros keyword.

The no form of the command disables only the specified checks. If none of the options are enabled, all checks are disabled.

Examples

This example show how to enable source MAC validation:

Switch(config)# ip arp inspection validate src-mac 

You can verify your setting by entering the show ip arp inspection vlan vlan-range privileged EXEC command.

Related Commands

Command
Description

show ip arp inspection vlan vlan-range

Displays the configuration and the operating state of dynamic ARP inspection for the specified VLAN.


ip arp inspection vlan

Use the ip arp inspection vlan global configuration command to enable dynamic Address Resolution Protocol (ARP) inspection on a per-VLAN basis. Use the no form of this command to return to the default setting.

ip arp inspection vlan vlan-range

no ip arp inspection vlan vlan-range

Syntax Description

vlan-range

VLAN number or range.

You can specify a single VLAN identified by VLAN ID number, a range of VLANs separated by a hyphen, or a series of VLANs separated by a comma. The range is 1 to 4094.


Defaults

ARP inspection is disabled on all VLANs.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You must specify the VLANs on which to enable dynamic ARP inspection.

Dynamic ARP inspection is supported on access ports, trunk ports, EtherChannel ports, or private VLAN ports.

Examples

This example shows how to enable dynamic ARP inspection on VLAN 1:

Switch(config)# ip arp inspection vlan 1

You can verify your setting by entering the show ip arp inspection vlan vlan-range privileged EXEC command.

Related Commands

Command
Description

arp access-list

Defines an ARP access control list (ACL).

show ip arp inspection vlan vlan-range

Displays the configuration and the operating state of dynamic ARP inspection for the specified VLAN.


ip arp inspection vlan logging

Use the ip arp inspection vlan logging global configuration command to control the type of packets that are logged per VLAN. Use the no form of this command to disable this logging control.

ip arp inspection vlan vlan-range logging {acl-match {matchlog | none} | dhcp-bindings {all | none | permit} | arp-probe}

no ip arp inspection vlan vlan-range logging {acl-match | dhcp-bindings | arp-probe}

Syntax Description

vlan-range

Specify the VLANs configured for logging.

You can specify a single VLAN identified by VLAN ID number, a range of VLANs separated by a hyphen, or a series of VLANs separated by a comma. The range is 1 to 4094.

acl-match {matchlog | none}

Specify that the logging of packets is based on access control list (ACL) matches.

The keywords have these meanings:

matchlog—Log packets based on the logging configuration specified in the access control entries (ACE). If you specify the matchlog keyword in this command and the log keyword in the permit or deny ARP access-list configuration command, Address Resolution Protocol (ARP) packets permitted or denied by the ACL are logged.

none—Do not log packets that match ACLs.

dhcp-bindings {permit | all | none}

Specify the logging of packets is based on Dynamic Host Configuration Protocol (DHCP) binding matches.

The keywords have these meanings:

all—Log all packets that match DHCP bindings.

none—Do not log packets that match DHCP bindings.

permit—Log DHCP-binding permitted packets.

arp-probe

Specify logging of packets permitted specifically because they are ARP probes.


Defaults

All denied or all dropped packets are logged. ARP probe packets are not logged.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

The term logged means that the entry is placed into the log buffer and that a system message is generated.

The acl-match and dhcp-bindings keywords merge with each other; that is, when you configure an ACL match, the DHCP bindings configuration is not disabled. Use the no form of the command to reset the logging criteria to their defaults. If neither option is specified, all types of logging are reset to log when ARP packets are denied. These are the options:

acl-match—Logging on ACL matches is reset to log on deny.

dhcp-bindings—Logging on DHCP binding matches is reset to log on deny.

If neither the acl-match or the dhcp-bindings keywords are specified, all denied packets are logged.

The implicit deny at the end of an ACL does not include the log keyword. This means that when you use the static keyword in the ip arp inspection filter vlan global configuration command, the ACL overrides the DHCP bindings. Some denied packets might not be logged unless you explicitly specify the deny ip any mac any log ACE at the end of the ARP ACL.

Examples

This example shows how to configure ARP inspection on VLAN 1 to log packets that match the permit commands in the ACL:

Switch(config)# arp access-list test1
Switch(config-arp-nacl)# permit request ip any mac any log
Switch(config-arp-nacl)# permit response ip any any mac any any log
Switch(config-arp-nacl)# exit
Switch(config)# ip arp inspection vlan 1 logging acl-match matchlog 

You can verify your settings by entering the show ip arp inspection vlan vlan-range privileged EXEC command.

Related Commands

Command
Description

arp access-list

Defines an ARP ACL.

clear ip arp inspection log

Clears the dynamic ARP inspection log buffer.

ip arp inspection log-buffer

Configures the dynamic ARP inspection logging buffer.

show ip arp inspection log

Displays the configuration and contents of the dynamic ARP inspection log buffer.

show ip arp inspection vlan vlan-range

Displays the configuration and the operating state of dynamic ARP inspection for the specified VLAN.


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

This command was introduced.


Usage Guidelines

For any DHCP snooping configuration to take effect, you must globally enable DHCP snooping.

DHCP snooping is not active until you enable snooping 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 binding

Use the ip dhcp snooping binding privileged EXEC command to configure the DHCP snooping binding database and to add binding entries to the database. Use the no form of this command to delete entries from the binding database.

ip dhcp snooping binding mac-address vlan vlan-id ip-address interface interface-id expiry seconds

no ip dhcp snooping binding mac-address vlan vlan-id ip-address interface interface-id

Syntax Description

mac-address

Specify a MAC address.

vlan vlan-id

Specify a VLAN number. The range is from 1 to 4904.

ip-address

Specify an IP address.

interface interface-id

Specify an interface on which to add or delete a binding entry.

expiry seconds

Specify the interval (in seconds) after which the binding entry is no longer valid. The range is from 1 to 4294967295.


Defaults

No default database is defined.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Use this command when you are testing or debugging the switch.

In the DHCP snooping binding database, each database entry, also referred to a binding, has an IP address, an associated MAC address, the lease time (in hexadecimal format), the interface to which the binding applies, and the VLAN to which the interface belongs. The database can have up to 8192 bindings.

Use the show ip dhcp snooping binding privileged EXEC command to display only the dynamically configured bindings. Use the show ip source binding privileged EXEC command to display the dynamically and statically configured bindings.

Examples

This example shows how to generate a DHCP binding configuration with an expiration time of 1000 seconds on a port in VLAN 1:

Switch# ip dhcp snooping binding 0001.1234.1234 vlan 1 172.20.50.5 interface 
gigabitethernet0/1 expiry 1000

You can verify your settings by entering the show ip dhcp snooping binding or the show ip dhcp source binding privileged EXEC command.

Related Commands

Command
Description

ip dhcp snooping

Enables DHCP snooping on a VLAN.

show ip dhcp snooping binding

Displays the dynamically configured bindings in the DHCP snooping binding database and the configuration information.

show ip source binding

Displays the dynamically and statically configured bindings in the DHCP snooping binding database.


ip dhcp snooping database

Use the ip dhcp snooping database global configuration command to configure the DHCP snooping binding database agent. Use the no form of this command to disable the agent, to reset the timeout value, or to reset the write-delay value.

ip dhcp snooping database {{flash:/filename | ftp://user:password@host/filename | http://[[username:password]@]{hostname | host-ip}[/directory]/image-name.tar | rcp://user@host/filename | tftp://host/filename} | timeout seconds | write-delay seconds}

no ip dhcp snooping database [timeout | write-delay]

Syntax Description

flash:/filename

Specify that the database agent or the binding file is in the flash memory.

ftp://user:password@host/filename

Specify that the database agent or the binding file is on an FTP server.

http://[[username:password]@]
{hostname | host-ip}[/directory]
/image-name
.tar

Specify that the database agent or the binding file is on an FTP server.

rcp://user@host/filename

Specify that the database agent or the binding file is on a Remote Control Protocol (RCP) server.

tftp://host/filename

Specify that the database agent or the binding file is on a TFTP server.

timeout seconds

Specify (in seconds) when to stop the database transfer process after the DHCP snooping binding database changes.

The default is 300 seconds. The range is from 0 to 86400. Use 0 to define an infinite duration.

write-delay seconds

Specify (in seconds) the duration for which the transfer should be delayed after the binding database changes. The default is 300 seconds. The range is from 15 to 86400.


Defaults

The URL for the database agent or binding file is not defined.

The timeout value is 300 seconds (5 minutes).

The write-delay value is 300 seconds (5 minutes).

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

The DHCP snooping binding database can have up to 8192 bindings.

To ensure that the lease time in the database is accurate, we recommend that Network Time Protocol (NTP) is enabled and configured for these features:

NTP authentication

NTP peer and server associations

NTP broadcast service

NTP access restrictions

NTP packet source IP address

If NTP is configured, the switch writes binding changes to the binding file only when the switch system clock is synchronized with NTP.

Because both NVRAM and the flash memory have limited storage capacity, we recommend that you store a binding file on a TFTP server. You must create an empty file at the configured URL on network-based URLs (such as TFTP and FTP) before the switch can write bindings to the binding file at that URL for the first time.

Use the no ip dhcp snooping database command to disable the agent.

Use the no ip dhcp snooping database timeout command to reset the timeout value.

Use the no ip dhcp snooping database write-delay command to reset the write-delay value.

Examples

This example shows how to store a binding file at an IP address of 10.1.1.1 that is in a directory called directory. A file named file must be present on the TFTP server.

Switch(config)# ip dhcp snooping database tftp://10.1.1.1/directory/file

You can verify your settings by entering the show ip dhcp snooping database privileged EXEC command.

Related Commands

Command
Description

ip dhcp snooping

Enables DHCP snooping on a VLAN.

ip dhcp snooping binding

Configures the DHCP snooping binding database.

show ip dhcp snooping database

Displays the status of DHCP snooping database agent.


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

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

Use the ip dhcp snooping information option allowed-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 allowed-untrusted

no ip dhcp snooping information option allowed-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.2(44)EY

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 allowed-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 allowed-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 allowed-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 information option format remote-id

Use the ip dhcp snooping information option format remote-id global configuration command to configure the option-82 remote-ID suboption. Use the no form of this command to configure the default remote-ID suboption.

ip dhcp snooping information option format remote-id [string ASCII-string | hostname]

no ip dhcp snooping information option format remote-id

Syntax Description

string ASCII-string

Specify a remote ID, using from 1 to 63 ASCII characters (no spaces).

hostname

Specify the switch hostname as the remote ID.


Defaults

The switch MAC address is the remote ID.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

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, the default remote-ID suboption is the switch MAC address. This command allows you to configure either the switch hostname or a string of up to 63 ASCII characters (but no spaces) to be the remote ID.


Note If the hostname exceeds 63 characters, it is truncated to 63 characters in the remote-ID configuration.


Examples

This example shows how to configure the option-82 remote-ID suboption:

Switch(config)# ip dhcp snooping information option format remote-id hostname

You can verify your settings by entering the show ip dhcp snooping user EXEC command.

Related Commands

Command
Description

ip dhcp snooping vlan information option format-type circuit-id string

Configures the option-82 circuit-ID suboption.

show ip dhcp snooping

Displays the DHCP snooping configuration.


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


Defaults

DHCP snooping rate limiting is disabled.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

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

This command was introduced.


Usage Guidelines

Configure as trusted ports those that are connected to a DHCP server or to other switches or routers. Configure as untrusted ports those that are connected to DHCP clients.

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 verify mac-address

Use the ip dhcp snooping verify mac-address global configuration command to configure the switch to verify on an untrusted port that the source MAC address in a DHCP packet matches the client hardware address. Use the no form of this command to configure the switch to not verify the MAC addresses.

ip dhcp snooping verify mac-address

no ip dhcp snooping verify mac-address

Syntax Description

This command has no arguments or keywords.

Defaults

The switch verifies the source MAC address in a DHCP packet that is received on untrusted ports matches the client hardware address in the packet.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

In a service-provider network, when a switch receives a packet from a DHCP client on an untrusted port, it automatically verifies that the source MAC address and the DHCP client hardware address match. If the addresses match, the switch forwards the packet. If the addresses do not match, the switch drops the packet.

Examples

This example shows how to disable the MAC address verification:

Switch(config)# no ip dhcp snooping verify mac-address

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.


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

no ip dhcp snooping vlan vlan-range

Syntax Description

vlan vlan-range

Specify a VLAN ID or a 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.2(44)EY

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 dhcp snooping vlan information option format-type circuit-id string

Use the ip dhcp snooping vlan information option format-type circuit-id string interface configuration command to configure the option-82 circuit-ID suboption. Use the no form of this command to configure the default circuit-ID suboption.

ip dhcp snooping vlan vlan information option format-type circuit-id string ASCII-string

no ip dhcp snooping vlan vlan information option format-type circuit-id string

Syntax Description

vlan vlan

Specify the VLAN ID. The range is 1 to 4094.

string ASCII-string

Specify a circuit ID, using from 3 to 63 ASCII characters (no spaces).


Defaults

The switch VLAN and the port identifier, in the format vlan-mod-port, is the default circuit ID.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

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, the default circuit-ID suboption is the switch VLAN and the port identifier, in the format vlan-mod-port. This command allows you to configure a string of ASCII characters to be the circuit ID.


Note When configuring a large number of circuit IDs on a switch, consider the impact of lengthy character strings on the NVRAM or flash memory. If the circuit-ID configurations, combined with other data, exceed the capacity of the NVRAM or the flash memory, an error message appears.


Examples

This example shows how to configure the option-82 circuit-ID suboption:

Switch(config-if)# ip dhcp snooping vlan 250 information option format-type circuit-id 
string customerABC-250-0-0

You can verify your settings by entering the show ip dhcp snooping user EXEC command.


Note The show ip dhcp snooping user EXEC command only displays the global command output, including a remote-ID configuration. It does not display any per-interface, per-VLAN string that you have configured for the circuit ID.


Related Commands

Command
Description

ip dhcp snooping information option format remote-id

Configures the option-82 remote-ID suboption.

show ip dhcp snooping

Displays the DHCP snooping configuration.


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

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 a port.

Switch(config)# interface gigabitethernet0/2
Switch(config-if)# ip igmp filter 22

You can verify your setting by using the show running-config privileged EXEC command and by specifying an interface.

Related Commands

Command
Description

ip igmp profile

Configures the specified IGMP profile number.

show ip dhcp snooping statistics

Displays the characteristics of the specified IGMP profile.

show running-config interface interface-id

Displays the running configuration on the switch interface, including the IGMP profile (if any) that is applied to an interface. For syntax information, select Cisco IOS Configuration Fundamentals Command Reference, Release 12.2 > File Management Commands > Configuration File Management 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

When the maximum number of entries is in the IGMP snooping forwarding table, drop the next IGMP join report. This is the default action.

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 ICMP 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.2(44)EY

This command was introduced.


Usage Guidelines

You can use this command only on Layer 2 physical interfaces and on logical EtherChannel interfaces.

You cannot set IGMP maximum groups for routed ports, switch virtual interfaces (SVIs), or 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, when 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 a port can join.

Switch(config)# interface gigabitethernet0/2
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 privileged EXEC command and by specifying an interface.

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, Release 12.2 > File Management Commands > Configuration File Management 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.2(44)EY

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(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 dhcp snooping statistics

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 on the switch or to enable it on a per-VLAN basis. Use the no form of this command to return to the default setting.

ip igmp snooping [vlan vlan-id]

no ip igmp snooping [vlan vlan-id]

Syntax Description

vlan vlan-id

(Optional) Enable IGMP snooping on the specified VLAN. The range is 1 to 1001 and 1006 to 4094.


Defaults

IGMP snooping is globally enabled on the switch.

IGMP snooping is enabled on VLAN interfaces.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

When IGMP snooping is enabled globally, it is enabled in all the existing VLAN interfaces. When IGMP snooping is disabled globally, it is disabled on all the existing VLAN interfaces.

VLAN IDs 1002 to 1005 are reserved for Token Ring and FDDI VLANs and cannot be used in IGMP snooping.

Examples

This example shows how to globally enable IGMP snooping:

Switch(config)# ip igmp snooping

This example shows how to enable IGMP snooping on VLAN 1:

Switch(config)# ip igmp snooping vlan 1

You can verify your settings by entering the show ip igmp snooping privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping report-suppression

Enables IGMP report suppression.

show ip igmp snooping

Displays the snooping configuration.

show ip igmp snooping groups

Displays IGMP snooping multicast information.

show ip igmp snooping mrouter

Displays the IGMP snooping router ports.

show ip igmp snooping querier detail

Displays the configuration and operation information for the IGMP querier configured on a switch.


ip igmp snooping last-member-query-interval

Use the ip igmp snooping last-member-query-interval global configuration command to enable the Internet Group Management Protocol (IGMP) configurable-leave timer globally or on a per-VLAN basis. Use the no form of this command to return to the default setting.

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

(Optional) Enable IGMP snooping and the leave timer on the specified VLAN. The range is 1 to 1001 and 1006 to 4094.

time

Interval time out in seconds. The range is 100 to 32768 milliseconds.


t

Defaults

The default timeout setting is 1000 milliseconds.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

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.

VLAN IDs 1002 to 1005 are reserved for Token Ring and FDDI VLANs and cannot be used in IGMP snooping.

Configuring the leave timer on a VLAN overrides the global setting.

The IGMP configurable leave time is only supported on devices running IGMP Version 2.

The configuration is saved in NVRAM.

Examples

This example shows how to globally enable the IGMP leave timer for 2000 milliseconds:

Switch(config)# ip igmp snooping last-member-query-interval 2000

This example shows how to configure the IGMP leave timer for 3000 milliseconds on VLAN 1:

Switch(config)# ip igmp snooping vlan 1 last-member-query-interval 3000

You can verify your settings by entering the show ip igmp snooping privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping

Enables IGMP snooping on the switch or 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 querier

Use the ip igmp snooping querier global configuration command to globally enable the Internet Group Management Protocol (IGMP) querier function in Layer 2 networks. Use the command with keywords to enable and configure the IGMP querier feature on a VLAN interface. Use the no form of this command to return to the default settings.

ip igmp snooping querier [vlan vlan-id] [address ip-address | max-response-time response-time | query-interval interval-count | tcn query [count count | interval interval] | timer expiry | version version]

no ip igmp snooping querier [vlan vlan-id] [address | max-response-time | query-interval | tcn querycount count | interval interval} | timer expiry | version]

Syntax Description

vlan vlan-id

(Optional) Enable IGMP snooping and the IGMP querier function on the specified VLAN. The range is 1 to 1001 and 1006 to 4094.

address ip-address

(Optional) Specify a source IP address. If you do not specify an IP address, the querier tries to use the global IP address configured for the IGMP querier.

max-response-time response-time

(Optional) Set the maximum time to wait for an IGMP querier report. The range is 1 to 25 seconds.

query-interval interval-count

(Optional) Set the interval between IGMP queriers. The range is 1 to 18000 seconds.

tcn query [count count | interval interval]

(Optional) Set parameters related to Topology Change Notifications (TCNs). The keywords have these meanings:

count count—Set the number of TCN queries to be executed during the TCN interval time. The range is 1 to 10.

interval interval—Set the TCN query interval time. The range is 1 to 255.

timer expiry

(Optional) Set the length of time until the IGMP querier expires. The range is 60 to 300 seconds.

version version

(Optional) Select the IGMP version number that the querier feature uses. Select 1 or 2.


Defaults

The IGMP snooping querier feature is globally disabled on the switch.

When enabled, the IGMP snooping querier disables itself if it detects IGMP traffic from a multicast-enabled device.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

Use this command to enable IGMP snooping to detect the IGMP version and IP address of a device that sends IGMP query messages, which is also called a querier.

By default, the IGMP snooping querier is configured to detect devices that use IGMP Version 2 (IGMPv2) but does not detect clients that are using IGMP Version 1 (IGMPv1). You can manually configure the max-response-time value when devices use IGMPv2. You cannot configure the max-response-time when devices use IGMPv1. (The value cannot be configured and is set to zero).

Non-RFC compliant devices running IGMPv1 might reject IGMP general query messages that have a non-zero value as the max-response-time value. If you want the devices to accept the IGMP general query messages, configure the IGMP snooping querier to run IGMPv1.

VLAN IDs 1002 to 1005 are reserved for Token Ring and FDDI VLANs and cannot be used in IGMP snooping.

Examples

This example shows how to globally enable the IGMP snooping querier feature:

Switch(config)# ip igmp snooping querier

This example shows how to set the IGMP snooping querier maximum response time to 25 seconds:

Switch(config)# ip igmp snooping querier max-response-time 25

This example shows how to set the IGMP snooping querier interval time to 60 seconds:

Switch(config)# ip igmp snooping querier query-interval 60

This example shows how to set the IGMP snooping querier TCN query count to 25:

Switch(config)# ip igmp snooping querier tcn count 25

This example shows how to set the IGMP snooping querier timeout to 60 seconds:

Switch(config)# ip igmp snooping querier timeout expiry 60

This example shows how to set the IGMP snooping querier feature to version 2:

Switch(config)# ip igmp snooping querier version 2

You can verify your settings by entering the show ip igmp snooping privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping report-suppression

Enables IGMP report suppression.

show ip igmp snooping

Displays the IGMP snooping configuration.

show ip igmp snooping groups

Displays IGMP snooping multicast information.

show ip igmp snooping mrouter

Displays the IGMP snooping router ports.


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 to 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.2(44)EY

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

You can verify your settings by entering the show ip igmp snooping privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping

Enables IGMP snooping on the switch or on a VLAN.

show ip igmp snooping

Displays the IGMP snooping configuration of the switch or the VLAN.


ip igmp snooping tcn

Use the ip igmp snooping tcn global configuration command to configure the Internet Group Management Protocol (IGMP) Topology Change Notification (TCN) behavior. Use the no form of this command to return to the default settings.

ip igmp snooping tcn {flood query count count | query solicit}

no ip igmp snooping tcn {flood query count | query solicit}

Syntax Description

flood query count count

Specify the number of IGMP general queries for which the multicast traffic is flooded. The range is 1 to 10.

query solicit

Send an IGMP leave message (global leave) to speed the process of recovering from the flood mode caused during a TCN event.


Defaults

The TCN flood query count is 2.

The TCN query solicitation is disabled.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

You can prevent the loss of the multicast traffic that might occur because of a topology change by using this command. If you set the TCN flood query count to 1 by using the ip igmp snooping tcn flood query count command, the flooding stops after receiving one general query. If you set the count to 7, the flooding of multicast traffic due to the TCN event lasts until seven general queries are received. Groups are relearned based on the general queries received during the TCN event.

Examples

This example shows how to specify 7 as the number of IGMP general queries for which the multicast traffic is flooded:

Switch(config)# no ip igmp snooping tcn flood query count 7

You can verify your settings by entering the show ip igmp snooping privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping

Enables IGMP snooping on the switch or on a VLAN.

ip igmp snooping tcn flood

Specifies flooding on an interface as the IGMP snooping spanning-tree TCN behavior.

show ip igmp snooping

Displays the IGMP snooping configuration of the switch or the VLAN.


ip igmp snooping tcn flood

Use the ip igmp snooping tcn flood interface configuration command to specify multicast flooding as the Internet Group Management Protocol (IGMP) snooping spanning-tree Topology Change Notification (TCN) behavior. Use the no form of this command to disable the multicast flooding.

ip igmp snooping tcn flood

no ip igmp snooping tcn flood

Syntax Description

This command has no arguments or keywords.

Defaults

Multicast flooding is enabled on an interface during a spanning-tree TCN event.

Command Modes

Interface configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

When the switch receives a TCN, multicast traffic is flooded to all the ports until two general queries are received. If the switch has many ports with attached hosts that are subscribed to different multicast groups, this flooding behavior might not be desirable because the flooded traffic might exceed the capacity of the link and cause packet loss.

You can change the flooding query count by using the ip igmp snooping tcn flood query count count global configuration command.

Examples

This example shows how to disable the multicast flooding on an interface:

Switch(config)# interface gigabitethernet0/2
Switch(config-if)# no ip igmp snooping tcn flood

You can verify your settings by entering the show ip igmp snooping privileged EXEC command.

Related Commands

Command
Description

ip igmp snooping

Enables IGMP snooping on the switch or on a VLAN.

ip igmp snooping tcn

Configures the IGMP TCN behavior on the switch.

show ip igmp snooping

Displays the IGMP snooping configuration of the switch or the VLAN.


ip igmp snooping vlan immediate-leave

Use the ip igmp snooping vlan vlan-id immediate-leave global configuration command to enable Internet Group Management Protocol (IGMP) snooping immediate-leave processing on a per-VLAN basis. Use the no form of this command to return to the default setting.

ip igmp snooping vlan vlan-id immediate-leave

no ip igmp snooping vlan vlan-id immediate-leave

Syntax Description

vlan-id

Enable IGMP snooping and the Immediate-Leave feature on the specified VLAN. The range is 1 to 1001 and 1006 to 4094.


Defaults

IGMP immediate-leave processing is disabled.

Command Modes

Global configuration

Command History

Release
Modification

12.2(44)EY

This command was introduced.


Usage Guidelines

VLAN IDs 1002 to 1005 are reserved for Token Ring and FDDI VLANs and cannot be used in IGMP snooping.

You should only configure the Immediate Leave feature when there is a maximum of one receiver on every port in the VLAN. The 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 immedi