Ecs4130-28t Cli-R01 20210706
Ecs4130-28t Cli-R01 20210706
Ecs4130-28t Cli-R01 20210706
www.edge-core.com
CLI Reference Guide
ECS4130-28T
L2 Gigabit switch
with 24 1000BASE-T RJ-45 ports
and 4 10G SFP+ ports
E072021-CS-R01
How to Use This Guide
This guide includes detailed information on the switch software, including how to
operate and use the management functions of the switch. To deploy this switch
effectively and ensure trouble-free operation, you should first read the relevant
sections in this guide so that you are familiar with all of its software features.
Who Should Read This This guide is for network administrators who are responsible for operating and
Guide? maintaining network equipment. The guide assumes a basic working knowledge of
LANs (Local Area Networks), the Internet Protocol (IP), and Simple Network
Management Protocol (SNMP).
How This Guide is This guide describes the switch’s command line interface (CLI). For more detailed
Organized information on the switch’s key features or information about the web browser
management interface refer to the Web Management Guide.
Related This guide focuses on switch software configuration through the CLI.
Documentation
For information on how to manage the switch through the Web management
interface, see the following guide:
For information on how to install the switch, see the following guide:
For all safety information and regulatory statements, see the following documents:
– 3 –
How to Use This Guide
Conventions The following conventions are used throughout this guide to show information:
Caution: Alerts you to a potential hazard that could cause loss of data, or damage
the system or equipment.
Documentation This documentation is provided for general information purposes only. If any
Notice product feature details in this documentation conflict with the product datasheet,
refer to the datasheet for the latest information.
Revision History This section summarizes the changes in each revision of this guide.
– 4 –
Contents
Contents 5
Tables 37
– 5 –
Contents
Configuring NTP 69
3 General Commands 85
prompt 85
reload (Global Configuration) 86
enable 87
quit 88
show history 88
configure 89
disable 90
reload (Privileged Exec) 90
show reload 91
end 91
exit 91
– 6 –
Contents
– 7 –
Contents
– 8 –
Contents
– 9 –
Contents
– 10 –
Contents
– 11 –
Contents
– 12 –
Contents
– 13 –
Contents
– 14 –
Contents
– 15 –
Contents
– 16 –
Contents
– 17 –
Contents
– 18 –
Contents
speed-duplex 403
clear counters 404
show discard 405
show interfaces brief 405
show interfaces counters 406
show interfaces history 410
show interfaces status 412
show interfaces switchport 413
Transceiver Threshold Configuration 415
transceiver-monitor 415
transceiver-threshold-auto 415
transceiver-threshold current 416
transceiver-threshold rx-power 417
transceiver-threshold temperature 418
transceiver-threshold tx-power 419
transceiver-threshold voltage 420
show interfaces transceiver 421
show interfaces transceiver-threshold 422
Cable Diagnostics 423
test cable-diagnostics 423
show cable-diagnostics 424
Power Savings 425
power-save 425
show power-save 426
– 19 –
Contents
– 20 –
Contents
– 21 –
Contents
– 22 –
Contents
– 23 –
Contents
– 24 –
Contents
– 25 –
Contents
– 26 –
Contents
control-plane 641
service-policy 642
show policy-map control-plane 642
– 27 –
Contents
– 28 –
Contents
– 29 –
Contents
– 30 –
Contents
– 31 –
Contents
– 32 –
Contents
host 798
lease 799
netbios-name-server 800
netbios-node-type 800
network 801
next-server 802
option 803
clear ip dhcp binding 803
show ip dhcp binding 804
show ip dhcp 805
show ip dhcp pool 805
– 33 –
Contents
– 34 –
Contents
A Troubleshooting 877
Problems Accessing the Management Interface 877
Using System Logs 878
– 35 –
Contents
– 36 –
Tables
– 37 –
Tables
– 38 –
Tables
– 39 –
Tables
– 40 –
Tables
Table 135: show ipv6 MLD snooping statistics query - display description 699
Table 136: show ipv6 MLD snooping statistics summary - display description 700
Table 137: MLD Filtering and Throttling Commands 701
Table 138: Multicast VLAN Registration for IPv4 Commands 710
Table 139: show mvr - display description 722
Table 140: show mvr interface - display description 724
Table 141: show mvr members - display description 726
Table 142: show mvr statistics input - display description 728
Table 143: show mvr statistics output - display description 728
Table 144: show mvr statistics query - display description 729
Table 145: show mvr statistics summary interface - display description 730
Table 146: show mvr statistics summary interface mvr vlan - description 731
Table 147: LLDP Commands 733
Table 148: LLDP MED Location CA Types 747
Table 149: OAM Commands 757
Table 150: Address Table Commands 769
Table 151: show dns cache - display description 776
Table 152: show hosts - display description 776
Table 153: DHCP Commands 779
Table 154: DHCP Client Commands 779
Table 155: Options 60, 66 and 67 Statements 782
Table 156: Options 55 and 124 Statements 782
Table 157: DHCP Relay Option 82 Commands 788
Table 158: DHCP Server Commands 792
Table 159: IP Interface Commands 807
Table 160: IPv4 Interface Commands 807
Table 161: Basic IP Configuration Commands 808
Table 162: Address Resolution Protocol Commands 815
Table 163: IPv6 Configuration Commands 819
Table 164: show ipv6 interface - display description 831
Table 165: show ipv6 mtu - display description 833
Table 166: show ipv6 traffic - display description 834
Table 167: show ipv6 neighbors - display description 853
Table 168: ND Snooping Commands 855
Table 188: IP Routing Commands 865
– 41 –
Tables
– 42 –
Section I
Getting Started
This section describes how to configure the switch for management access through
the web interface or SNMP.
– 43 –
Section I | Getting Started
– 44 –
1 Initial Switch Configuration
Note: An IPv4 address for the primary network interface (VLAN 1) is set to an initial
192.168.2.10 by default. To change this address, see “Setting an IP Address” on
page 49.
Configuration Options The switch’s HTTP web agent allows you to configure switch parameters, monitor
port connections, and display statistics using a standard web browser such as
Internet Explorer 9+, Mozilla Firefox 52+, Google Chrome 54+, or Opera 41+, or
more recent versions. The switch’s web management interface can be accessed
from any computer attached to the network.
The CLI program can be accessed by a direct connection to the RS-232 serial
console port on the switch, or remotely by a Telnet connection over the network.
The switch’s web interface, console interface, and SNMP agent allow you to
perform the following management functions:
◆ Set user names and passwords
◆ Set an IP interface for any VLAN
◆ Configure SNMP parameters
◆ Enable/disable any port
◆ Set the speed/duplex mode for any port
◆ Configure the bandwidth of any port by limiting input or output rates
– 45 –
Chapter 1 | Initial Switch Configuration
Connecting to the Switch
◆ Control port access through IEEE 802.1X security or static address filtering
◆ Filter packets using Access Control Lists (ACLs)
◆ Configure up to 4094 IEEE 802.1Q VLANs
◆ Enable GVRP automatic VLAN registration
◆ Configure IP routing for unicast traffic
◆ Configure IGMP multicast filtering
◆ Upload and download system firmware or configuration files via HTTP (using
the web interface) or FTP/SFTP/TFTP (using the command line or web interface)
◆ Configure Spanning Tree parameters
◆ Configure Class of Service (CoS) priority queuing
◆ Configure static or LACP trunks (up to 28)
◆ Enable port mirroring
◆ Set storm control on any port for excessive broadcast, multicast, or unknown
unicast traffic
◆ Display system information and statistics
Connecting to the The switch provides an RS-232 serial port that enables a connection to a PC or
Console Port terminal for monitoring and configuring the switch. A null-modem console cable is
provided with the switch.
2. Connect the other end of the cable to the RJ-45 serial port on the switch.
– 46 –
Chapter 1 | Initial Switch Configuration
Connecting to the Switch
Logging Onto the The CLI program provides two different command levels — normal access level
Command Line (Normal Exec) and privileged access level (Privileged Exec). The commands
Interface available at the Normal Exec level are a limited subset of those available at the
Privileged Exec level and allow you to only display information and use basic
utilities. To fully configure the switch parameters, you must access the CLI at the
Privileged Exec level.
Access to both CLI levels are controlled by user names and passwords. The switch
has a default user name and password for each level. To log into the CLI at the
Privileged Exec level using the default user name and password, perform these
steps:
3. At the Password prompt, also enter “admin.” (The password characters are not
displayed on the console screen.)
4. The session is opened and the CLI displays the “Console#” prompt indicating
you have access at the Privileged Exec level.
Setting Passwords If this is your first time to log into the CLI program, you should define new
passwords for both default user names using the “username” command, record
them and put them in a safe place.
1. Open the console interface with the default user name and password “admin”
to access the Privileged Exec level.
3. Type “username guest password 0 password,” for the Normal Exec level, where
password is your new password. Press <Enter>.
– 47 –
Chapter 1 | Initial Switch Configuration
Connecting to the Switch
4. Type “username admin password 0 password,” for the Privileged Exec level,
where password is your new password. Press <Enter>.
Username: admin
Password:
Console#configure
Console(config)#username guest password 0 [password]
Console(config)#username admin password 0 [password]
Console(config)#
Remote Connections Prior to accessing the switch’s onboard agent via a network connection, you must
first configure the network interface with a valid IPv4 or IPv6 address. The default
network interface is VLAN 1 which includes all switch ports.
When configuring the network interface, the IP address, subnet mask, and default
gateway may all be set using a console connection, or DHCP protocol as described
in the following sections.
An IPv4 address for the primary network interface is set to an initial 192.168.2.10 by
default. To manually configure this address or enable dynamic address assignment
via DHCP, see “Setting an IP Address” on page 49.
After configuring the switch’s IP parameters, you can access the onboard
configuration program from anywhere within the attached network. The onboard
configuration program can be accessed using Telnet or SSH from any computer
attached to the network. The switch can also be managed by any computer using a
web browser (Internet Explorer 9, Mozilla Firefox 52, Google Chrome 54, or
Opera 41, or more recent versions), or from a network computer using SNMP
network management software.
– 48 –
Chapter 1 | Initial Switch Configuration
Configuring the Switch for Remote Management
Using the Network The switch can be managed through the operational network, known as in-band
Interface management. Because in-band management traffic is mixed in with operational
network traffic, it is subject to all of the filtering rules usually applied to a standard
network ports such as ACLs and VLAN tagging. In-band network management can
be accessed through a connection to any network port.
Setting an IP Address You must establish IP address information for a switch to obtain management
access through the network. This can be done in either of the following ways:
◆ Manual — You have to input the information, including IP address and subnet
mask. If your management station is not in the same IP subnet as the switch,
you will also need to specify the default gateway router. To configure this
device as the default gateway, use the ip default-gateway command.
Manual Configuration
You can manually assign an IP address to the switch. You may also need to specify a
default gateway that resides between this device and management stations that
exist on another network segment. Valid IPv4 addresses consist of four decimal
numbers, 0 to 255, separated by periods. Anything other than this format will not
be accepted by the CLI program.
Note: The default IPv4 address and subnet mask for VLAN 1 is 192.168.2.10
255.255.255.0, with no defined default gateway.
– 49 –
Chapter 1 | Initial Switch Configuration
Configuring the Switch for Remote Management
1. From the Global Configuration mode prompt, type “interface vlan 1” to access
the interface-configuration mode. Press <Enter>.
3. Type “exit” to return to the global configuration mode prompt. Press <Enter>.
4. To set the IP address of the default gateway for the network to which the switch
belongs, type “ip default-gateway gateway,” where “gateway” is the IP address
of the default gateway. Press <Enter>.
Console(config)#interface vlan 1
Console(config-if)#ip address 192.168.1.5 255.255.255.0
Console(config-if)#exit
Console(config)#ip default-gateway 192.168.1.254
Link Local Address — All link-local addresses must be configured with a prefix in
the range of FE80~FEBF. Remember that this address type makes the switch
accessible over IPv6 for all devices attached to the same local subnet only. Also, if
the switch detects that the address you configured conflicts with that in use by
another device on the subnet, it will stop using the address in question, and
automatically generate a link local address that does not conflict with any other
devices on the local subnet.
To configure an IPv6 link local address for the switch, complete the following steps:
1. From the Global Configuration mode prompt, type “interface vlan 1” to access
the interface-configuration mode. Press <Enter>.
– 50 –
Chapter 1 | Initial Switch Configuration
Configuring the Switch for Remote Management
Console(config)#interface vlan 1
Console(config-if)#ipv6 address FE80::260:3EFF:FE11:6700 link-local
Console(config-if)#ipv6 enable
Console(config-if)#end
Console#show ipv6 interface
VLAN 1 is up
IPv6 is enabled.
Link-local address:
fe80::260:3eff:fe11:6700%1/64
Global unicast address(es):
(None)
Joined group address(es):
ff02::1:ff11:6700
ff02::1
IPv6 link MTU is 1500 bytes
ND DAD is enabled, number of DAD attempts: 3.
ND retransmit interval is 1000 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised router lifetime is 1800 seconds
Console#
Address for Multi-segment Network — Before you can assign an IPv6 address to the
switch that will be used to connect to a multi-segment network, you must obtain
the following information from your network administrator:
◆ Prefix for this network
◆ IP address for the switch
◆ Default gateway for the network
For networks that encompass several different subnets, you must define the full
address, including a network prefix and the host address for the switch. You can
specify either the full IPv6 address, or the IPv6 address and prefix length. The prefix
length for an IPv6 network is the number of bits (from the left) of the prefix that
form the network address, and is expressed as a decimal number. For example, all
IPv6 addresses that start with the first byte of 73 (hexadecimal) could be expressed
as 73:0:0:0:0:0:0:0/8 or 73::/8.
To generate an IPv6 global unicast address for the switch, complete the following
steps:
1. From the global configuration mode prompt, type “interface vlan 1” to access
the interface-configuration mode. Press <Enter>.
2. From the interface prompt, type “ipv6 address ipv6-address” or “ipv6 address
ipv6-address/prefix-length,” where “prefix-length” indicates the address bits
used to form the network portion of the address. (The network address starts
– 51 –
Chapter 1 | Initial Switch Configuration
Configuring the Switch for Remote Management
from the left of the prefix and should encompass some of the ipv6-address
bits.) The remaining bits are assigned to the host interface. Press <Enter>.
3. Type “exit” to return to the global configuration mode prompt. Press <Enter>.
4. To set the IP address of the IPv6 default gateway for the network to which the
switch belongs, type “ipv6 default-gateway gateway,” where “gateway” is the
IPv6 address of the default gateway. Press <Enter>.
Console(config)#interface vlan 1
Console(config-if)#ipv6 address 2001:DB8:2222:7272::/64
Console(config-if)#exit
Console(config)#ipv6 default-gateway 2001:DB8:2222:7272::254
Console(config)end
Console#show ipv6 interface
VLAN 1 is up
IPv6 is enabled.
Link-local address:
fe80::260:3eff:fe11:6700%1/64
Global unicast address(es):
2001:db8:2222:7272::/64, subnet is 2001:db8:2222:7272::/
64[TEN][INVALID][INVAL
ID]
Joined group address(es):
ff02::1:ff00:0
ff02::1:ff11:6700
ff02::1:2
ff02::1
IPv6 link MTU is 1500 bytes
ND DAD is enabled, number of DAD attempts: 3.
ND retransmit interval is 1000 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised router lifetime is 1800 seconds
Dynamic Configuration
Obtaining an IPv4 Address
If you select the “bootp” or “dhcp” option, the system will immediately start
broadcasting service requests. IP will be enabled but will not function until a
BOOTP or DHCP reply has been received. Requests are broadcast every few minutes
using exponential backoff until IP configuration information is obtained from a
BOOTP or DHCP server. BOOTP and DHCP values can include the IP address, subnet
mask, and default gateway. If the DHCP/BOOTP server is slow to respond, you may
need to use the “ip dhcp restart client” command to re-start broadcasting service
requests.
Note that the “ip dhcp restart client” command can also be used to start
broadcasting service requests for all VLANs configured to obtain address
assignments through BOOTP or DHCP. It may be necessary to use this command
– 52 –
Chapter 1 | Initial Switch Configuration
Configuring the Switch for Remote Management
when DHCP is configured on a VLAN, and the member ports which were previously
shut down are now enabled.
If the “bootp” or “dhcp” option is saved to the startup-config file (step 6), then the
switch will start broadcasting service requests as soon as it is powered on.
1. From the Global Configuration mode prompt, type “interface vlan 1” to access
the interface-configuration mode. Press <Enter>.
4. Wait a few minutes, and then check the IP configuration settings by typing the
“show ip interface” command. Press <Enter>.
Console(config)#interface vlan 1
Console(config-if)#ip address dhcp
Console(config-if)#end
Console#show ip interface
VLAN 1 is Administrative Up - Link Up
Address is 00-E0-0C-00-00-FD
Index: 1001, MTU: 1500
Address Mode is DHCP
IP Address: 192.168.0.4 Mask: 255.255.255.0
Proxy ARP is disabled
DHCP Client Vendor Class ID (text): ECS5520-18X
DHCP Relay Server:
Console#copy running-config startup-config
Startup configuration file name []: startup
\Write to FLASH Programming.
– 53 –
Chapter 1 | Initial Switch Configuration
Enabling SNMP Management Access
To generate an IPv6 link local address for the switch, complete the following steps:
1. From the Global Configuration mode prompt, type “interface vlan 1” to access
the interface-configuration mode. Press <Enter>.
2. Type “ipv6 enable” and press <Enter>.
Console(config)#interface vlan 1
Console(config-if)#ipv6 enable
Console(config-if)#end
Console#show ipv6 interface
VLAN 1 is up
IPv6 is enabled.
Link-local address:
fe80::2e0:cff:fe00:fd%1/64
Global unicast address(es):
2001:db8:2222:7272::/64, subnet is 2001:db8:2222:7272::/64
Joined group address(es):
ff02::1:ff00:0
ff02::1:ff11:6700
ff02::1
IPv6 link MTU is 1500 bytes
ND DAD is enabled, number of DAD attempts: 3.
ND retransmit interval is 1000 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised router lifetime is 1800 seconds
Console#
When SNMP management stations send requests to the switch (either to return
information or to set a parameter), the switch provides the requested data or sets
the specified parameter. The switch can also be configured to send information to
SNMP managers (without being requested by the managers) through trap
messages, which inform the manager that certain events have occurred.
The switch includes an SNMP agent that supports SNMP version 1, 2c, and 3 clients.
To provide management access for version 1 or 2c clients, you must specify a
community string. The switch provides a default MIB View (i.e., an SNMPv3
construct) for the default “public” community string that provides read access to
– 54 –
Chapter 1 | Initial Switch Configuration
Enabling SNMP Management Access
the entire MIB tree, and a default view for the “private” community string that
provides read/write access to the entire MIB tree. However, you may assign new
views to version 1 or 2c community strings that suit your specific security
requirements (see snmp-server view command).
◆ public - with read-only access. Authorized management stations are only able
to retrieve MIB objects.
1. From the Privileged Exec level global configuration mode prompt, type “snmp-
server community string mode,” where “string” is the community access string
and “mode” is rw (read/write) or ro (read only). Press <Enter>. (Note that the
default mode is read only.)
Note: If you do not intend to support access to SNMP version 1 and 2c clients, we
recommend that you delete both of the default community strings. If there are no
community strings, then SNMP management access from SNMP v1 and v2c clients
is disabled.
– 55 –
Chapter 1 | Initial Switch Configuration
Enabling SNMP Management Access
Trap Receivers
You can also specify SNMP stations that are to receive traps from the switch. To
configure a trap receiver, use the “snmp-server host” command. From the
Privileged Exec level global configuration mode prompt, type:
“snmp-server host host-address community-string [version {1 | 2c | 3 {auth |
noauth | priv}}]”
where “host-address” is the IP address for the trap receiver, “community-string”
specifies access rights for a version 1/2c host, or is the user name of a version 3 host,
“version” indicates the SNMP client version, and “auth | noauth | priv” means that
authentication, no authentication, or authentication and privacy is used for v3
clients. Then press <Enter>. For a more detailed description of these parameters,
see the snmp-server host command. The following example creates a trap host for
each type of SNMP client.
For a more detailed explanation on how to configure the switch for access from
SNMP v3 clients, refer to “SNMP Commands” on page 177 or to the Web
Management Guide.
– 56 –
Chapter 1 | Initial Switch Configuration
Managing System Files
◆ Diagnostic Code — Software that is run during system boot-up, also known as
POST (Power On Self-Test).
Note: The Boot ROM and Loader cannot be uploaded or downloaded from the
FTP/SFTP/TFTP server. You must follow the instructions in the release notes for new
firmware, or contact your distributor for help.
Due to the size limit of the flash memory, the switch supports only two operation
code files. However, you can have as many diagnostic code files and configuration
files as available flash memory space allows. The available flash memory can be
checked by using the dir command.
In the system flash memory, one file of each type must be set as the start-up file.
During a system boot, the diagnostic and operation code files set as the start-up file
are run, and then the start-up configuration file is loaded.
Note that configuration files should be downloaded using a file name that reflects
the contents or usage of the file settings. If you download directly to the running-
config, the system will reboot, and the settings will have to be copied from the
running-config to a permanent file.
– 57 –
Chapter 1 | Initial Switch Configuration
Managing System Files
Upgrading the The following example shows how to download new firmware to the switch and
Operation Code activate it. The TFTP server could be any standards-compliant server running on
Windows or Linux. When downloading from an FTP server, the logon interface will
prompt for a user name and password configured on the remote server. Note that
“anonymous” is set as the default user name.
File names on the switch are case-sensitive. The destination file name should not
contain slashes (\ or /), and the maximum length for file names is 32 characters for
files on the switch or 128 characters for files on the server. (Valid characters: A-Z,
a-z, 0-9, “.”, “-”)
Console#
Saving or Restoring Configuration commands only modify the running configuration file and are not
Configuration saved when the switch is rebooted. To save all your configuration changes in
Settings nonvolatile storage, you must copy the running configuration file to the start-up
configuration file using the “copy” command.
New startup configuration files must have a name specified. File names on the
switch are case-sensitive, can be from 1 to 31 characters, must not contain slashes
(\ or /), and the leading letter of the file name must not be a period (.). (Valid
characters: A-Z, a-z, 0-9, “.”, “-”, “_”)
There can be more than one user-defined configuration file saved in the switch’s
flash memory, but only one is designated as the “startup” file that is loaded when
the switch boots. The copy running-config startup-config command always sets
the new file as the startup file. To select a previously saved configuration file, use
the boot system config:<filename> command.
– 58 –
Chapter 1 | Initial Switch Configuration
Managing System Files
1. From the Privileged Exec mode prompt, type “copy running-config startup-
config” and press <Enter>.
Console#
1. From the Privileged Exec mode prompt, type “copy tftp startup-config” and
press <Enter>.
3. Enter the name of the startup file stored on the server. Press <Enter>.
4. Enter the name for the startup file on the switch. Press <Enter>.
Success.
Console#
– 59 –
Chapter 1 | Initial Switch Configuration
Installing a Port License File
To verify whether or not a port license is installed on the switch, enter the show
interfaces brief command from the console port. If a port Status displays “License,”
then you need to obtain and install a port license for those ports. Note that a trial
license limits the number of usable ports, whereas a valid license provides full
access to all ports.
◆ System MAC address. Enter the show system command from the console port
to display this information.
Console#show system
System Description : ECS4130-28T-AC
System OID String : 1.3.6.1.4.1.259.10.1.53.102
System Information
System Up Time : 0 days, 3 hours, 46 minutes, and 34.96 seconds
System Name :
System Location :
System Contact :
MAC Address (Unit 1) : 90-3C-B3-8C-44-B2
Web Server : Enabled
Web Server Port : 80
Web Secure Server : Enabled
Web Secure Server Port : 443
Telnet Server : Enabled
Telnet Server Port : 23
Jumbo Frame : Disabled
To install a license, first verify that the switch is configured with a valid IP address
(see “Setting an IP Address” on page 49).
– 60 –
Chapter 1 | Initial Switch Configuration
Automatic Installation of Operation Code and Configuration Settings
Download the corresponding license file as shown in the following example using
the file type number “21”. Note that the license file is named according to the
device MAC address. The network ports will be automatically activated within two
minutes after successful installation.
To verify that a port license is installed on the switch, enter the show interfaces
brief command from the console port.
Usage Guidelines
◆ If this feature is enabled, the switch searches the defined URL once during the
bootup sequence.
◆ FTP (port 21) and TFTP (port 69) are both supported. Note that the TCP/UDP
port bindings cannot be modified to support servers listening on non-standard
ports.
– 61 –
Chapter 1 | Initial Switch Configuration
Automatic Installation of Operation Code and Configuration Settings
◆ The host portion of the upgrade file location URL must be a valid IPv4 IP
address. DNS host names are not recognized. Valid IP addresses consist of four
numbers, 0 to 255, separated by periods.
◆ The path to the directory must also be defined. If the file is stored in the root
directory for the FTP/TFTP service, then use the “/” to indicate this (e.g.,
ftp://192.168.0.1/).
◆ The file name must not be included in the upgrade file location URL. The file
name of the code stored on the remote server must be ECS4130.bix (using
lower case letters as indicated).
◆ The FTP connection is made with PASV mode enabled. PASV mode is needed to
traverse some fire walls, even if FTP traffic is not blocked. PASV mode cannot be
disabled.
◆ Note that the switch itself does not distinguish between upper and lower-case
file names, and only checks to see if the file stored on the server is more recent
than the current runtime image.
◆ If two operation code image files are already stored on the switch’s file system,
then the non-startup image is deleted before the upgrade image is transferred.
◆ The automatic upgrade process will take place in the background without
impeding normal operations (data switching, etc.) of the switch.
◆ During the automatic search and transfer process, the administrator cannot
transfer or update another operation code image, configuration file, public key,
or HTTPS certificate (i.e., no other concurrent file management operations are
possible).
◆ The upgrade operation code image is set as the startup image after it has been
successfully written to the file system.
◆ The switch will send an SNMP trap and make a log entry upon all upgrade
successes and failures.
– 62 –
Chapter 1 | Initial Switch Configuration
Automatic Installation of Operation Code and Configuration Settings
◆ The switch will immediately restart after the upgrade file is successfully written
to the file system and set as the startup image.
1. Specify the TFTP or FTP server to check for new operation code.
■ When specifying a TFTP server, the following syntax must be used, where
filedir indicates the path to the directory containing the new image:
tftp://192.168.0.1[/filedir]/
■ When specifying an FTP server, the following syntax must be used, where
filedir indicates the path to the directory containing the new image:
ftp://[username[:password@]]192.168.0.1[/filedir]/
If the user name is omitted, “anonymous” will be used for the connection. If
the password is omitted a null string (“”) will be used for the connection.
If no user name nor password is required for the connection, then the “@”
character cannot be used in the path name.
This shows how to specify a TFTP server where new code is stored.
This shows how to specify an FTP server where new code is stored.
2. Set the switch to automatically reboot and load the new code after the opcode
upgrade is completed.
3. Set the switch to automatically upgrade the current operational code when a
new version is detected on the server. When the switch starts up and automatic
image upgrade is enabled by this command, the switch will follow these steps
when it boots up:
a. It will search for a new version of the image at the location specified by
upgrade opcode path command. The name for the new image stored on
the FTP/SFTP/TFTP server must be ECS4130.bix. If the switch detects a code
version newer than the one currently in use, it will download the new
image. If two code images are already stored in the switch, the image not
set to start up the system will be overwritten by the new version.
– 63 –
Chapter 1 | Initial Switch Configuration
Automatic Installation of Operation Code and Configuration Settings
b. After the image has been downloaded, the switch will send a trap message
to log whether or not the upgrade operation was successful.
c. It sets the new version as the startup image.
d. It then restarts the system to start using the new image.
Console#show upgrade
Auto Image Upgrade Global Settings:
Status : Enabled
Reload Status : Enabled
Path :
File Name : ECS5520.bix
Console#
Console#dir
File Name Type Startup Modify Time Size(bytes)
-------------------------- -------------- ------- ------------------- -------
Unit 1:
ECS4130_V1.0.3.191.bix OpCode Y 2016-10-17 11:30:26 9027848
Factory_Default_Config.cfg Config N 2015-04-13 13:55:58 455
startup1.cfg Config Y 2015-07-13 04:03:49 1707
----------------------------------------------------------------------------
Free space for compressed user config files: 1355776
Total space: 32 MB
...
Press ENTER to start session
Automatic Upgrade is looking for a new image
New image detected: current version V1.0.3.191; new version V1.0.3.192
Image upgrade in progress
Downloading new image
Flash programming started
Flash programming completed
Success
The switch will now restart
...
Press ENTER to start session
Automatic Upgrade is looking for a new image
No new image detected
User Access Verification
Username: admin
Password:
Console#dir
File Name Type Startup Modify Time Size(bytes)
-------------------------- -------------- ------- ------------------- -------
Unit 1:
– 64 –
Chapter 1 | Initial Switch Configuration
Downloading a Configuration File and Other Parameters from a DHCP Server
Specifying a DHCP DHCP servers index their database of address bindings using the client’s Media
Client Identifier Access Control (MAC) Address or a unique client identifier. The client identifier is
used to identify the vendor class and configuration of the switch to the DHCP
server, which then uses this information to decide on how to service the client or
the type of information to return.
DHCP client Identifier (Option 60) is used by DHCP clients to specify their unique
identifier. The client identifier is optional and can be specified while configuring
DHCP on the primary network interface. DHCP Option 60 is disabled by default.
The general framework for this DHCP option is set out in RFC 2132 (Option 60). This
information is used to convey configuration settings or other identification
information about a client, but the specific string to use should be supplied by your
service provider or network administrator. Options 60 (vendor-class-identifier), 66
(tftp-server-name) and 67 (bootfile-name) statements can be added to the server
daemon’s configuration file as described in the following section.
If the DHCP server has an index entry for a switch requesting service, it should reply
with the TFTP server name and boot file name. Note that the vendor class identifier
can be formatted in either text or hexadecimal, but the format used by both the
client and server must be the same.
Console#config
Console(config)#vlan database
Console(config-vlan)#vlan 2
Console(config-vlan)#exit
Console(config)#interface vlan 2
Console(config-if)#ip dhcp client class-id hex 0000e8666572
Console(config-if)#
– 65 –
Chapter 1 | Initial Switch Configuration
Downloading a Configuration File and Other Parameters from a DHCP Server
If the switch receives information that allows it to download the remote bootup file,
it will save this file to a local buffer, and then restart the provision process.
◆ The bootup configuration file received from a (TFTP or HTTP) server is stored on
the switch with the original file name. If this file name already exists in the
switch, the file is overwritten.
◆ If the name of the bootup configuration file is the same as the Factory Default
Configuration file, the download procedure will be terminated, and the switch
will not send any further DHCP client requests.
◆ If the switch does not receive a DHCP response prior to completing the bootup
process, it will continue to send a DHCP client request once a minute. These
requests will only be terminated if the switch’s address is manually configured,
but will resume if the address mode is set back to DHCP.
◆ For IPv4 DHCP, options 60, 66 and 67 statements can be added to the daemon’s
configuration file.
– 66 –
Chapter 1 | Initial Switch Configuration
Downloading a Configuration File and Other Parameters from a DHCP Server
◆ By default, IPv4 DHCP option 66/67 parameters are not carried in a DHCP server
reply. To ask for a DHCP reply with option 66/67 information, the DHCP client
request sent by this switch includes a “parameter request list” asking for this
information. Besides these items, the client request also includes a “vendor
class identifier” that allows the DHCP server to identify the device, and select
the appropriate configuration file for download. This information is included in
Options 55 and 124.
ddns-update-style ad-hoc;
default-lease-time 600;
max-lease-time 7200;
log-facility local7;
server-name "Server1";
Server-identifier 192.168.255.250;
#option 66, 67
option space dynamicProvision code width 1 length 1 hash size 2;
option dynamicProvision.tftp-server-name code 66 = text;
option dynamicProvision.bootfile-name code 67 = text;
– 67 –
Chapter 1 | Initial Switch Configuration
Setting the System Clock
When the SNTP client is enabled, the switch periodically sends a request for a time
update to a configured time server. You can configure up to three time server IP
addresses. The switch will attempt to poll each server in the configured sequence.
◆ Time Zone – You can specify the offset from Coordinated Universal Time (UTC),
also known as Greenwich Mean Time (GMT).
◆ Summer Time/Daylight Saving Time (DST) – In some regions, the time shifts by
one hour in the fall and spring. The switch supports manual entry for one-time
or recurring clock shifts.
Setting the Time To manually set the clock to 14:11:36, April 1st, 2013, enter this command.
Manually
Console#calendar set 14 11 36 1 April 2013
Console#
To set the time shift for summer time, enter a command similar to the following.
– 68 –
Chapter 1 | Initial Switch Configuration
Setting the System Clock
Console#show calendar
Current Time : Jul 28 00:54:20 2015
Time Zone : Japan, 08:00
Summer Time : SUMMER, offset 60 minutes
Apr 2 2013 00:00 to Jun 30 2015 00:00
Summer Time in Effect : Yes
Console#
Configuring SNTP Setting the clock based on an SNTP server can provide more accurate clock
synchronization across network switches than manually-configured time. To
configure SNTP, set the switch as an SNTP client, and then set the polling interval,
and specify a time server as shown in the following example.
Console(config)#sntp client
Console(config)#sntp poll 60
Console(config)#sntp server 10.1.0.19
Console(config)#exit
Console#show sntp
Current Time : Apr 2 16:06:07 2013
Poll Interval : 60 seconds
Current Mode : Unicast
SNTP Status : Enabled
SNTP Server : 10.1.0.19
Current Server : 10.1.0.19
Console#
Configuring NTP Requesting the time from a an NTP server is the most secure method. You can
enable NTP authentication to ensure that reliable updates are received from only
authorized NTP servers. The authentication keys and their associated key number
must be centrally managed and manually distributed to NTP servers and clients.
The key numbers and key values must match on both the server and client.
When more than one time server is configured, the client will poll all of the time
servers, and compare the responses to determine the most reliable and accurate
time update for the switch.
Console(config)#ntp client
Console(config)#ntp authentication-key 45 md5 thisiskey45
Console(config)#ntp authenticate
Console(config)#ntp server 192.168.3.20
– 69 –
Chapter 1 | Initial Switch Configuration
Setting the System Clock
– 70 –
Section II
Command Line Interface
This section provides a detailed description of the Command Line Interface, along
with examples for all of the commands.
– 71 –
Section II | Command Line Interface
– 72 –
2 Using the Command Line
Interface
This chapter describes how to use the Command Line Interface (CLI).
Note: You can only access the console interface through the Master unit in the
stack.
Console Connection To access the switch through the console port, perform these steps:
1. At the console prompt, enter the user name and password. (The default user
names are “admin” and “guest” with corresponding passwords of “admin” and
“guest.”) When the administrator user name and password is entered, the CLI
displays the “Console#” prompt and enters privileged access mode
(i.e., Privileged Exec). But when the guest user name and password is entered,
the CLI displays the “Console>” prompt and enters normal access mode
(i.e., Normal Exec).
3. When finished, exit the session with the “quit” or “exit” command.
After connecting to the system through the console port, the login screen displays:
Username: admin
Password:
Console#
– 73 –
Chapter 2 | Using the Command Line Interface
Accessing the CLI
Telnet Connection Telnet operates over the IP transport protocol. In this environment, your
management station and any network device you want to manage over the
network must have a valid IP address. Valid IP addresses consist of four numbers, 0
to 255, separated by periods. Each address consists of a network portion and host
portion. For example, the IP address assigned to this switch, 10.1.0.1, consists of a
network portion (10.1.0) and a host portion (1).
Note: An IPv4 address for the primary network interface (VLAN 1) is set to an initial
192.168.2.10 by default.
To access the switch through a Telnet session, you must first set the IP address for
the Master unit, and set the default gateway if you are managing the switch from a
different IP subnet. For example,
Console(config)#interface vlan 1
Console(config-if)#ip address 10.1.0.254 255.255.255.0
Console(config-if)#exit
Console(config)#ip default-gateway 10.1.0.254
Console(config)#
After you configure the switch with an IP address, you can open a Telnet session by
performing these steps:
1. From the remote host, enter the Telnet command and the IP address or host
name of the device you want to access.
2. At the prompt, enter the user name and system password. The CLI will display
the “Vty-n#” prompt for the administrator to show that you are using privileged
access mode (i.e., Privileged Exec), or “Vty-n>” for the guest to show that you
are using normal access mode (i.e., Normal Exec), where n indicates the number
of the current Telnet session.
4. When finished, exit the session with the “quit” or “exit” command.
Username: admin
Password:
– 74 –
Chapter 2 | Using the Command Line Interface
Entering Commands
Vty-1#
Note: You can open up to eight sessions to the device via Telnet or SSH.
Entering Commands
This section describes how to enter CLI commands.
Keywords and A CLI command is a series of keywords and arguments. Keywords identify a
Arguments command, and arguments specify configuration parameters. For example, in the
command “show interfaces status ethernet 1/5,” show interfaces and status are
keywords, ethernet is an argument that specifies the interface type, and 1/5
specifies the unit/port.
◆ To enter multiple commands, enter each command in the required order. For
example, to enable Privileged Exec command mode, and display the startup
configuration, enter the following commands. The default password “super” is
used to change from Normal Exec to Privileged Exec mode:
Console>enable
Password:
Console#show startup-config
Minimum The CLI will accept a minimum number of characters that uniquely identify a
Abbreviation command. For example, the command “configure” can be entered as con. If an
entry is ambiguous, the system will prompt for further input.
Command If you terminate input with a Tab key, the CLI will print the remaining characters of a
Completion partial keyword up to the point of ambiguity. In the “logging history” example,
typing log followed by a tab will result in printing the command up to “logging.”
– 75 –
Chapter 2 | Using the Command Line Interface
Entering Commands
Getting Help You can display a brief description of the help system by entering the help
on Commands command. You can also display command syntax by using the “?” character to list
keywords or parameters.
Showing Commands
If you enter a “?” at the command prompt, the system will display the first level of
keywords or command groups. You can also display a list of valid keywords for a
specific command. For example, the command “show system ?” displays a list of
possible show commands:
Console#show ?
access-group Access groups
access-list Access lists
accounting Uses the specified accounting list
arp Information of ARP cache
authorization Information of authorization
auto-traffic-control Auto traffic control information
banner Banner info
bridge-ext Bridge extension information
cable-diagnostics Shows the information of cable diagnostics
calendar Date and time information
class-map Displays class maps
cluster Display cluster
debug State of each debugging option
discard Discard packet
dns DNS information
dos-protection Shows the system dos-protection summary information
dot1q-tunnel dot1q-tunnel
dot1x 802.1X content
dying-gasp Dying gasp information
efm Ethernet First Mile feature
erps Displays ERPS configuration
garp GARP properties
gvrp GVRP interface information
history Shows history information
hosts Host information
interfaces Shows interface information
ip IP information
ipv6 IPv6 information
l2protocol-tunnel Layer 2 protocol tunneling configuration
lacp LACP statistics
line TTY line information
lldp LLDP
log Log records
logging Logging setting
loop Shows the information of loopback
loopback-detection Shows loopback detection information
mac MAC access list
mac-address-table Configuration of the address table
mac-vlan MAC-based VLAN information
management Shows management information
memory Memory utilization
mvr multicast vlan registration
mvr6 IPv6 Multicast VLAN registration
network-access Shows the entries of the secure port.
nlm Show notification log
ntp Network Time Protocol configuration
policy-map Displays policy maps
port Port characteristics
port-channel Port channel information
– 76 –
Chapter 2 | Using the Command Line Interface
Entering Commands
Console#show
Console#show interfaces ?
brief Shows brief interface description
counters Interface counters information
history Historical sample of interface counters information
protocol-vlan Protocol-VLAN information
status Shows interface status
switchport Shows interface switchport information
transceiver Interface of transceiver information
transceiver-threshold Interface of transceiver-threshold information
Console#
Show commands which display more than one page of information (e.g., show
running-config) pause and require you to press the [Space] bar to continue
displaying one more page, the [Enter] key to display one more line, or the [a] key to
display the rest of the information without stopping. You can press any other key to
terminate the display.
– 77 –
Chapter 2 | Using the Command Line Interface
Entering Commands
Partial Keyword If you terminate a partial keyword with a question mark, alternatives that match the
Lookup initial letters are provided. (Remember not to leave a space between the command
and question mark.) For example “s?” shows all the keywords starting with “s.”
Console#show s?
sflow snmp snmp-server sntp spanning-tree
ssh startup-config subnet-vlan system
Console#show s
Negating the Effect of For many configuration commands you can enter the prefix keyword “no” to cancel
Commands the effect of a command or reset the configuration to the default value. For
example, the logging command will log system messages to a host server. To
disable logging, specify the no logging command. This guide describes the
negation effect for all applicable commands.
Using Command The CLI maintains a history of commands that have been entered. You can scroll
History back through the history of commands by pressing the up arrow key. Any
command displayed in the history list can be executed again, or first modified and
then executed.
Using the show history command displays a longer list of recently executed
commands.
Understanding The command set is divided into Exec and Configuration classes. Exec commands
Command Modes generally display information on system status or clear statistical counters.
Configuration commands, on the other hand, modify interface parameters or
enable certain switching functions. These classes are further divided into different
modes. Available commands depend on the selected mode. You can always enter a
question mark “?” at the prompt to display a list of the commands available for the
current mode. The command classes and associated modes are displayed in the
following table:
– 78 –
Chapter 2 | Using the Command Line Interface
Entering Commands
Exec Normal
Privileged
* You must be in Privileged Exec mode to access the Global configuration mode.
You must be in Global Configuration mode to access any of the other configuration modes.
Exec Commands When you open a new console session on the switch with the user name and
password “guest,” the system enters the Normal Exec command mode (or guest
mode), displaying the “Console>” command prompt. Only a limited number of the
commands are available in this mode. You can access all commands only from the
Privileged Exec command mode (or administrator mode). To access Privilege Exec
mode, open a new console session with the user name and password “admin.” The
system will now display the “Console#” command prompt. You can also enter
Privileged Exec mode from within Normal Exec mode, by entering the enable
command, followed by the privileged level password “super.”
To enter Privileged Exec mode, enter the following user names and passwords:
Username: admin
Password: [admin login password]
Console#
Username: guest
Password: [guest login password]
Console>enable
Password: [privileged level password]
Console#
– 79 –
Chapter 2 | Using the Command Line Interface
Entering Commands
Configuration Configuration commands are privileged level commands used to modify switch
Commands settings. These commands modify the running configuration only and are not
saved when the switch is rebooted. To store the running configuration in non-
volatile storage, use the copy running-config startup-config command.
◆ Access Control List Configuration - These commands are used for packet
filtering.
◆ Class Map Configuration - Creates a DiffServ class map for a specified traffic
type.
◆ DHCP Configuration - These commands are used to configure the DHCP server.
◆ IGMP Profile - Sets a profile group and enters IGMP filter profile configuration
mode.
◆ Line Configuration - These commands modify the console port and Telnet
configuration, and include command such as parity and databits.
◆ Policy Map Configuration - Creates a DiffServ policy map for multiple interfaces.
◆ Time Range - Sets a time range for use by other functions, such as Access
Control Lists.
Console#configure
Console(config)#
– 80 –
Chapter 2 | Using the Command Line Interface
Entering Commands
To enter the other modes, at the configuration prompt type one of the following
commands. Use the exit or end command to return to the Privileged Exec mode.
For example, you can use the following commands to enter interface configuration
mode, and then return to Privileged Exec mode
Command Line Commands are not case sensitive. You can abbreviate commands and parameters
Processing as long as they contain enough letters to differentiate them from any other
currently available commands or parameters. You can use the Tab key to complete
partial commands, or enter a partial command followed by the “?” character to
display a list of possible matches. You can also use the following editing keystrokes
for command-line processing:
Ctrl-C Terminates the current task and displays the command prompt.
– 81 –
Chapter 2 | Using the Command Line Interface
Entering Commands
Ctrl-K Deletes all characters from the cursor to the end of the line.
Showing Status There are various “show” commands which display configuration settings or the
Information status of specified processes. Many of these commands will not display any
information unless the switch is properly configured, and in some cases the
interface to which a command applies is up.
For example, if a static router port is configured, the corresponding show command
will not display any information unless IGMP snooping is enabled, and the link for
the static router port is up.
Console#configure
Console(config)#ip igmp snooping vlan 1 mrouter ethernet 1/11
Console(config)#end
Console#show ip igmp snooping mrouter
VLAN M'cast Router Ports Type
---- ------------------- -------
Console#configure
Console(config)#ip igmp snooping
Console(config)#end
Console#show ip igmp snooping mrouter
VLAN M'cast Router Ports Type
---- ------------------- -------
1 Eth 1/11 Static
Console#
– 82 –
Chapter 2 | Using the Command Line Interface
CLI Command Groups
Remote Monitoring Supports statistics, history, alarm and event groups 203
Flow Sampling Used with a remote sFlow Collector to provide an accurate, 211
detailed and real-time overview of the types and levels of
traffic present on the network
User Authentication Configures user names and passwords, command privilege 217
levels, logon access using local or remote authentication,
management access through the web server, Telnet server
and Secure Shell; as well as port security, IEEE 802.1X port
access control, and restricted access based on specified IP
addresses
General Security Measures Segregates traffic for clients attached to common data ports; 283
and prevents unauthorized access by configuring valid static
or dynamic addresses, MAC address authentication, filtering
DHCP requests and replies, and discarding invalid ARP
responses
Access Control List Provides filtering for IPv4 frames (based on address, protocol, 369
TCP/UDP port number or TCP control code), IPv6 frames
(based on address, DSCP traffic class, or next header), or non-
IP frames (based on MAC address or Ethernet type)
Interface Configures the connection parameters for all Ethernet ports, 395
aggregated links, and VLANs
Link Aggregation Statically groups multiple ports into a single logical trunk; 427
configures Link Aggregation Control Protocol for port trunks
Mirror Port Mirrors data to another port for analysis without affecting the 441
data passing through or the performance of the monitored
port
Congestion Control Sets the input/output rate limits, traffic storm thresholds, and 451
thresholds for broadcast and multicast storms which can be
used to trigger configured rate limits or to shut down a port.
Address Table Configures the address table for filtering specified addresses, 483
displays current entries, clears the table, or sets the aging time
Spanning Tree Configures Spanning Tree settings for the switch 493
– 83 –
Chapter 2 | Using the Command Line Interface
CLI Command Groups
VLANs Configures VLAN settings, and defines port membership for 525
VLAN groups; also enables or configures private VLANs,
protocol VLANs, voice VLANs, and QinQ tunneling
Class of Service Sets port priority for untagged frames, selects strict priority or 607
weighted round robin, relative weight for each priority queue,
also sets priority for DSCP
Control Plane Configures a QoS policy for the control-plane interface 641
Multicast Filtering Configures IGMP multicast filtering, query, profile, and proxy 645
parameters; specifies ports attached to a multicast router; also
configures multicast VLAN registration, and IPv6 MLD
snooping
Link Layer Discovery Configures LLDP settings to enable information discovery 733
Protocol about neighbor devices
Dynamic Host Configures DHCP client, relay and server functions 779
Configuration Protocol
The access mode shown in the following tables is indicated by these abbreviations:
– 84 –
3 General Commands
The general commands are used to control the command access mode,
configuration mode, and other basic functions.
show reload Displays the current reload settings, and the time at which next PE
scheduled reload will take place
exit Returns to the previous configuration mode, or exits the CLI any mode
prompt This command customizes the CLI prompt. Use the no form to restore the default
prompt.
Syntax
prompt string
no prompt
string - Any alphanumeric string to use for the CLI prompt.
(Maximum length: 32 characters)
Default Setting
Console
Command Mode
Global Configuration
– 85 –
Chapter 3 | General Commands
Command Usage
This command can be used to set the command line prompt as shown in the
example below. Using the no form of either command will restore the default
command line prompt.
Example
Console(config)#prompt RD2
RD2(config)#
reload This command restarts the system at a specified time, after a specified delay, or at a
(Global Configuration) periodic interval. You can reboot the system immediately, or you can configure the
switch to reset after a specified amount of time. Use the cancel option to remove a
configured setting.
Syntax
reload {at hour minute [{month day | day month} [year]] |
in {hour hours | minute minutes | hour hours minute minutes} |
regulary hour minute [period {daily | weekly day-of-week |
monthly day-of-month}] | cancel [at | in | regulary]}
reload at - A specified time at which to reload the switch.
hour - The hour at which to reload. (Range: 0-23)
minute - The minute at which to reload. (Range: 0-59)
month - The month at which to reload. (january ... december)
day - The day of the month at which to reload. (Range: 1-31)
year - The year at which to reload. (Range: 1970-2037)
reload in - An interval after which to reload the switch.
hours - The number of hours, combined with the minutes, before the
switch resets. (Range: 0-576)
minutes - The number of minutes, combined with the hours, before the
switch resets. (Range: 0-34560)
reload regulary - A periodic interval at which to reload the switch.
hour - The hour at which to reload. (Range: 0-23)
minute - The minute at which to reload. (Range: 0-59)
day-of-week - Day of the week at which to reload.
(Range: monday ... saturday)
day-of-month - Day of the month at which to reload. (Range: 1-31)
reload cancel - Cancels the specified reload option.
Default Setting
None
– 86 –
Chapter 3 | General Commands
Command Mode
Privileged Exec, Global Configuration
Command Usage
◆ This command resets the entire system.
◆ Any combination of reload options may be specified. If the same option is re-
specified, the previous setting will be overwritten.
◆ When the system is restarted, it will always run the Power-On Self-Test. It will
also retain all configuration information stored in non-volatile memory by the
copy running-config startup-config command (See “copy” on page 118).
Example
This example shows how to reset the switch after 30 minutes:
Console(config)#reload in minute 30
***
*** --- Rebooting at January 1 02:10:43 2016 ---
***
Are you sure to reboot the system at the specified time? <y/n>
enable This command activates Privileged Exec mode. In privileged mode, additional
commands are available, and certain commands display additional information.
See “Understanding Command Modes” on page 78.
Syntax
enable [level]
level - Privilege level to log into the device.
The device has two predefined privilege levels: 0: Normal Exec,
15: Privileged Exec. Enter level 15 to access Privileged Exec mode.
Default Setting
Level 15
Command Mode
Normal Exec
Command Usage
◆ “super” is the default password required to change the command mode from
Normal Exec to Privileged Exec. (To set this password, see the enable password
command.)
◆ The “#” character is appended to the end of the prompt to indicate that the
system is in privileged access mode.
– 87 –
Chapter 3 | General Commands
Example
Console>enable
Password: [privileged level password]
Console#
Related Commands
disable (90)
enable password (218)
Default Setting
None
Command Mode
Normal Exec, Privileged Exec
Command Usage
The quit and exit commands can both exit the configuration program.
Example
This example shows how to quit a CLI session:
Console#quit
Username:
show history This command shows the contents of the command history buffer.
Default Setting
None
Command Mode
Normal Exec, Privileged Exec
Command Usage
The history buffer size is fixed at 10 Execution commands and 10 Configuration
commands.
– 88 –
Chapter 3 | General Commands
Example
In this example, the show history command lists the contents of the command
history buffer:
Console#show history
Execution command history:
2 config
1 show history
Console#
The ! command repeats commands from the Execution command history buffer
when you are in Normal Exec or Privileged Exec Mode, and commands from the
Configuration command history buffer when you are in any of the configuration
modes. In this example, the !2 command repeats the second command in the
Execution history buffer (config).
Console#!2
Console#config
Console(config)#
configure This command activates Global Configuration mode. You must enter this mode to
modify any settings on the switch. You must also enter Global Configuration mode
prior to enabling some of the other configuration modes, such as Interface
Configuration, Line Configuration, and VLAN Database Configuration. See
“Understanding Command Modes” on page 78.
Default Setting
None
Command Mode
Privileged Exec
Example
Console#configure
Console(config)#
Related Commands
end (91)
– 89 –
Chapter 3 | General Commands
disable This command returns to Normal Exec mode from privileged mode. In normal
access mode, you can only display basic information on the switch's configuration
or Ethernet statistics. To gain access to all commands, you must use the privileged
mode. See “Understanding Command Modes” on page 78.
Default Setting
None
Command Mode
Privileged Exec
Command Usage
The “>” character is appended to the end of the prompt to indicate that the system
is in normal access mode.
Example
Console#disable
Console>
Related Commands
enable (87)
Note: When the system is restarted, it will always run the Power-On Self-Test. It will
also retain all configuration information stored in non-volatile memory by the copy
running-config startup-config command.
Default Setting
None
Command Mode
Privileged Exec
Command Usage
This command resets the entire system.
Example
This example shows how to reset the switch:
Console#reload
System will be restarted, continue <y/n>? y
– 90 –
Chapter 3 | General Commands
show reload This command displays the current reload settings, and the time at which next
scheduled reload will take place.
Command Mode
Privileged Exec
Example
Console#show reload
Reloading switch in time: 0 hours 29 minutes.
Default Setting
None
Command Mode
Global Configuration, Interface Configuration, Line Configuration, VLAN Database
Configuration, and Multiple Spanning Tree Configuration.
Example
This example shows how to return to the Privileged Exec mode from the Interface
Configuration mode:
Console(config-if)#end
Console#
exit This command returns to the previous configuration mode or exits the
configuration program.
Default Setting
None
Command Mode
Any
– 91 –
Chapter 3 | General Commands
Example
This example shows how to return to the Privileged Exec mode from the Global
Configuration mode, and then quit the CLI session:
Console(config)#exit
Console#exit
Username:
– 92 –
4 System Management
Commands
The system management commands are used to control system logs, passwords,
user names, management options, and display or configure a variety of other
system information.
Line Sets communication parameters for the serial port, including baud rate
and console time-out
Time (System Clock) Sets the system clock automatically via NTP/SNTP server or manually
Time Range Sets a time range for use by other functions, such as Access Control Lists
Device Designation
This section describes commands used to configure information that uniquely
identifies the switch.
– 93 –
Chapter 4 | System Management Commands
Banner Information
hostname This command specifies or modifies the host name for this device. Use the no form
to restore the default host name.
Syntax
hostname name
no hostname
name - The name of this host. (Maximum length: 255 characters)
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ The host name specified by this command is displayed by the show system
command and on the Show > System web page.
Example
Console(config)#hostname RD#1
Console(config)#
Banner Information
These commands are used to configure and manage administrative information
about the switch, its exact data center location, details of the electrical and network
circuits that supply the switch, as well as contact information for the network
administrator and system manager. This information is only available via the CLI
and is automatically displayed before login as soon as a console or telnet
connection has been established.
– 94 –
Chapter 4 | System Management Commands
Banner Information
banner configure ip-lan Configures the IP and LAN information that is displayed by GC
banner
banner configure This command is used to interactively specify administrative information for this
device.
Syntax
banner configure
Default Setting
None
Command Mode
Global Configuration
Command Usage
The administrator can batch-input all details for the switch with one command.
When the administrator finishes typing the company name and presses the enter
key, the script prompts for the next piece of information, and so on, until all
information has been entered. Pressing enter without inputting information at any
prompt during the script’s operation will leave the field empty. Spaces can be used
during script mode because pressing the enter key signifies the end of data input.
The delete and left-arrow keys terminate the script. The use of the backspace key
during script mode is not supported. If, for example, a mistake is made in the
company name, it can be corrected with the banner configure company
command.
Example
Console(config)#banner configure
– 95 –
Chapter 4 | System Management Commands
Banner Information
banner configure This command is used to configure company information displayed in the banner.
company Use the no form to remove the company name from the banner display.
Syntax
banner configure company name
no banner configure company
name - The name of the company. (Maximum length: 32 characters)
Default Setting
None
Command Mode
Global Configuration
Command Usage
Input strings cannot contain spaces. The banner configure company command
interprets spaces as data input boundaries. The use of underscores ( _ ) or other
unobtrusive non-letter characters is suggested for situations where white space is
necessary for clarity.
Example
Console(config)#banner configure company Big-Ben
Console(config)#
– 96 –
Chapter 4 | System Management Commands
Banner Information
banner configure This command is use to configure DC power information displayed in the banner.
dc-power-info Use the no form to restore the default setting.
Syntax
banner configure dc-power-info floor floor-id row row-id rack rack-id
electrical-circuit ec-id
no banner configure dc-power-info [floor | row | rack | electrical-circuit]
floor-id - The floor number.
row-id - The row number.
rack-id - The rack number.
ec-id - The electrical circuit ID.
Maximum length of each parameter: 32 characters
Default Setting
None
Command Mode
Global Configuration
Command Usage
Input strings cannot contain spaces. The banner configure dc-power-info
command interprets spaces as data input boundaries. The use of underscores ( _ )
or other unobtrusive non-letter characters is suggested for situations where white
space is necessary for clarity.
Example
Console(config)#banner configure dc-power-info floor 3 row 15 rack 24
electrical-circuit 48v-id_3.15.24.2
Console(config)#
banner configure This command is used to configure the department information displayed in the
department banner. Use the no form to restore the default setting.
Syntax
banner configure department dept-name
no banner configure department
dept-name - The name of the department.
(Maximum length: 32 characters)
Default Setting
None
– 97 –
Chapter 4 | System Management Commands
Banner Information
Command Mode
Global Configuration
Command Usage
Input strings cannot contain spaces. The banner configure department
command interprets spaces as data input boundaries. The use of underscores ( _ )
or other unobtrusive non-letter characters is suggested for situations where white
space is necessary for clarity.
Example
Console(config)#banner configure department R&D
Console(config)#
banner configure This command is used to configure the equipment information displayed in the
equipment-info banner. Use the no form to restore the default setting.
Syntax
banner configure equipment-info manufacturer-id mfr-id floor floor-id
row row-id rack rack-id shelf-rack sr-id manufacturer mfr-name
no banner configure equipment-info [floor | manufacturer | manufacturer-
id | rack | row | shelf-rack]
mfr-id - The name of the device model number.
floor-id - The floor number.
row-id - The row number.
rack-id - The rack number.
sr-id - The shelf number in the rack.
mfr-name - The name of the device manufacturer.
Maximum length of each parameter: 32 characters
Default Setting
None
Command Mode
Global Configuration
Command Usage
Input strings cannot contain spaces. The banner configure equipment-info
command interprets spaces as data input boundaries. The use of underscores ( _ )
or other unobtrusive non-letter characters is suggested for situations where white
space is necessary for clarity.
– 98 –
Chapter 4 | System Management Commands
Banner Information
Example
Console(config)#banner configure equipment-info manufacturer-id ECS4130-28T
floor 3 row 10 rack 15 shelf-rack 12 manufacturer Edgecore
Console(config)#
banner configure This command is used to configure the equipment location information displayed
equipment-location in the banner. Use the no form to restore the default setting.
Syntax
banner configure equipment-location location
no banner configure equipment-location
location - The address location of the device.
(Maximum length: 32 characters)
Default Setting
None
Command Mode
Global Configuration
Command Usage
Input strings cannot contain spaces. The banner configure equipment-location
command interprets spaces as data input boundaries. The use of underscores ( _ )
or other unobtrusive non-letter characters is suggested for situations where white
space is necessary for clarity.
Example
Console(config)#banner configure equipment-location
710_Network_Path,_Indianapolis
Console(config)#
banner configure This command is used to configure the device IP address and subnet mask
ip-lan information displayed in the banner. Use the no form to restore the default setting.
Syntax
banner configure ip-lan ip-mask
no banner configure ip-lan
ip-mask - The IP address and subnet mask of the device.
(Maximum length: 32 characters)
Default Setting
None
– 99 –
Chapter 4 | System Management Commands
Banner Information
Command Mode
Global Configuration
Command Usage
Input strings cannot contain spaces. The banner configure ip-lan command
interprets spaces as data input boundaries. The use of underscores ( _ ) or other
unobtrusive non-letter characters is suggested for situations where white space is
necessary for clarity.
Example
Console(config)#banner configure ip-lan 192.168.1.1/255.255.255.0
Console(config)#
banner configure This command is used to configure the LP number information displayed in the
lp-number banner. Use the no form to restore the default setting.
Syntax
banner configure lp-number lp-num
no banner configure lp-number
lp-num - The LP number. (Maximum length: 32 characters)
Default Setting
None
Command Mode
Global Configuration
Command Usage
Input strings cannot contain spaces. The banner configure lp-number command
interprets spaces as data input boundaries. The use of underscores ( _ ) or other
unobtrusive non-letter characters is suggested for situations where white space is
necessary for clarity.
Example
Console(config)#banner configure lp-number 12
Console(config)#
– 100 –
Chapter 4 | System Management Commands
Banner Information
banner configure This command is used to configure the manager contact information displayed in
manager-info the banner. Use the no form to restore the default setting.
Syntax
banner configure manager-info
name mgr1-name phone-number mgr1-number
[name2 mgr2-name phone-number mgr2-number |
name3 mgr3-name phone-number mgr3-number]
no banner configure manager-info [name1 | name2 | name3]
mgr1-name - The name of the first manager.
mgr1-number - The phone number of the first manager.
mgr2-name - The name of the second manager.
mgr2-number - The phone number of the second manager.
mgr3-name - The name of the third manager.
mgr3-number - The phone number of the third manager.
Maximum length of each parameter: 32 characters
Default Setting
None
Command Mode
Global Configuration
Command Usage
Input strings cannot contain spaces. The banner configure manager-info
command interprets spaces as data input boundaries. The use of underscores ( _ )
or other unobtrusive non-letter characters is suggested for situations where white
space is necessary for clarity.
Example
Console(config)#banner configure manager-info name Albert_Einstein phone-
number 123-555-1212 name2 Lamar phone-number 123-555-1219
Console(config)#
banner configure mux This command is used to configure the mux information displayed in the banner.
Use the no form to restore the default setting.
Syntax
banner configure mux muxinfo
no banner configure mux
muxinfo - The circuit and PVC to which the switch is connected. (Maximum
length: 32 characters)
– 101 –
Chapter 4 | System Management Commands
Banner Information
Default Setting
None
Command Mode
Global Configuration
Command Usage
Input strings cannot contain spaces. The banner configure mux command
interprets spaces as data input boundaries. The use of underscores ( _ ) or other
unobtrusive non-letter characters is suggested for situations where white space is
necessary for clarity.
Example
Console(config)#banner configure mux telco-8734212kx_PVC-1/23
Console(config)#
banner configure note This command is used to configure the note displayed in the banner. Use the no
form to restore the default setting.
Syntax
banner configure note note-info
no banner configure note
note-info - Miscellaneous information that does not fit the other banner
categories, or any other information of importance to users of the switch
CLI. (Maximum length: 150 characters)
Default Setting
None
Command Mode
Global Configuration
Command Usage
Input strings cannot contain spaces. The banner configure note command
interprets spaces as data input boundaries. The use of underscores ( _ ) or other
unobtrusive non-letter characters is suggested for situations where white space is
necessary for clarity.
Example
Console(config)#banner configure note !!!!!ROUTINE_MAINTENANCE_firmware-
upgrade_0100-0500_GMT-0500_20071022!!!!!_20min_network_impact_expected
Console(config)#
– 102 –
Chapter 4 | System Management Commands
System Status
Command Mode
Privileged Exec
Example
Console#show banner
Edgecore
WARNING - MONITORED ACTIONS AND ACCESSES
R&D
Albert_Einstein - 123-555-1212
Lamar - 123-555-1219
Station's information:
710_Network_Path,_Indianapolis
ECS4130-28T
Floor / Row / Rack / Sub-Rack
3/ 10 / 15 / 12
DC power supply:
Power Source A: Floor / Row / Rack / Electrical circuit
3/ 15 / 24 / 48v-id_3.15.24.2
Number of LP: 12
Position MUX: telco-8734212kx_PVC-1/23
IP LAN: 192.168.1.1/255.255.255.0
Note: !!!!!ROUTINE_MAINTENANCE_firmware-upgrade_0100-0500_GMT-
0500_20071022!!!!!_20min_network_
Console#
System Status
This section describes commands used to display system information.
show process cpu guard Shows the CPU utilization watermark and threshold NE
– 103 –
Chapter 4 | System Management Commands
System Status
show users Shows all active console and Telnet sessions, including user NE, PE
name, idle time, and IP address of Telnet clients
show access-list This command shows utilization parameters for TCAM (Ternary Content
tcam-utilization Addressable Memory), including the number policy control entries in use, and the
number of free entries.
Command Mode
Privileged Exec
Command Usage
Policy control entries (PCEs) are used by various system functions which rely on
rule-based searches, including Access Control Lists (ACLs), IP Source Guard filter
rules, Quality of Service (QoS) processes, or traps.
For example, when binding an ACL to a port, each rule in an ACL will use two PCEs;
and when setting an IP Source Guard filter rule for a port, the system will also use
two PCEs.
Example
Console#show access-list tcam-utilization
Pool capability code:
AM - MAC ACL, A4 - IPv4 ACL, A6S - IPv6 Standard ACL,
A6E - IPv6 extended ACL, DM - MAC diffServ, D4 - IPv4 diffServ,
D6S - IPv6 standard diffServ, D6E - IPv6 extended diffServ,
I - IP source guard, C - CPU interface, L - Link local,
Reserved - Reserved, ALL - All supported function,
– 104 –
Chapter 4 | System Management Commands
System Status
Pool Capability Code Abbreviation for processes shown in the TCAM List.
Pool Rule slice (or call group). Each slice has a fixed number of rules that are
used for the specified features.
Total The maximum number of policy control entries allocated to the each
pool.
Used The number of policy control entries used by the operating system.
show memory This command shows memory utilization parameters, and alarm thresholds.
Command Mode
Normal Exec, Privileged Exec
Command Usage
This command shows the amount of memory currently free for use, the amount of
memory allocated to active processes, the total amount of system memory, and the
alarm thresholds.
Example
Console#show memory
Status Bytes %
------ ---------- ---
Free 111706112 41
Used 156729344 59
Total 268435456
Alarm Configuration
Rising Threshold : 95%
Falling Threshold : 90%
Console#
Related Commands
memory (198)
– 105 –
Chapter 4 | System Management Commands
System Status
show process cpu This command shows the CPU utilization parameters, alarm status, and alarm
thresholds.
Command Mode
Normal Exec, Privileged Exec
Example
Console#show process cpu
CPU Utilization in the past 5 seconds : 24%
Alarm Status
Current Alarm Status : Off
Last Alarm Start Time : Dec 31 00:00:19 2000
Last Alarm Duration Time : 15 seconds
Alarm Configuration
Rising Threshold : 90%
Falling Threshold : 70%
Console#
Related Commands
process cpu (199)
show process cpu This command shows the CPU utilization watermark and threshold settings.
guard
Command Mode
Normal Exec, Privileged Exec
Example
Console#show process cpu guard
CPU Guard Configuration
Status : Disabled
High Watermark : 90%
Low Watermark : 70%
Maximum Threshold : 500 packets per second
Minimum Threshold : 50 packets per second
Trap Status : Disabled
CPU Guard Operation
Current Threshold : 500 packets per second
Console#
– 106 –
Chapter 4 | System Management Commands
System Status
High Watermark If the percentage of CPU usage time is higher than the high-watermark,
the switch stops packet flow to the CPU (allowing it to catch up with
packets already in the buffer) until usage time falls below the low
watermark.
Low Watermark If packet flow has been stopped after exceeding the high watermark,
normal flow will be restored after usage falls beneath the low
watermark.
Maximum Threshold If the number of packets being processed by the CPU is higher than the
maximum threshold, the switch stops packet flow to the CPU (allowing
it to catch up with packets already in the buffer) until the number of
packets being processed falls below the minimum threshold.
Minimum Threshold If packet flow has been stopped after exceeding the maximum
threshold, normal flow will be restored after usage falls beneath the
minimum threshold.
Trap Status Shows if an alarm message will be generated when utilization exceeds
the high watermark or exceeds the maximum threshold.
Related Commands
process cpu guard (200)
show process cpu task This command shows the CPU utilization per process.
Command Mode
Privileged Exec
Example
Console#show process cpu task
Task Util (%) Avg (%) Max (%)
--------------- -------- -------- --------
AMTR_ADDRESS 0.00 0.00 0.00
AMTRL3 0.00 0.00 0.00
AMTRL3_GROUP 0.00 0.00 0.00
APP_PROTOCOL_PR 0.00 0.00 0.00
AUTH_GROUP 0.00 0.00 0.00
AUTH_PROC 0.00 0.00 0.00
BGP_TD 0.00 0.00 0.00
CFGDB_TD 0.00 0.00 0.00
CFM_GROUP 0.00 0.00 0.00
CLITASK0 0.00 0.00 0.00
CORE_UTIL_PROC 0.00 0.00 0.00
DHCPSNP_GROUP 0.00 0.00 0.00
DOT1X_SUP_GROUP 0.00 0.00 0.00
DRIVER_GROUP 1.00 0.75 2.00
DRIVER_GROUP_FR 0.00 0.00 0.00
DRIVER_GROUP_TX 0.00 0.00 0.00
– 107 –
Chapter 4 | System Management Commands
System Status
Console#
– 108 –
Chapter 4 | System Management Commands
System Status
show running-config This command displays the configuration information currently in use.
Syntax
show running-config [interface interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
vlan vlan-id (Range: 1-4094)
Command Mode
Privileged Exec
Command Usage
◆ Use the interface keyword to display configuration data for the specified
interface.
◆ This command displays settings for key command modes. Each mode group is
separated by “!” symbols, and includes the configuration mode command, and
corresponding commands. This command displays the following information:
■ MAC address for
■ SNMP community strings
■ Users (names, access levels, and encrypted passwords)
■ VLAN database (VLAN ID, name and state)
■ VLAN configuration settings for each interface
■ Multiple spanning tree instances (name and interfaces)
■ IP address configured for VLANs
■ Spanning tree settings
■ Interface settings
■ Any configured settings for the console port and Telnet
◆ For security reasons, user passwords are only displayed in encrypted format.
Example
Console#show running-config
!<stackingDB>00</stackingDB>
!<stackingMac>01_00-e0-0c-00-00-fd_03</stackingMac>
!
snmp-server community public ro
snmp-server community private rw
!
– 109 –
Chapter 4 | System Management Commands
System Status
Related Commands
show startup-config (110)
show startup-config This command displays the configuration file stored in non-volatile memory that is
used to start up the system.
Command Mode
Privileged Exec
Command Usage
◆ Use this command in conjunction with the show running-config command to
compare the information in running memory to the information stored in non-
volatile memory.
◆ This command displays settings for key command modes. Each mode group is
separated by “!” symbols, and includes the configuration mode command, and
corresponding commands. This command displays the following information:
■ MAC address for
■ SNMP community strings
■ SNMP trap authentication
■ Users (names and access levels)
■ VLAN database (VLAN ID, name and state)
■ Multiple spanning tree instances (name and interfaces)
■ Interface settings and VLAN configuration settings for each interface
■ IP address for VLANs
■ Any configured settings for the console port and Telnet
– 110 –
Chapter 4 | System Management Commands
System Status
Example
Refer to the example for the running configuration file.
Related Commands
show running-config (109)
Default Setting
None
Command Mode
Normal Exec, Privileged Exec
Example
Console#show system
System Description : ECS4130-28T-AC
System OID String : 1.3.6.1.4.1.259.10.1.53.102
System Information
System Up Time : 0 days, 5 hours, 56 minutes, and 8.67 seconds
System Name :
System Location :
System Contact :
MAC Address (Unit 1) : 90-3C-B3-8C-44-B2
Web Server : Enabled
Web Server Port : 80
Web Secure Server : Enabled
Web Secure Server Port : 443
Telnet Server : Enabled
Telnet Server Port : 23
Jumbo Frame : Disabled
Console#
System OID String MIB II object ID for switch’s network management subsystem.
System Up Time Length of time the management agent has been up.
Web Server/Port Shows administrative status of web server and UDP port number.
Web Secure Server/Port Shows administrative status of secure web server and UDP port
number.
– 111 –
Chapter 4 | System Management Commands
System Status
Telnet Server/Port Shows administrative status of Telnet server and TCP port number.
show tech-support This command displays a detailed list of system settings designed to help technical
support resolve configuration or functional problems.
Command Mode
Normal Exec, Privileged Exec
Command Usage
This command generates a long list of information including detailed system and
interface settings. It is therefore advisable to direct the output to a file using any
suitable output capture function provided with your terminal emulation program.
Example
User Access Verification
Username: admin
Password:
Vty-2#show tech-support
dir:
File Name Type Startup Modified Time Size (bytes)
---------------------------- ------- ------- ------------------- ------------
Unit 1:
runtime.bix OpCode Y 2021-05-13 06:08:59 26,657,664
Factory_Default_Config.cfg Config N 2021-04-25 05:46:24 455
startup1.cfg Config Y 2021-04-25 05:46:29 1,526
----------------------------------------------------------------------------
Free space for compressed user config files: 452,464,640
Total space: 1,073,741,824
show arp:
ARP Cache Timeout: 1200 (seconds)
Total entry : 1
– 112 –
Chapter 4 | System Management Commands
System Status
...
show users Shows all active console and Telnet sessions, including user name, idle time, and IP
address of Telnet client.
Default Setting
None
Command Mode
Normal Exec, Privileged Exec
Command Usage
The session used to execute this command is indicated by a “*” symbol next to the
Line (i.e., session) index number.
Example
Console#show users
User Name Accounts:
User Name Privilege Public-Key
-------------------- ---------- ---------------
admin 15 None
guest 0 None
Online Users:
Line Session ID User Name Idle Time (h:m:s) Remote IP Addr
--------- ---------- -------------------- ----------------- -----------------
*Console 0 admin 0:00:01
Console#
show version This command displays hardware and software version information for the system.
Command Mode
Normal Exec, Privileged Exec
Example
Console#show version
Unit 1
Serial Number : EC2103003318
Hardware Version : R0B
Number of Ports : 28
Main Power Status : Up
Role : Master
Loader Version : 0.0.0.4
Linux Kernel Version : 3.10.70
Operation Code Version : 1.0.8.212
– 113 –
Chapter 4 | System Management Commands
System Status
Console#
Main Power Status Displays the status of the main power supply.
Command Mode
Privileged Exec
Example
Console#show watchdog
Software Watchdog Information
Status : Enabled
AutoReload : Enabled
Console#
watchdog software This command monitors key processes, and automatically reboots the system if any
of these processes are not responding correctly.
Syntax
watchdog software {disable | enable}
Default Setting
Disabled
Command Mode
Privileged Exec
Example
Console#watchdog software disable
Console#
– 114 –
Chapter 4 | System Management Commands
Frame Size
Frame Size
This section describes commands used to configure the Ethernet frame size on the
switch.
jumbo frame This command enables support for layer 2 jumbo frames for Gigabit and 10 Gigabit
Ethernet ports. Use the no form to disable it.
Syntax
[no] jumbo frame
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ This switch provides more efficient throughput for large sequential data
transfers by supporting layer 2 jumbo frames on Gigabit and 10 Gigabit
Ethernet ports or trunks up to 10240 bytes. Compared to standard Ethernet
frames that run only up to 1.5 KB, using jumbo frames significantly reduces the
per-packet overhead required to process protocol encapsulation fields.
◆ To use jumbo frames, both the source and destination end nodes (such as a
computer or server) must support this feature. Also, when the connection is
operating at full duplex, all switches in the network between the two end
nodes must be able to accept the extended frame size. And for half-duplex
connections, all devices in the collision domain would need to support jumbo
frames.
◆ The current setting for jumbo frames can be displayed with the show system
command.
Example
Console(config)#jumbo frame
Console(config)#
Related Commands
show system (111)
show ipv6 mtu (832)
– 115 –
Chapter 4 | System Management Commands
File Management
File Management
Managing Firmware
When downloading runtime code, the destination file name can be specified to
replace the current image, or the file can be first downloaded using a different
name from the current runtime code file, and then the new file set as the startup
file.
The configuration file can be downloaded under a new file name and then set as
the startup file, or the current startup configuration file can be specified as the
destination file to directly replace it. Note that the file “Factory_Default_Config.cfg”
can be copied to the FTP/FTPS/SFTP/TFTP server, but cannot be used as the
destination on the switch.
General Commands
boot system Specifies the file or image used to start up the system GC
upgrade opcode auto Automatically upgrades the current image when a new GC
version is detected on the indicated server
upgrade opcode reload Reloads the switch automatically after the opcode upgrade GC
is completed
– 116 –
Chapter 4 | System Management Commands
File Management
ip tftp retry Specifies the number of times the switch can retry GC
transmitting a request to a TFTP server
ip tftp timeout Specifies the time the switch can wait for a response from a GC
TFTP server before retransmitting a request or timing out
for the last retry
General Commands
boot system This command specifies the file or image used to start up the system.
Syntax
boot system {boot-rom | config | opcode}: filename
boot-rom* - Boot ROM.
config* - Configuration file.
opcode* - Run-time operation code.
filename - Name of configuration file or code image.
* The colon (:) is required.
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ A colon (:) is required after the specified file type.
Example
Console(config)#boot system config: startup
Console(config)#
Related Commands
dir (123)
whichboot (124)
– 117 –
Chapter 4 | System Management Commands
File Management
Syntax
copy file {file | ftp | ftps | running-config | sftp | startup-config | tftp | unit |
usbdisk}
copy ftp {add-to-running-config | file | public-key | running-config |
startup-config}
copy running-config {file | ftp | ftps | sftp | startup-config | tftp}
copy startup-config {file | ftp | ftps | running-config | sftp | tftp}
copy tftp {add-to-running-config | file | https-certificate | public-key |
running-config | startup-config}
add-to-running-config - Keyword that adds the settings listed in the
specified file to the running configuration.
file - Keyword that allows you to copy to/from a file.
ftp - Keyword that allows you to copy to/from an FTP server.
ftps - Keyword that allows you to copy to/from an FTPS server.
https-certificate - Keyword that allows you to copy the HTTPS secure site
certificate.
public-key - Keyword that allows you to copy a SSH key from a TFTP server.
(See “Secure Shell” on page 251.)
running-config - Keyword that allows you to copy to/from the current
running configuration.
sftp - Keyword that copies a file to or from an SFTP server.
startup-config - The configuration used for system initialization.
tftp - Keyword that allows you to copy to/from a TFTP server.
unit - Keyword that copies a file to/from a device unit.
usbdisk - Keyword that copies a file to/from a USB device.
Default Setting
None
Command Mode
Privileged Exec
Command Usage
◆ The system prompts for data required to complete the copy command.
– 118 –
Chapter 4 | System Management Commands
File Management
◆ The destination file name should not contain slashes (\ or /), and the maximum
length for file names is 32 characters for files on the switch or 127 characters for
files on the server. (Valid characters: A-Z, a-z, 0-9, “.”, “-”)
◆ The switch supports only two operation code files, but the maximum number
of user-defined configuration files is 16.
◆ The Boot ROM and Loader cannot be uploaded or downloaded from the FTP/
FTPS/SFTP/TFTP server. You must follow the instructions in the release notes for
new firmware, or contact your distributor for help.
◆ The reload command will not be accepted during copy operations to flash
memory.
◆ When logging into an FTP server, the interface prompts for a user name and
password configured on the remote server. Note that “anonymous” is set as the
default user name.
◆ When logging into a remote SFTP/FTPS server, the interface prompts for a user
name and password configured on the remote server. If this is a first time
connection, the system checks to see if the public key offered by the server
matches one stored locally. If not, the server’s public key will be copied to the
local system.
◆ Secure Shell FTP (SFTP) provides a method of transferring files between two
network devices over an SSH2-secured connection. SFTP functions similar to
Secure Copy (SCP), using SSH for user authentication and data encryption.
Although the underlying premises of SFTP are similar to SCP, it requires some
additional steps to verify the protocol versions and perform security checks.
SFTP connection setup includes verification of the DSS signature, creation of
session keys, creation of client-server and server-client ciphers, SSH key
exchange, and user authentication. An SFTP channel is then opened, the SFTP
protocol version compatibility verified, and SFTP finally initialized.
◆ The reload command will not be accepted during copy operations to flash
memory.
– 119 –
Chapter 4 | System Management Commands
File Management
Example
The following example shows how to download new firmware from a TFTP server:
The following example shows how to upload the configuration settings to a file on
the TFTP server:
Console#
The following example shows how to copy the running configuration to a startup
file.
Console#
Console#
– 120 –
Chapter 4 | System Management Commands
File Management
This example shows how to copy a secure-site certificate from an TFTP server. It
then reboots the switch to activate the certificate:
Success.
Console#reload
System will be restarted, continue <y/n>? y
This example shows how to copy a public-key used by SSH from an TFTP server.
Note that public key authentication via SSH is only supported for users configured
locally on the switch.
Console#
This example shows how to copy a file from an SFTP server. Note that the public key
offered by the server is not found on the local system, but is saved locally after the
user selects to continue the copy operation.
– 121 –
Chapter 4 | System Management Commands
File Management
Syntax
delete {file name filename | https-certificate | public-key username}
file - Keyword that allows you to delete a file.
name - Keyword indicating a file.
filename - Name of configuration file or code image.
https-certificate - Keyword that allows you to delete the HTTPS secure site
certificate. You must reboot the switch to load the default certificate.
public-key - Keyword that allows you to delete a SSH key on the switch.
(See “Secure Shell” on page 251.)
username – Name of an SSH user. (Range: 1-8 characters)
Default Setting
None
Command Mode
Privileged Exec
Command Usage
◆ If the file type is used for system startup, then this file cannot be deleted.
Example
This example shows how to delete the test2.cfg configuration file from flash
memory.
Related Commands
dir (123)
delete public-key (256)
– 122 –
Chapter 4 | System Management Commands
File Management
Syntax
dir [unit:] {boot-rom | config | opcode | usbdisk}: [filename]}
unit - Unit identifier. (Range: 1)
boot-rom - Boot ROM (or diagnostic) image file.
config - Switch configuration file.
opcode - Run-time operation code image file.
usbdisk - Installed USB device file.
filename - Name of configuration file or code image. If this file exists but
contains errors, information on this file cannot be shown.
Default Setting
None
Command Mode
Privileged Exec
Command Usage
If you enter the command dir without any parameters, the system displays all files.
Modify Time The date and time the file was last modified.
Example
The following example shows how to display all file information:
Console#dir
File Name Type Startup Modified Time Size (bytes)
------------------------------ ------- ------- ------------------- ------------
Unit 1:
runtime.bix OpCode Y 2021-05-13 06:08:59 26,657,664
Factory_Default_Config.cfg Config N 2021-04-25 05:46:24 455
startup1.cfg Config Y 2021-04-25 05:46:29 1,526
-------------------------------------------------------------------------------
Free space for compressed user config files: 452,464,640
Total space: 1,073,741,824
Console#
– 123 –
Chapter 4 | System Management Commands
File Management
whichboot This command displays which files were booted when the system powered up.
Syntax
whichboot
Default Setting
None
Command Mode
Privileged Exec
Example
This example shows the information displayed by the whichboot command. See
the table under the dir command for a description of the file information displayed
by this command.
Console#whichboot
File Name Type Startup Modified Time Size (bytes)
------------------------------ ------- ------- ------------------- ------------
Unit 1:
runtime.bix OpCode Y 2021-05-13 06:08:59 26,657,664
startup1.cfg Config Y 2021-04-25 05:46:29 1,526
Console#
upgrade opcode auto This command automatically upgrades the current operational code when a new
version is detected on the server indicated by the upgrade opcode path command.
Use the no form of this command to restore the default setting.
Syntax
[no] upgrade opcode auto
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ This command is used to enable or disable automatic upgrade of the
operational code. When the switch starts up and automatic image upgrade is
enabled by this command, the switch will follow these steps when it boots up:
1. It will search for a new version of the image at the location specified by
upgrade opcode path command. The name for the new image stored on
the TFTP server must be ECS4130.bix. If the switch detects a code version
– 124 –
Chapter 4 | System Management Commands
File Management
newer than the one currently in use, it will download the new image. If two
code images are already stored in the switch, the image not set to start up
the system will be overwritten by the new version.
2. After the image has been downloaded, the switch will send a trap message
to log whether or not the upgrade operation was successful.
◆ Any changes made to the default setting can be displayed with the show
running-config or show startup-config commands.
Example
Console(config)#upgrade opcode auto
Console(config)#upgrade opcode path tftp://192.168.0.1/sm24/
Console(config)#
If a new image is found at the specified location, the following type of messages
will be displayed during bootup.
.
.
.
Automatic Upgrade is looking for a new image
New image detected: current version 1.1.1.0; new version 1.1.1.2
Image upgrade in progress
The switch will restart after upgrade succeeds
Downloading new image
Flash programming started
Flash programming completed
The switch will now restart
.
.
.
upgrade opcode path This command specifies an TFTP server and directory in which the new opcode is
stored. Use the no form of this command to clear the current setting.
Syntax
upgrade opcode path opcode-dir-url
no upgrade opcode path
opcode-dir-url - The location of the new code.
Default Setting
None
Command Mode
Global Configuration
– 125 –
Chapter 4 | System Management Commands
File Management
Command Usage
◆ This command is used in conjunction with the upgrade opcode auto command
to facilitate automatic upgrade of new operational code stored at the location
indicated by this command.
◆ The name for the new image stored on the TFTP server must be ECS4130.bix.
However, note that file name is not to be included in this command.
◆ When specifying a TFTP server, the following syntax must be used, where filedir
indicates the path to the directory containing the new image:
tftp://192.168.0.1[/filedir]/
◆ When specifying an FTP server, the following syntax must be used, where filedir
indicates the path to the directory containing the new image:
ftp://[username[:password@]]192.168.0.1[/filedir]/
If the user name is omitted, “anonymous” will be used for the connection. If the
password is omitted a null string (“”) will be used for the connection.
Example
This shows how to specify a TFTP server where new code is stored.
This shows how to specify an FTP server where new code is stored.
upgrade opcode This command reloads the switch automatically after the opcode upgrade is
reload completed. Use the no form to disable this feature.
Syntax
[no] upgrade opcode reload
Default Setting
Disabled
Command Mode
Global Configuration
– 126 –
Chapter 4 | System Management Commands
File Management
Example
This shows how to specify a TFTP server where new code is stored.
show upgrade This command shows the opcode upgrade configuration settings.
Command Mode
Privileged Exec
Example
Console#show upgrade
Auto Image Upgrade Global Settings:
Status : Disabled
Reload Status : Disabled
Path :
File Name : ECS4130.bix
Console#
ip tftp retry This command specifies the number of times the switch can retry transmitting a
request to a TFTP server after waiting for the configured timeout period and
receiving no response. Use the no form to restore the default setting.
Syntax
ip tftp retry retries
no ip tftp retry
retries - The number of times the switch can resend a request to a TFTP
server before it aborts the connection. (Range: 1-16)
Default Setting
15
Command Mode
Global Configuration
Example
Console(config)#ip tftp retry 10
Console(config)#
– 127 –
Chapter 4 | System Management Commands
File Management
ip tftp timeout This command specifies the time the switch can wait for a response from a TFTP
server before retransmitting a request or timing out for the last retry. Use the no
form to restore the default setting.
Syntax
ip tftp timeout seconds
no ip tftp timeout
seconds - The the time the switch can wait for a response from a TFTP server
before retransmitting a request or timing out. (Range: 1-65535 seconds)
Default Setting
5 seconds
Command Mode
Global Configuration
Example
Console(config)#ip tftp timeout 10
Console(config)#
show ip tftp This command displays information about the TFTP settings configured on this
switch.
Syntax
show ip tftp
Command Mode
Privileged Exec
Example
Console#show ip tftp
TFTP Settings:
Retries : 15
Timeout : 5 seconds
Console#
– 128 –
Chapter 4 | System Management Commands
Line
Line
You can access the onboard configuration program by attaching a VT100
compatible device to the server’s serial port. These commands are used to set
communication parameters for the serial port or Telnet (i.e., a virtual terminal).
line Identifies a specific line for configuration and starts the line GC
configuration mode
databits* Sets the number of data bits per character that are LC
interpreted and generated by hardware
exec-timeout Sets the interval that the command interpreter waits until LC
user input is detected
stopbits* Sets the number of the stop bits transmitted per byte LC
timeout login response Sets the interval that the system waits for a login attempt LC
– 129 –
Chapter 4 | System Management Commands
Line
line This command identifies a specific line for configuration, and to process
subsequent line configuration commands.
Syntax
line {console | vty}
console - Console terminal line.
vty - Virtual terminal for remote console access (i.e., Telnet).
Default Setting
There is no default line.
Command Mode
Global Configuration
Command Usage
Telnet is considered a virtual terminal connection and will be shown as “VTY” in
screen displays such as show users. However, the serial communication parameters
(e.g., databits) do not affect Telnet connections.
Example
To enter console line mode, enter the following command:
Console(config)#line console
Console(config-line)#
Related Commands
show line (139)
show users (113)
databits This command sets the number of data bits per character that are interpreted and
generated by the console port. Use the no form to restore the default value.
Syntax
databits {7 | 8}
no databits
7 - Seven data bits per character.
8 - Eight data bits per character.
Default Setting
8 data bits per character
Command Mode
Line Configuration
– 130 –
Chapter 4 | System Management Commands
Line
Command Usage
The databits command can be used to mask the high bit on input from devices
that generate 7 data bits with parity. If parity is being generated, specify 7 data bits
per character. If no parity is required, specify 8 data bits per character.
Example
To specify 7 data bits, enter this command:
Console(config-line-console)#databits 7
Console(config-line-console)#
Related Commands
parity (133)
exec-timeout This command sets the interval that the system waits until user input is detected.
Use the no form to restore the default.
Syntax
exec-timeout [seconds]
no exec-timeout
seconds - Integer that specifies the timeout interval.
(Range: 60 - 65535 seconds; 0: no timeout)
Default Setting
10 minutes
Command Mode
Line Configuration
Command Usage
◆ If user input is detected within the timeout interval, the session is kept open;
otherwise the session is terminated.
◆ This command applies to both the local console and Telnet connections.
◆ Using the command without specifying a timeout restores the default setting.
Example
To set the timeout to two minutes, enter this command:
Console(config-line-console)#exec-timeout 120
Console(config-line-console)#
– 131 –
Chapter 4 | System Management Commands
Line
login This command enables password checking at login. Use the no form to disable
password checking and allow connections without a password.
Syntax
login [local]
no login
local - Selects local password checking. Authentication is based on the user
name specified with the username command.
Default Setting
login local
Command Mode
Line Configuration
Command Usage
◆ There are three authentication modes provided by the switch itself at login:
■ login local selects authentication via the user name and password
specified by the username command (i.e., default setting). When using this
method, the management interface starts in Normal Exec (NE) or Privileged
Exec (PE) mode, depending on the user’s privilege level (0 or 15
respectively).
◆ This command controls login authentication via the switch itself. To configure
user names and passwords for remote authentication servers, you must use the
RADIUS or TACACS software installed on those servers.
Example
Console(config-line-console)#login local
Console(config-line-console)#
Related Commands
username (219)
password (133)
– 132 –
Chapter 4 | System Management Commands
Line
parity This command defines the generation of a parity bit. Use the no form to restore the
default setting.
Syntax
parity {none | even | odd}
no parity
none - No parity
even - Even parity
odd - Odd parity
Default Setting
No parity
Command Mode
Line Configuration
Command Usage
Communication protocols provided by devices such as terminals and modems
often require a specific parity bit setting.
Example
To specify no parity, enter this command:
Console(config-line-console)#parity none
Console(config-line-console)#
password This command specifies the password for a line. Use the no form to remove the
password.
Syntax
password {0 | 7} password
no password
{0 | 7} - 0 means plain password, 7 means encrypted password
password - Character string that specifies the line password.
(Maximum length: 32 characters plain text or encrypted, case sensitive)
Default Setting
No password is specified.
Command Mode
Line Configuration
– 133 –
Chapter 4 | System Management Commands
Line
Command Usage
◆ When a connection is started on a line with password protection, the system
prompts for the password. If you enter the correct password, the system shows
a prompt. You can use the password-thresh command to set the number of
times a user can enter an incorrect password before the system terminates the
line connection and returns the terminal to the idle state.
Example
Console(config-line-console)#password 0 secret
Console(config-line-console)#
Related Commands
login (132)
password-thresh (134)
password-thresh This command sets the password intrusion threshold which limits the number of
failed logon attempts. Use the no form to remove the threshold value.
Syntax
password-thresh [threshold]
no password-thresh
threshold - The number of allowed password attempts. (Range: 1-120; 0: no
threshold)
Default Setting
The default value is three attempts.
Command Mode
Line Configuration
Command Usage
When the logon attempt threshold is reached, the system interface becomes silent
for a specified amount of time before allowing the next logon attempt. (Use the
silent-time command to set this interval.) When this threshold is reached for Telnet,
the Telnet logon interface shuts down.
– 134 –
Chapter 4 | System Management Commands
Line
Example
To set the password threshold to five attempts, enter this command:
Console(config-line-console)#password-thresh 5
Console(config-line-console)#
Related Commands
silent-time (135)
silent-time This command sets the amount of time the management console is inaccessible
after the number of unsuccessful logon attempts exceeds the threshold set by the
password-thresh command. Use the no form to remove the silent time value.
Syntax
silent-time [seconds]
no silent-time
seconds - The number of seconds to disable console response.
(Range: 1-65535; 0 means disabled)
Default Setting
Disabled
Command Mode
Line Configuration
Example
To set the silent time to 60 seconds, enter this command:
Console(config-line-console)#silent-time 60
Console(config-line-console)#
Related Commands
password-thresh (134)
– 135 –
Chapter 4 | System Management Commands
Line
speed This command sets the terminal line’s baud rate. This command sets both the
transmit (to terminal) and receive (from terminal) speeds. Use the no form to
restore the default setting.
Syntax
speed bps
no speed
bps - Baud rate in bits per second.
(Options: 9600, 19200, 38400, 57600, 115200 bps)
Default Setting
115200 bps
Command Mode
Line Configuration
Command Usage
Set the speed to match the baud rate of the device connected to the serial port.
Some baud rates available on devices connected to the port might not be
supported. The system indicates if the speed you selected is not supported.
Example
To specify 57600 bps, enter this command:
Console(config-line-console)#speed 57600
Console(config-line-console)#
stopbits This command sets the number of the stop bits transmitted per byte. Use the no
form to restore the default setting.
Syntax
stopbits {1 | 2}
no stopbits
1 - One stop bit
2 - Two stop bits
Default Setting
1 stop bit
Command Mode
Line Configuration
– 136 –
Chapter 4 | System Management Commands
Line
Example
To specify 2 stop bits, enter this command:
Console(config-line-console)#stopbits 2
Console(config-line-console)#
timeout login This command sets the interval that the system waits for a user to log into the CLI.
response Use the no form to restore the default setting.
Syntax
timeout login response [seconds]
no timeout login response
seconds - Integer that specifies the timeout interval.
(Range: 10 - 300 seconds)
Default Setting
300 seconds
Command Mode
Line Configuration
Command Usage
◆ If a login attempt is not detected within the timeout interval, the connection is
terminated for the session.
◆ This command applies to both the local console and Telnet connections.
◆ Using the command without specifying a timeout restores the default setting.
Example
To set the timeout to two minutes, enter this command:
Syntax
disconnect session-id
session-id – The session identifier for an SSH, Telnet or console connection.
(Range: 0-8)
– 137 –
Chapter 4 | System Management Commands
Line
Command Mode
Privileged Exec
Command Usage
Specifying session identifier “0” will disconnect the console connection. Specifying
any other identifiers for an active session will disconnect an SSH or Telnet
connection.
Example
Console#disconnect 1
Console#
Related Commands
show ssh (259)
show users (113)
Syntax
terminal {escape-character {ASCII-number | character} | history [size size] |
length length | terminal-type {ansi-bbs | vt-100 | vt-102} | width width}
escape-character - The keyboard character used to escape from current
line input.
ASCII-number - ASCII decimal equivalent. (Range: 0-255)
character - Any valid keyboard character.
history - The number of lines stored in the command buffer, and recalled
using the arrow keys. (Range: 0-256)
length - The number of lines displayed on the screen. (Range: 24-200,
where 0 means not to pause)
terminal-type - The type of terminal emulation used.
ansi-bbs - ANSI-BBS
vt-100 - VT-100
vt-102 - VT-102
width - The number of character columns displayed on the terminal.
(Range: 80-300)
Default Setting
Escape Character: 27 (ASCII-number)
History: 10
Length: 24
– 138 –
Chapter 4 | System Management Commands
Line
Command Mode
Privileged Exec
Example
This example sets the number of lines displayed by commands with lengthy output
such as show running-config to 48 lines.
Console#terminal length 48
Console#
Syntax
show line [console | vty]
console - Console terminal line.
vty - Virtual terminal for remote console access (i.e., Telnet).
Default Setting
Shows all lines
Command Mode
Normal Exec, Privileged Exec
Example
To show all lines, enter this command:
Console#show line
Terminal Configuration for this session:
Length : 24
Width : 80
History Size : 10
Escape Character(ASCII-number) : 27
Terminal Type : VT100
Console Configuration:
Password Threshold : 3 times
EXEC Timeout : 600 seconds
Login Timeout : 300 seconds
Silent Time : Disabled
Baud Rate : 115200
Data Bits : 8
Parity : None
Stop Bits : 1
VTY Configuration:
Password Threshold : 3 times
EXEC Timeout : 600 seconds
– 139 –
Chapter 4 | System Management Commands
Event Logging
Event Logging
This section describes commands used to configure event logging on the switch.
logging command Stores CLI command execution records in syslog RAM and GC
flash
logging facility Sets the facility type for remote logging of syslog messages GC
logging host Adds a syslog server host IP address that will receive GC
logging messages
logging level Sets the logging level for user login and log out GC
logging command This command stores CLI command execution records in syslog RAM and flash. Use
the no form to disable this feature.
Syntax
[no] logging command
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
The records stored include the commands executed from the CLI, command
execution time and information about the CLI user including user name, user
interface (console, Telnet, SSH) and user IP address. The severity level for this record
type is 6 (see the logging facility command).
– 140 –
Chapter 4 | System Management Commands
Event Logging
Example
Console(config)#logging facility 19
Console(config)#
logging facility This command sets the facility type for remote logging of syslog messages. Use the
no form to return the type to the default.
Syntax
logging facility type
no logging facility
type - A number that indicates the facility used by the syslog server to
dispatch log messages to an appropriate service. (Range: 16-23)
Default Setting
23
Command Mode
Global Configuration
Command Usage
The command specifies the facility type tag sent in syslog messages. (See RFC
3164.) This type has no effect on the kind of messages reported by the switch.
However, it may be used by the syslog server to sort messages or to store messages
in the corresponding database.
Example
Console(config)#logging facility 19
Console(config)#
logging history This command limits syslog messages saved to switch memory based on severity.
The no form returns the logging of syslog messages to the default level.
Syntax
logging history {flash | ram} level
no logging history {flash | ram}
flash - Event history stored in flash memory (i.e., permanent memory).
ram - Event history stored in temporary RAM (i.e., memory flushed on
power reset).
– 141 –
Chapter 4 | System Management Commands
Event Logging
level - One of the levels listed below. Messages sent include the selected
level down to level 0. (Range: 0-7)
Table 22: Logging Levels
Level Severity Name Description
Default Setting
Flash: errors (level 3 - 0)
RAM: debugging (level 7 - 0)
Command Mode
Global Configuration
Command Usage
The message level specified for flash memory must be a higher priority (i.e.,
numerically lower) than that specified for RAM.
Example
Console(config)#logging history ram 0
Console(config)#
logging host This command adds a syslog server host IP address that will receive logging
messages. Use the no form to remove a syslog server host.
Syntax
logging host host-ip-address [port udp-port]
no logging host host-ip-address
host-ip-address - The IPv4 or IPv6 address of a syslog server.
udp-port - UDP port number used by the remote server. (Range: 1-65535)
Default Setting
UPD Port: 514
– 142 –
Chapter 4 | System Management Commands
Event Logging
Command Mode
Global Configuration
Command Usage
◆ Use this command more than once to build up a list of host IP addresses.
Example
Console(config)#logging host 10.1.0.3
Console(config)#
logging level This command sets the syslog logging severity level for user login and log out. Use
the no form to set the logging level to the default value.
Syntax
logging level {user-login level | user-logout level}
no logging level {user-login | user-logout}
user-login - Specifies the level to log when a user logs in.
user-logout - Specifies the level to log when a user logs out.
level - The syslog severity level to log (Range: 1-7)
Default Setting
6
Command Mode
Global Configuration
Command Usage
Logging severity levels are described in Table 22.
Example
Console(config)#logging level user-login 5
Console(config)#
logging on This command controls logging of error messages, sending debug or error
messages to a logging process. The no form disables the logging process.
Syntax
[no] logging on
– 143 –
Chapter 4 | System Management Commands
Event Logging
Default Setting
None
Command Mode
Global Configuration
Command Usage
The logging process controls error messages saved to switch memory or sent to
remote syslog servers. You can use the logging history command to control the
type of error messages that are stored in memory. You can use the logging trap
command to control the type of error messages that are sent to specified syslog
servers.
Example
Console(config)#logging on
Console(config)#
Related Commands
logging history (141)
logging trap (144)
clear log (145)
logging trap This command enables the logging of system messages to a remote server, or
limits the syslog messages saved to a remote server based on severity. Use this
command without a specified level to enable remote logging. Use the no form to
disable remote logging.
Syntax
logging trap [level level]
no logging trap [level]
level - One of the syslog severity levels listed in the table on page 141.
Messages sent include the selected level through level 0.
Default Setting
Disabled
Level 7
Command Mode
Global Configuration
Command Usage
◆ Using this command with a specified level enables remote logging and sets the
minimum severity level to be saved.
– 144 –
Chapter 4 | System Management Commands
Event Logging
◆ Using this command without a specified level also enables remote logging, but
restores the minimum severity level to the default.
Example
Console(config)#logging trap level 4
Console(config)#
clear log This command clears messages from the log buffer.
Syntax
clear log [flash | ram]
flash - Event history stored in flash memory (i.e., permanent memory).
ram - Event history stored in temporary RAM (i.e., memory flushed on
power reset).
Default Setting
Flash and RAM
Command Mode
Privileged Exec
Example
Console#clear log
Console#
Related Commands
show log (145)
show log This command displays the log messages stored in local memory.
Syntax
show log {flash | ram}
flash - Event history stored in flash memory (i.e., permanent memory).
ram - Event history stored in temporary RAM (i.e., memory flushed on
power reset).
Default Setting
None
Command Mode
Privileged Exec
– 145 –
Chapter 4 | System Management Commands
Event Logging
Command Usage
◆ All log messages are retained in RAM and Flash after a warm restart (i.e., power
is reset through the command interface).
◆ All log messages are retained in Flash and purged from RAM after a cold restart
(i.e., power is turned off and then on through the power source).
Example
The following example shows the event message stored in RAM.
show logging This command displays the configuration settings for logging messages to local
switch memory, to an SMTP event handler, or to a remote syslog server.
Syntax
show logging {level | flash | ram | sendmail | trap}
level - Displays logging levels for user login and log out.
flash - Displays settings for storing event messages in flash memory
(i.e., permanent memory).
ram - Displays settings for storing event messages in temporary RAM
(i.e., memory flushed on power reset).
sendmail - Displays settings for the SMTP event handler (page 151).
trap - Displays settings for the trap function.
Default Setting
None
Command Mode
Privileged Exec
Example
The following example shows that system logging is enabled, the message level for
flash memory is “errors” (i.e., default level 3 - 0), and the message level for RAM is
“debugging” (i.e., default level 7 - 0).
– 146 –
Chapter 4 | System Management Commands
Event Logging
Syslog Logging Shows if system logging has been enabled via the logging on
command.
History Logging in Flash The message level(s) reported based on the logging history command.
History Logging in RAM The message level(s) reported based on the logging history command.
Global Configuration
Syslog logging Shows if system logging has been enabled via the logging on
command.
Status Shows if remote logging has been enabled via the logging trap
command.
Facility Type The facility type for remote logging of syslog messages as specified in
the logging facility command.
Level Type The severity threshold for syslog messages sent to a remote server as
specified in the logging trap command.
Related Commands
show logging sendmail (151)
– 147 –
Chapter 4 | System Management Commands
SMTP Alerts
SMTP Alerts
These commands configure SMTP event handling, and forwarding of alert
messages to the specified SMTP servers and email recipients.
logging sendmail source- Email address used for “From” field of alert messages GC
email
logging sendmail This command enables SMTP event handling. Use the no form to disable this
function.
Syntax
[no] logging sendmail
Default Setting
Enabled
Command Mode
Global Configuration
Example
Console(config)#logging sendmail
Console(config)#
logging sendmail This command specifies the email recipients of alert messages. Use the no form to
destination-email remove a recipient.
Syntax
[no] logging sendmail destination-email email-address
email-address - The source email address used in alert messages.
(Range: 1-41 characters)
– 148 –
Chapter 4 | System Management Commands
SMTP Alerts
Default Setting
None
Command Mode
Global Configuration
Command Usage
You can specify up to five recipients for alert messages. However, you must enter a
separate command to specify each recipient.
Example
Console(config)#logging sendmail destination-email ted@this-company.com
Console(config)#
logging sendmail host This command specifies SMTP servers that will be sent alert messages. Use the no
form to remove an SMTP server.
Syntax
[no] logging sendmail host ip-address
ip-address - IPv4 address of an SMTP server that will be sent alert messages
for event handling.
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ You can specify up to three SMTP servers for event handing. However, you must
enter a separate command to specify each server.
◆ To send email alerts, the switch first opens a connection, sends all the email
alerts waiting in the queue one by one, and finally closes the connection.
◆ To open a connection, the switch first selects the server that successfully sent
mail during the last connection, or the first server configured by this command.
If it fails to send mail, the switch selects the next server in the list and tries to
send mail again. If it still fails, the system will repeat the process at a periodic
interval. (A trap will be triggered if the switch cannot successfully open a
connection.)
Example
Console(config)#logging sendmail host 192.168.1.19
Console(config)#
– 149 –
Chapter 4 | System Management Commands
SMTP Alerts
logging sendmail level This command sets the severity threshold used to trigger alert messages. Use the
no form to restore the default setting.
Syntax
logging sendmail level level
no logging sendmail level
level - One of the system message levels (page 141). Messages sent include
the selected level down to level 0. (Range: 0-7; Default: 7)
Default Setting
Level 7
Command Mode
Global Configuration
Command Usage
The specified level indicates an event threshold. All events at this level or higher will
be sent to the configured email recipients. (For example, using Level 7 will report all
events from level 7 to level 0.)
Example
This example will send email alerts for system errors from level 3 through 0.
logging sendmail This command sets the email address used for the “From” field in alert messages.
source-email Use the no form to restore the default value.
Syntax
logging sendmail source-email email-address
no logging sendmail source-email
email-address - The source email address used in alert messages.
(Range: 1-41 characters)
Default Setting
None
Command Mode
Global Configuration
Command Usage
You may use an symbolic email address that identifies the switch, or the address of
an administrator responsible for the switch.
– 150 –
Chapter 4 | System Management Commands
Time
Example
Console(config)#logging sendmail source-email bill@this-company.com
Console(config)#
show logging This command displays the settings for the SMTP event handler.
sendmail
Command Mode
Privileged Exec
Example
Console#show logging sendmail
SMTP Servers
-----------------------------------------------
192.168.1.19
Time
The system clock can be dynamically set by polling a set of specified time servers
(NTP or SNTP). Maintaining an accurate time on the switch enables the system log
to record meaningful dates and times for event entries. If the clock is not set, the
switch will only record the time from the factory default set at the last bootup.
SNTP Commands
sntp poll Sets the interval at which the client polls for time GC
– 151 –
Chapter 4 | System Management Commands
Time
NTP Commands
ntp client Enables the NTP client for time updates from specified GC
servers
clock summer-time (date) Configures summer time* for the switch’s internal clock GC
clock summer-time Configures summer time* for the switch’s internal clock GC
(predefined)
clock summer-time Configures summer time* for the switch’s internal clock GC
(recurring)
clock timezone Sets the time zone for the switch’s internal clock GC
show calendar Displays the current date and time setting NE, PE
SNTP Commands
sntp client This command enables SNTP client requests for time synchronization from NTP or
SNTP time servers specified with the sntp server command. Use the no form to
disable SNTP client requests.
Syntax
[no] sntp client
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ The time acquired from time servers is used to record accurate dates and times
for log events. Without SNTP, the switch only records the time starting from the
factory default set at the last bootup (e.g., Dec 31 07:32:04 2014).
– 152 –
Chapter 4 | System Management Commands
Time
◆ This command enables client time requests to time servers specified via the
sntp server command. It issues time synchronization requests based on the
interval set via the sntp poll command.
Example
Console(config)#sntp server 10.1.0.19
Console(config)#sntp poll 60
Console(config)#sntp client
Console(config)#end
Console#show sntp
Current Time: Dec 23 02:52:44 2015
Poll Interval: 60
Current Mode: Unicast
SNTP Status : Enabled
SNTP Server 137.92.140.80 0.0.0.0 0.0.0.0
Current Server: 137.92.140.80
Console#
Related Commands
sntp server (154)
sntp poll (153)
show sntp (154)
sntp poll This command sets the interval between sending time requests when the switch is
set to SNTP client mode. Use the no form to restore to the default.
Syntax
sntp poll seconds
no sntp poll
seconds - Interval between time requests. (Range: 16-16384 seconds)
Default Setting
16 seconds
Command Mode
Global Configuration
Example
Console(config)#sntp poll 60
Console#
Related Commands
sntp client (152)
– 153 –
Chapter 4 | System Management Commands
Time
sntp server This command sets the IP address of the servers to which SNTP time requests are
issued. Use the this command with no arguments to clear all time servers from the
current list. Use the no form to clear all time servers from the current list, or to clear
a specific server.
Syntax
sntp server [ip1 [ip2 [ip3]]]
no sntp server [ip1 [ip2 [ip3]]]
ip - IPv4 or IPv6 address of a time server (NTP or SNTP).
(Range: 1 - 3 addresses)
Default Setting
None
Command Mode
Global Configuration
Command Usage
This command specifies time servers from which the switch will poll for time
updates when set to SNTP client mode. The client will poll the time servers in the
order specified until a response is received. It issues time synchronization requests
based on the interval set via the sntp poll command.
Example
Console(config)#sntp server 10.1.0.19
Console#
Related Commands
sntp client (152)
sntp poll (153)
show sntp (154)
show sntp This command displays the current time and configuration settings for the SNTP
client, and indicates whether or not the local time has been properly updated.
Command Mode
Normal Exec, Privileged Exec
Command Usage
This command displays the current time, the poll interval used for sending time
synchronization requests, and the current SNTP mode (i.e., unicast).
– 154 –
Chapter 4 | System Management Commands
Time
Example
Console#show sntp
Current Time : Nov 5 18:51:22 2015
Poll Interval : 16 seconds
Current Mode : Unicast
SNTP Status : Enabled
SNTP Server : 137.92.140.80
: 137.92.140.90
: 137.92.140.99
Current Server : 137.92.140.80
Console#
NTP Commands
ntp authenticate This command enables authentication for NTP client-server communications. Use
the no form to disable authentication.
Syntax
[no] ntp authenticate
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
You can enable NTP authentication to ensure that reliable updates are received
from only authorized NTP servers. The authentication keys and their associated key
number must be centrally managed and manually distributed to NTP servers and
clients. The key numbers and key values must match on both the server and client.
Example
Console(config)#ntp authenticate
Console(config)#
Related Commands
ntp authentication-key (156)
– 155 –
Chapter 4 | System Management Commands
Time
ntp This command configures authentication keys and key numbers to use when NTP
authentication-key authentication is enabled. Use the no form of the command to clear a specific
authentication key or all keys from the current list.
Syntax
ntp authentication-key number md5 key
no ntp authentication-key [number]
number - The NTP authentication key ID number. (Range: 1-65533)
md5 - Specifies that authentication is provided by using the message
digest algorithm 5.
key - An MD5 authentication key string. The key string can be up to 32 case-
sensitive printable ASCII characters (no spaces).
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ The key number specifies a key value in the NTP authentication key list. Up to
255 keys can be configured on the switch. Re-enter this command for each
server you want to configure.
◆ Note that NTP authentication key numbers and values must match on both the
server and client.
Example
Console(config)#ntp authentication-key 45 md5 thisiskey45
Console(config)#
Related Commands
ntp authenticate (155)
– 156 –
Chapter 4 | System Management Commands
Time
ntp client This command enables NTP client requests for time synchronization from NTP time
servers specified with the ntp servers command. Use the no form to disable NTP
client requests.
Syntax
[no] ntp client
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ The SNTP and NTP clients cannot be enabled at the same time. First disable the
SNTP client before using this command.
◆ The time acquired from time servers is used to record accurate dates and times
for log events. Without NTP, the switch only records the time starting from the
factory default set at the last bootup (e.g., Dec 10 16:04:43 2014).
◆ This command enables client time requests to time servers specified via the
ntp servers command. Once enabled the switch will issue time
synchronization requests periodically.
Example
Console(config)#ntp client
Console(config)#
Related Commands
sntp client (152)
ntp server (157)
ntp server This command sets the IP addresses of the servers to which NTP time requests are
sent to. Use the no form of the command to clear a specific time server or all servers
from the current list.
Syntax
ntp server ip-address [key key-number]
no ntp server [ip-address]
ip-address - IP address of an NTP time server.
key-number - The number of an authentication key to use in
communications with the server. (Range: 1-65535)
– 157 –
Chapter 4 | System Management Commands
Time
Default Setting
Version number: 3
Command Mode
Global Configuration
Command Usage
◆ This command specifies time servers that the switch will poll for time updates
when set to NTP client mode. The client will poll all the time servers configured,
the responses received are filtered and compared to determine the most
reliable and accurate time update for the switch.
◆ You can configure up to 3 NTP servers on the switch. Re-enter this command
for each server you want to configure.
◆ Use the no form of this command without an argument to clear all configured
servers in the list.
Example
Console(config)#ntp server 192.168.3.20
Console(config)#ntp server 192.168.3.21
Console(config)#ntp server 192.168.5.23 key 19
Console(config)#
Related Commands
ntp client (157)
show ntp peer-status (160)
show ntp This command displays the current time and configuration settings for the NTP
client, and indicates whether or not the local time has been properly updated from
an NTP server.
Command Mode
Normal Exec, Privileged Exec
Command Usage
This command displays the current time, the poll interval used for sending time
synchronization requests, and the current NTP mode (i.e., unicast).
Example
Console#show ntp
Current Time : Apr 29 13:57:32 2015
Polling Interval : 1024 seconds
Current Mode : unicast
– 158 –
Chapter 4 | System Management Commands
Time
show ntp status This command displays the current status of received time updates from an NTP
peer.
Command Mode
Privileged Exec
Example
Console#show ntp status
System Peer : 192.168.125.88
Leap Indicator : 11
Stratum : 14
Precision : 0.000001907349 seconds
Root Distance : 0.001160 seconds
Root Dispersion : 0.948900 seconds
Reference ID : 192.168.125.88
Reference Time : e0c697a3.6b04c19f Wed, Jul 3 2019 2:55:31.418
Console#
show ntp statistics This command displays the statistics from an NTP peer.
peer
Syntax
show ntp statistics peer {ip-address | ipv6-address | hostname}
ip-address - IP address of an NTP peer.
ipv6-address - IPv6 address of an NTP peer.
hostname - Host name of an NTP peer.
Command Mode
Privileged Exec
Example
Console#show ntp statistics Peer 192.168.125.88
Remote Host : 192.168.125.88
Local Interface : 192.168.125.138
Time Last Received : 223 seconds
Time Until Next Send : 772 seconds
Reachability Change : 229 seconds
Packets Sent : 8
Packets Received : 8
Bad Authentication : 0
– 159 –
Chapter 4 | System Management Commands
Time
Bogus Origin : 0
Duplicate : 0
Bad Dispersion : 0
Bad Reference Time : 0
Candidate Order : 6
Console#
show ntp peer-status This command displays the status of connections to NTP peers.
Syntax
show ntp peer-status [ip-address | ipv6-address | hostname]
ip-address - IP address of an NTP time server.
ipv6-address - IPv6 address of an NTP time server.
hostname - Host name of an NTP time server.
Command Mode
Privileged Exec
Example
Console#show ntp peer-status
* : system peer
Remote Host Local Interface St Poll Reach Delay Offset Dispersion
---------------- --------------- -- ------ ----- -------- -------- ----------
1.1.1.1 0.0.0.0 16 1024 0 0.000000 0.00000 3.99217010
192.168.1.10 0.0.0.0 16 1024 0 0.000000 0.00000 3.99217010
*192.168.125.88 192.168.125.138 13 1024 1 0.001160 -0.00011 0.96824998
Console#
clock summer-time This command sets the start, end, and offset times of summer time (daylight
(date) savings time) for the switch on a one-time basis. Use the no form to disable
summer time.
Syntax
clock summer-time name date b-date b-month b-year b-hour b-minute e-date
e-month e-year e-hour e-minute [offset]
no clock summer-time
name - Name of the time zone while summer time is in effect, usually an
acronym. (Range: 1-30 characters)
b-date - Day of the month when summer time will begin. (Range: 1-31)
b-month - The month when summer time will begin. (Options: january |
february | march | april | may | june | july | august | september | october
| november | december)
– 160 –
Chapter 4 | System Management Commands
Time
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ In some countries or regions, clocks are adjusted through the summer months
so that afternoons have more daylight and mornings have less. This is known as
Summer Time, or Daylight Savings Time (DST). Typically, clocks are adjusted
forward one hour at the start of spring and then adjusted backward in autumn.
◆ This command sets the summer-time time zone relative to the currently
configured time zone. To specify a time corresponding to your local time when
summer time is in effect, you must indicate the number of minutes your
summer-time time zone deviates from your regular time zone (that is, the
offset).
Example
The following example sets the 2014 Summer Time ahead by 60 minutes on March
9th and returns to normal time on November 2nd.
Related Commands
show sntp (154)
– 161 –
Chapter 4 | System Management Commands
Time
clock summer-time This command configures the summer time (daylight savings time) status and
(predefined) settings for the switch using predefined configurations for several major regions in
the world. Use the no form to disable summer time.
Syntax
clock summer-time name predefined [australia | europe | new-zealand |
usa]
no clock summer-time
name - Name of the timezone while summer time is in effect, usually an
acronym. (Range: 1-30 characters)
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ In some countries or regions, clocks are adjusted through the summer months
so that afternoons have more daylight and mornings have less. This is known as
Summer Time, or Daylight Savings Time (DST). Typically, clocks are adjusted
forward one hour at the start of spring and then adjusted backward in autumn.
◆ This command sets the summer-time time relative to the configured time zone.
To specify the time corresponding to your local time when summer time is in
effect, select the predefined summer-time time zone appropriate for your
location, or manually configure summer time if these predefined
configurations do not apply to your location (see clock summer-time (date) or
clock summer-time (recurring).
– 162 –
Chapter 4 | System Management Commands
Time
Example
The following example sets the Summer Time setting to use the predefined
settings for the European region.
Related Commands
show sntp (154)
clock summer-time This command allows the user to manually configure the start, end, and offset
(recurring) times of summer time (daylight savings time) for the switch on a recurring basis.
Use the no form to disable summer-time.
Syntax
clock summer-time name recurring b-week b-day b-month b-hour b-minute e-
week e-day e-month e-hour e-minute [offset]
no clock summer-time
name - Name of the timezone while summer time is in effect, usually an
acronym. (Range: 1-30 characters)
b-week - The week of the month when summer time will begin. (Range: 1-5)
b-day - The day of the week when summer time will begin. (Options:
sunday | monday | tuesday | wednesday | thursday | friday | saturday)
b-month - The month when summer time will begin. (Options: january |
february | march | april | may | june | july | august | september | october
| november | december)
b-hour - The hour when summer time will begin. (Range: 0-23 hours)
b-minute - The minute when summer time will begin. (Range: 0-59 minutes)
e-week - The week of the month when summer time will end. (Range: 1-5)
e-day - The day of the week summer time will end. (Options: sunday |
monday | tuesday | wednesday | thursday | friday | saturday)
e-month - The month when summer time will end. (Options: january |
february | march | april | may | june | july | august | september | october
| november | december)
e-hour - The hour when summer time will end. (Range: 0-23 hours)
e-minute - The minute when summer time will end. (Range: 0-59 minutes)
offset - Summer-time offset from the regular time zone, in minutes.
(Range: 1-120 minutes)
Default Setting
Disabled
– 163 –
Chapter 4 | System Management Commands
Time
Command Mode
Global Configuration
Command Usage
◆ In some countries or regions, clocks are adjusted through the summer months
so that afternoons have more daylight and mornings have less. This is known as
Summer Time, or Daylight Savings Time (DST). Typically, clocks are adjusted
forward one hour at the start of spring and then adjusted backward in autumn.
◆ This command sets the summer-time time zone relative to the currently
configured time zone. To display a time corresponding to your local time when
summer time is in effect, you must indicate the number of minutes your
summer-time time zone deviates from your regular time zone (that is, the
offset).
Example
The following example sets a recurring 60 minute offset summer-time to begin on
the Friday of the 1st week of March at 01:59 hours and summer time to end on the
Saturday of the 2nd week of November at 01:59 hours.
Related Commands
show sntp (154)
clock timezone This command sets the time zone for the switch’s internal clock.
Syntax
clock timezone name hour hours minute minutes
{before-utc | after-utc}
name - Name of timezone, usually an acronym. (Range: 1-30 characters)
hours - Number of hours before/after UTC. (Range: 0-12 hours before UTC,
0-13 hours after UTC)
minutes - Number of minutes before/after UTC. (Range: 0-59 minutes)
before-utc - Sets the local time zone before (east) of UTC.
after-utc - Sets the local time zone after (west) of UTC.
Default Setting
None
Command Mode
Global Configuration
– 164 –
Chapter 4 | System Management Commands
Time
Command Usage
This command sets the local time zone relative to the Coordinated Universal Time
(UTC, formerly Greenwich Mean Time or GMT), based on the earth’s prime meridian,
zero degrees longitude. To display a time corresponding to your local time, you
must indicate the number of hours and minutes your time zone is east (before) or
west (after) of UTC.
Example
Console(config)#clock timezone Japan hours 8 minute 0 after-UTC
Console(config)#
Related Commands
show sntp (154)
calendar set This command sets the system clock. It may be used if there is no time server on
your network, or if you have not configured the switch to receive signals from a
time server.
Syntax
calendar set hour min sec {day month year | month day year}
hour - Hour in 24-hour format. (Range: 0 - 23)
min - Minute. (Range: 0 - 59)
sec - Second. (Range: 0 - 59)
day - Day of month. (Range: 1 - 31)
month - january | february | march | april | may | june | july | august |
september | october | november | december
year - Year (4-digit). (Range: 1970 - 2037)
Default Setting
None
Command Mode
Privileged Exec
Command Usage
Note that when SNTP is enabled, the system clock cannot be manually configured.
Example
This example shows how to set the system clock to 15:12:34, February 1st, 2015.
– 165 –
Chapter 4 | System Management Commands
Time Range
Default Setting
None
Command Mode
Normal Exec, Privileged Exec
Example
Console#show calendar
Current Time : May 13 14:08:18 2014
Time Zone : UTC, 08:00
Summer Time : Not configured
Summer Time in Effect : No
Console#
Time Range
This section describes the commands used to sets a time range for use by other
functions, such as Access Control Lists.
time-range Specifies the name of a time range, and enters time range GC
configuration mode
time-range This command specifies the name of a time range, and enters time range
configuration mode. Use the no form to remove a previously specified time range.
Syntax
[no] time-range name
name - Name of the time range. (Range: 1-32 characters)
Default Setting
None
Command Mode
Global Configuration
– 166 –
Chapter 4 | System Management Commands
Time Range
Command Usage
◆ This command sets a time range for use by other functions, such as Access
Control Lists.
Example
Console(config)#time-range r&d
Console(config-time-range)#
Related Commands
Access Control Lists (369)
absolute This command sets the absolute time range for the execution of a command. Use
the no form to remove a previously specified time.
Syntax
absolute start hour minute day month year
[end hour minutes day month year]
absolute end hour minutes day month year
no absolute
hour - Hour in 24-hour format. (Range: 0-23)
minute - Minute. (Range: 0-59)
day - Day of month. (Range: 1-31)
month - january | february | march | april | may | june | july | august |
september | october | november | december
year - Year (4-digit). (Range: 2013-2037)
Default Setting
None
Command Mode
Time Range Configuration
Command Usage
◆ If a time range is already configured, you must use the no form of this
command to remove the current entry prior to configuring a new time range.
◆ If both an absolute rule and one or more periodic rules are configured for the
same time range (i.e., named entry), that entry will only take effect if the current
time is within the absolute time range and one of the periodic time ranges.
– 167 –
Chapter 4 | System Management Commands
Time Range
Example
This example configures the time for the single occurrence of an event.
Console(config)#time-range r&d
Console(config-time-range)#absolute start 1 1 1 april 2009 end 2 1 1 april
2009
Console(config-time-range)#
periodic This command sets the time range for the periodic execution of a command. Use
the no form to remove a previously specified time range.
Syntax
[no] periodic {daily | friday | monday | saturday | sunday | thursday |
tuesday | wednesday | weekdays | weekend} hour minute to {daily | friday |
monday | saturday | sunday | thursday | tuesday | wednesday | weekdays
| weekend | hour minute}
daily - Daily
friday - Friday
monday - Monday
saturday - Saturday
sunday - Sunday
thursday - Thursday
tuesday - Tuesday
wednesday - Wednesday
weekdays - Weekdays
weekend - Weekends
hour - Hour in 24-hour format. (Range: 0-23)
minute - Minute. (Range: 0-59)
Default Setting
None
Command Mode
Time Range Configuration
Command Usage
◆ If a time range is already configured, you must use the no form of this
command to remove the current entry prior to configuring a new time range.
◆ If both an absolute rule and one or more periodic rules are configured for the
same time range (i.e., named entry), that entry will only take effect if the current
time is within the absolute time range and one of the periodic time ranges.
– 168 –
Chapter 4 | System Management Commands
Switch Clustering
Example
This example configures a time range for the periodic occurrence of an event.
Console(config)#time-range sales
Console(config-time-range)#periodic daily 1 1 to 2 1
Console(config-time-range)#
Syntax
show time-range [name]
name - Name of the time range. (Range: 1-32 characters)
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show time-range r&d
Time-range r&d:
status: inactive
absolute start 01:01 01 April 2015
periodic Daily 01:01 to Daily 02:01
periodic Daily 02:01 to Daily 03:01
Console#
Switch Clustering
Switch Clustering is a method of grouping switches together to enable centralized
management through a single unit. Switches that support clustering can be
grouped together regardless of physical location or switch type, as long as they are
connected to the same local network.
– 169 –
Chapter 4 | System Management Commands
Switch Clustering
◆ A switch cluster has a primary unit called the “Commander” which is used to
manage all other “Member” switches in the cluster. The management station
can use either Telnet or the web interface to communicate directly with the
Commander through its IP address, and then use the Commander to manage
the Member switches through the cluster’s “internal” IP addresses.
◆ The cluster VLAN 4093 is not configured by default. Before using clustering,
take the following actions to set up this VLAN:
1. Create VLAN 4093 (see “Editing VLAN Groups” on page 531).
2. Add the participating ports to this VLAN (see “Configuring VLAN Interfaces”
on page 533), and set them to hybrid mode, tagged members, PVID = 1,
and acceptable frame type = all.
cluster This command enables clustering on the switch. Use the no form to disable
clustering.
Syntax
[no] cluster
– 170 –
Chapter 4 | System Management Commands
Switch Clustering
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ To create a switch cluster, first be sure that clustering is enabled on the switch
(the default is disabled), then set the switch as a Cluster Commander. Set a
Cluster IP Pool that does not conflict with any other IP subnets in the network.
Cluster IP addresses are assigned to switches when they become Members and
are used for communication between Member switches and the Commander.
◆ Configured switch clusters are maintained across power resets and network
changes.
Example
Console(config)#cluster
Console(config)#
cluster commander This command enables the switch as a cluster Commander. Use the no form to
disable the switch as cluster Commander.
Syntax
[no] cluster commander
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ Once a switch has been configured to be a cluster Commander, it automatically
discovers other cluster-enabled switches in the network. These “Candidate”
switches only become cluster Members when manually selected by the
administrator through the management station.
– 171 –
Chapter 4 | System Management Commands
Switch Clustering
Example
Console(config)#cluster commander
Console(config)#
cluster ip-pool This command sets the cluster IP address pool. Use the no form to reset to the
default address.
Syntax
cluster ip-pool ip-address
no cluster ip-pool
ip-address - The base IP address for IP addresses assigned to cluster
Members. The IP address must start 10.x.x.x.
Default Setting
10.254.254.1
Command Mode
Global Configuration
Command Usage
◆ An “internal” IP address pool is used to assign IP addresses to Member switches
in the cluster. Internal cluster IP addresses are in the form 10.x.x.member-ID.
Only the base IP address of the pool needs to be set since Member IDs can only
be between 1 and 36.
◆ Set a Cluster IP Pool that does not conflict with addresses in the network IP
subnet. Cluster IP addresses are assigned to switches when they become
Members and are used for communication between Member switches and the
Commander.
◆ You cannot change the cluster IP pool when the switch is currently in
Commander mode. Commander mode must first be disabled.
Example
Console(config)#cluster ip-pool 10.2.3.4
Console(config)#
– 172 –
Chapter 4 | System Management Commands
Switch Clustering
cluster member This command configures a Candidate switch as a cluster Member. Use the no form
to remove a Member switch from the cluster.
Syntax
cluster member mac-address mac-address id member-id
no cluster member id member-id
mac-address - The MAC address of the Candidate switch.
member-id - The ID number to assign to the Member switch. (Range: 1-36)
Default Setting
No Members
Command Mode
Global Configuration
Command Usage
◆ The maximum number of cluster Members is 36.
Example
Console(config)#cluster member mac-address 00-12-34-56-78-9a id 5
Console(config)#
rcommand This command provides access to a cluster Member CLI for configuration.
Syntax
rcommand id member-id
member-id - The ID number of the Member switch. (Range: 1-36)
Command Mode
Privileged Exec
Command Usage
◆ This command only operates through a Telnet connection to the Member
switch. Managing cluster Members using the local console CLI on the
Commander is not supported.
◆ There is no need to enter the username and password for access to the Member
switch CLI.
– 173 –
Chapter 4 | System Management Commands
Switch Clustering
Example
Console#rcommand id 1
Vty-0#
Command Mode
Privileged Exec
Example
Console#show cluster
Role : commander
Interval Heartbeat : 30
Heartbeat Loss Count : 3 seconds
Number of Members : 1
Number of Candidates : 2
Console#
show cluster members This command shows the current switch cluster members.
Command Mode
Privileged Exec
Example
Console#show cluster members
Cluster Members:
ID : 1
Role : Active member
IP Address : 10.254.254.2
MAC Address : 00-E0-0C-00-00-FE
Description : ECS4130-28T
Console#
– 174 –
Chapter 4 | System Management Commands
Switch Clustering
show cluster This command shows the discovered Candidate switches in the network.
candidates
Command Mode
Privileged Exec
Example
Console#show cluster candidates
Cluster Candidates:
Role MAC Address Description
--------------- ----------------- ----------------------------------------
Candidate join 00-E0-0C-00-00-FE ECS4130-28T
Candidate 00-12-CF-0B-47-A0 ECS4130-28T
Console#
– 175 –
Chapter 4 | System Management Commands
Switch Clustering
– 176 –
5 SNMP Commands
SNMP commands control access to this switch from management stations using
the Simple Network Management Protocol (SNMP), as well as the error types sent
to trap managers.
SNMP Version 3 also provides security features that cover message integrity,
authentication, and encryption; as well as controlling user access to specific areas
of the MIB tree. To use SNMPv3, first set an SNMP engine ID (or accept the default),
specify read and write access views for the MIB tree, configure SNMP user groups
with the required security model (i.e., SNMP v1, v2c or v3) and security level (i.e.,
authentication and privacy), and then assign SNMP users to these groups, along
with their specific authentication and privacy passwords.
snmp-server enable traps Enables the device to send SNMP traps (i.e., SNMP GC
notifications)
show snmp-server enable Shows if SNMP traps are enabled or disabled for the PE
port-traps specified interfaces
– 177 –
Chapter 5 | SNMP Commands
snmp-server notify-filter Creates a notification log and specifies the target host GC
snmp-server enable port- Sends a trap when broadcast traffic falls beneath the lower IC (Port)
traps atc broadcast-alarm- threshold after a storm control response has been
clear triggered
snmp-server enable port- Sends a trap when broadcast traffic exceeds the upper IC (Port)
traps atc broadcast-alarm- threshold for automatic storm control
fire
snmp-server enable port- Sends a trap when broadcast traffic exceeds the upper IC (Port)
traps atc broadcast-control- threshold for automatic storm control and the apply timer
apply expires
snmp-server enable port- Sends a trap when broadcast traffic falls beneath the lower IC (Port)
traps atc broadcast-control- threshold after a storm control response has been
release triggered and the release timer expires
snmp-server enable port- Sends a trap when multicast traffic falls beneath the lower IC (Port)
traps atc multicast-alarm- threshold after a storm control response has been
clear triggered
snmp-server enable port- Sends a trap when multicast traffic exceeds the upper IC (Port)
traps atc multicast-alarm- threshold for automatic storm control
fire
snmp-server enable port- Sends a trap when multicast traffic exceeds the upper IC (Port)
traps atc multicast-control- threshold for automatic storm control and the apply timer
apply expires
snmp-server enable port- Sends a trap when multicast traffic falls beneath the lower IC (Port)
traps atc multicast-control- threshold after a storm control response has been
release triggered and the release timer expires
transceiver-threshold Sends a trap when the transceiver current falls outside the IC (Port)
current specified thresholds
transceiver-threshold Sends a trap when the power level of the received signal IC (Port)
rx-power falls outside the specified thresholds
transceiver-threshold Sends a trap when the power level of the transmitted signal IC (Port)
tx-power power outside the specified thresholds
transceiver-threshold Sends a trap when the transceiver voltage falls outside the IC (Port)
voltage specified thresholds
– 178 –
Chapter 5 | SNMP Commands
General SNMP Commands
memory Sets the rising and falling threshold for the memory GC
utilization alarm
process cpu Sets the rising and falling threshold for the CPU utilization GC
alarm
process cpu guard Sets the CPU utilization watermark and threshold GC
show process cpu guard Shows the CPU utilization watermark and threshold PE
show process cpu task Shows CPU utilization per process NE, PE
snmp-server This command enables the SNMPv3 engine and services for all management clients
(i.e., versions 1, 2c, 3). Use the no form to disable the server.
Syntax
[no] snmp-server
Default Setting
Enabled
Command Mode
Global Configuration
Example
Console(config)#snmp-server
Console(config)#
snmp-server This command defines community access strings used to authorize management
community access by clients using SNMP v1 or v2c. Use the no form to remove the specified
community string.
Syntax
snmp-server community string [ro | rw]
no snmp-server community string
string - Community string that acts like a password and permits access to
the SNMP protocol. (Maximum length: 32 characters, case sensitive;
Maximum number of strings: 5)
– 179 –
Chapter 5 | SNMP Commands
General SNMP Commands
Default Setting
◆ public - Read-only access. Authorized management stations are only able to
retrieve MIB objects.
◆ private - Read/write access. Authorized management stations are able to both
retrieve and modify MIB objects.
Command Mode
Global Configuration
Example
Console(config)#snmp-server community alpha rw
Console(config)#
snmp-server contact This command sets the system contact string. Use the no form to remove the
system contact information.
Syntax
snmp-server contact string
no snmp-server contact
string - String that describes the system contact information.
(Maximum length: 255 characters)
Default Setting
None
Command Mode
Global Configuration
Example
Console(config)#snmp-server contact Paul
Console(config)#
Related Commands
snmp-server location (181)
– 180 –
Chapter 5 | SNMP Commands
General SNMP Commands
snmp-server location This command sets the system location string. Use the no form to remove the
location string.
Syntax
snmp-server location text
no snmp-server location
text - String that describes the system location.
(Maximum length: 255 characters)
Default Setting
None
Command Mode
Global Configuration
Example
Console(config)#snmp-server location WC-19
Console(config)#
Related Commands
snmp-server contact (180)
show snmp This command can be used to check the status of SNMP communications.
Default Setting
None
Command Mode
Normal Exec, Privileged Exec
Command Usage
This command provides information on the community access strings, counters for
SNMP input and output protocol data units, and whether or not SNMP logging has
been enabled with the snmp-server enable traps command.
Example
Console#show snmp
SNMP Traps :
Authentication : Enabled
MAC-notification : Disabled
MAC-notification interval : 1 second(s)
SNMP Communities :
1. public, and the access level is read-only
– 181 –
Chapter 5 | SNMP Commands
SNMP Target Host Commands
snmp-server This command enables this device to send Simple Network Management Protocol
enable traps traps or informs (i.e., SNMP notifications). Use the no form to disable SNMP
notifications.
Syntax
[no] snmp-server enable traps [authentication | mac-notification [interval
seconds]]
authentication - Keyword to issue authentication failure notifications.
mac-notification - Keyword to issue trap when a dynamic MAC address is
added or removed.
interval - Specifies the interval between issuing two consecutive traps.
(Range: 1-3600 seconds; Default: 1 second)
Default Setting
Issue authentication traps
Other traps are disabled
Command Mode
Global Configuration
Command Usage
◆ If you do not enter an snmp-server enable traps command, no notifications
controlled by this command are sent. In order to configure this device to send
SNMP notifications, you must enter at least one snmp-server enable traps
command. If you enter the command with no keywords, both authentication
– 182 –
Chapter 5 | SNMP Commands
SNMP Target Host Commands
notifications are enabled. If you enter the command with a keyword, only the
notification type related to that keyword is enabled.
◆ The authentication traps are legacy notifications, and therefore when used for
SNMP Version 3 hosts, they must be enabled in conjunction with the
corresponding entries in the Notify View assigned by the snmp-server group
command.
◆ Interface link-up and link-down traps can be configured using the snmp-server
enable port-traps link-up-down command.
Example
Console(config)#snmp-server enable traps authentication
Console(config)#
Related Commands
snmp-server host (183)
snmp-server host This command specifies the recipient of a Simple Network Management Protocol
notification operation. Use the no form to remove the specified host.
Syntax
snmp-server host host-addr [inform [retry retries | timeout seconds]]
community-string [version {1 | 2c | 3 {auth | noauth | priv} [udp-port port]}
no snmp-server host host-addr
host-addr - IPv4 or IPv6 address of the host (the targeted recipient).
(Maximum host addresses: 5 trap destination IP address entries)
inform - Notifications are sent as inform messages. Note that this option is
only available for version 2c and 3 hosts. (Default: traps are used)
retries - The maximum number of times to resend an inform message if
the recipient does not acknowledge receipt. (Range: 0-255; Default: 3)
seconds - The number of seconds to wait for an acknowledgment
before resending an inform message. (Range: 0-2147483647
centiseconds; Default: 1500 centiseconds)
community-string - Password-like community string sent with the
notification operation to SNMP V1 and V2c hosts. Although you can set this
string using the snmp-server host command by itself, we recommend
defining it with the snmp-server community command prior to using the
snmp-server host command. (Maximum length: 32 characters)
– 183 –
Chapter 5 | SNMP Commands
SNMP Target Host Commands
Default Setting
Host Address: None
Notification Type: Traps
SNMP Version: 1
UDP Port: 162
Command Mode
Global Configuration
Command Usage
◆ If you do not enter an snmp-server host command, no notifications are sent. In
order to configure the switch to send SNMP notifications, you must enter at
least one snmp-server host command. In order to enable multiple hosts, you
must issue a separate snmp-server host command for each host.
◆ Notifications are issued by the switch as trap messages by default. The recipient
of a trap message does not send a response to the switch. Traps are therefore
not as reliable as inform messages, which include a request for
acknowledgement of receipt. Informs can be used to ensure that critical
information is received by the host. However, note that informs consume more
system resources because they must be kept in memory until a response is
received. Informs also add to network traffic. You should consider these effects
when deciding whether to issue notifications as traps or informs.
– 184 –
Chapter 5 | SNMP Commands
SNMP Target Host Commands
4. Allow the switch to send SNMP traps; i.e., notifications (page 182).
5. Specify the target host that will receive inform messages with the
snmp-server host command as described in this section.
◆ If you specify an SNMP Version 3 host, then the community string is interpreted
as an SNMP user name. The user name must first be defined with the snmp-
server user command. Otherwise, an SNMPv3 group will be automatically
created by the snmp-server host command using the name of the specified
community string, and default settings for the read, write, and notify view.
Example
Console(config)#snmp-server host 10.1.19.23 batman
Console(config)#
Related Commands
snmp-server enable traps (182)
snmp-server This command enables the device to send SNMP traps (i.e., SNMP notifications)
enable port-traps when a link-up or link-down state change occurs. Use the no form to restore the
link-up-down default setting.
Syntax
[no] snmp-server enable port-traps link-up-down
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
– 185 –
Chapter 5 | SNMP Commands
SNMP Target Host Commands
Example
Console(config)#interface ethernet 1/1
Console(config-if)#snmp-server enable port-traps link-up-down
Console(config)#
snmp-server This command enables the device to send SNMP traps (i.e., SNMP notifications)
enable port-traps when a dynamic MAC address is added or removed. Use the no form to restore the
mac-notification default setting.
Syntax
[no] snmp-server enable port-traps mac-notification
mac-notification - Keyword to issue trap when a dynamic MAC address is
added or removed.
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
This command can enable MAC authentication traps on the current interface only if
they are also enabled at the global level with the snmp-server enable traps mac-
authentication command.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#snmp-server enable port-traps mac-notification
Console(config)#
show snmp-server This command shows if SNMP traps are enabled or disabled for the specified
enable port-traps interfaces.
Syntax
show snmp-server enable port-traps interface [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-18)
port-channel channel-id (Range: 1-12)
– 186 –
Chapter 5 | SNMP Commands
SNMPv3 Commands
Command Mode
Privileged Exec
Example
Console#show snmp-server enable port-traps interface
Interface MAC Notification Trap
--------- ---------------------
Eth 1/1 No
Eth 1/2 No
Eth
. 1/3 No
.
.
SNMPv3 Commands
snmp-server This command configures an identification string for the SNMPv3 engine. Use the
engine-id no form to restore the default.
Syntax
snmp-server engine-id {local | remote {ip-address}} engineid-string
no snmp-server engine-id {local | remote {ip-address}}
local - Specifies the SNMP engine on this switch.
remote - Specifies an SNMP engine on a remote device.
ip-address - IPv4 or IPv6 address of the remote device.
engineid-string - String identifying the engine ID. (Range: 9-64 hexadecimal
characters)
Default Setting
A unique engine ID is automatically generated by the switch based on its MAC
address.
Command Mode
Global Configuration
Command Usage
◆ An SNMP engine is an independent SNMP agent that resides either on this
switch or on a remote device. This engine protects against message replay,
delay, and redirection. The engine ID is also used in combination with user
passwords to generate the security keys for authenticating and encrypting
SNMPv3 packets.
◆ A remote engine ID is required when using SNMPv3 informs. (See the snmp-
server host command.) The remote engine ID is used to compute the security
digest for authentication and encryption of packets passed between the switch
and a user on the remote host. SNMP passwords are localized using the engine
ID of the authoritative agent. For informs, the authoritative SNMP agent is the
– 187 –
Chapter 5 | SNMP Commands
SNMPv3 Commands
remote agent. You therefore need to configure the remote agent’s SNMP
engine ID before you can send proxy requests or informs to it.
◆ Trailing zeroes need not be entered to uniquely specify a engine ID. In other
words, the value “0123456789” is equivalent to “0123456789” followed by 16
zeroes for a local engine ID.
Example
Console(config)#snmp-server engine-id local 1234567890
Console(config)#snmp-server engine-id remote 192.168.1.19 9876543210
Console(config)#
Related Commands
snmp-server host (183)
snmp-server group This command adds an SNMP group, mapping SNMP users to SNMP views. Use the
no form to remove an SNMP group.
Syntax
snmp-server group groupname
{v1 | v2c | v3 {auth | noauth | priv}}
[read readview] [write writeview] [notify notifyview]
no snmp-server group groupname
groupname - Name of an SNMP group. A maximum of 22 groups can be
configured. (Range: 1-32 characters)
v1 | v2c | v3 - Use SNMP version 1, 2c or 3.
auth | noauth | priv - This group uses SNMPv3 with authentication, no
authentication, or with authentication and privacy. See “Simple Network
Management Protocol” in the Web Management Guide for further
information about these authentication and encryption options.
readview - Defines the view for read access. (1-32 characters)
writeview - Defines the view for write access. (1-32 characters)
notifyview - Defines the view for notifications. (1-32 characters)
Default Setting
Default groups: public1 (read only), private2 (read/write)
readview - Every object belonging to the Internet OID space (1).
writeview - Nothing is defined.
notifyview - Nothing is defined.
– 188 –
Chapter 5 | SNMP Commands
SNMPv3 Commands
Command Mode
Global Configuration
Command Usage
◆ A group sets the access policy for the assigned users.
◆ When privacy is selected, the DES 56-bit algorithm is used for data encryption.
Example
Console(config)#snmp-server group r&d v3 auth write daily
Console(config)#
snmp-server user This command adds a user to an SNMP group, restricting the user to a specific
SNMP Read, Write, or Notify View. Use the no form to remove a user from an SNMP
group.
Syntax
snmp-server user username groupname
{v1 | v2c | v3 [encrypted] [auth {md5 | sha} auth-password [priv {3des |
aes128 | aes192 | aes256 | des56} priv-password]]
snmp-server user username groupname remote ip-address
{v3 [encrypted] [auth {md5 | sha} auth-password [priv {3des | aes128 |
aes192 | aes256 | des56} priv-password]]
no snmp-server user username {v1 | v2c | v3 | remote ip-address v3}
username - Name of user connecting to the SNMP agent. A maximum of 22
groups can be configured. (Range: 1-32 characters)
groupname - Name of an SNMP group to which the user is assigned.
(Range: 1-32 characters)
remote - Specifies an SNMP engine on a remote device.
ip-address - IPv4 address of the remote device.
v1 | v2c | v3 - Use SNMP version 1, 2c or 3.
encrypted - Accepts the password as encrypted input.
1. No view is defined.
2. Maps to the defaultview.
– 189 –
Chapter 5 | SNMP Commands
SNMPv3 Commands
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ Local users (i.e., the command does not specify a remote engine identifier)
must be configured to authorize management access for SNMPv3 clients, or to
identify the source of SNMPv3 trap messages sent from the local switch.
◆ Remote users (i.e., the command specifies a remote engine identifier) must be
configured to identify the source of SNMPv3 inform messages sent from the
local switch.
◆ Before you configure a remote user, use the snmp-server engine-id command
to specify the engine ID for the remote device where the user resides. Then use
the snmp-server user command to specify the user and the IP address for the
remote device where the user resides. The remote agent’s SNMP engine ID is
used to compute authentication/privacy digests from the user’s password. If the
remote engine ID is not first configured, the snmp-server user command
specifying a remote user will fail.
– 190 –
Chapter 5 | SNMP Commands
SNMPv3 Commands
◆ SNMP passwords are localized using the engine ID of the authoritative agent.
For informs, the authoritative SNMP agent is the remote agent. You therefore
need to configure the remote agent’s SNMP engine ID before you can send
proxy requests or informs to it.
Example
Console(config)#snmp-server user steve r&d v3 auth md5 greenpeace priv des56
einstien
Console(config)#snmp-server engine-id remote 192.168.1.19 9876543210
Console(config)#snmp-server user mark r&d remote 192.168.1.19 v3 auth md5
greenpeace priv des56 einstien
Console(config)#
snmp-server view This command adds an SNMP view which controls user access to the MIB. Use the
no form to remove an SNMP view.
Syntax
snmp-server view view-name oid-tree {included | excluded}
no snmp-server view view-name
view-name - Name of an SNMP view. A maximum of 32 views can be
configured. (Range: 1-32 characters)
oid-tree - Object identifier of a branch within the MIB tree. Wild cards can be
used to mask a specific portion of the OID string. (Refer to the examples.)
included - Defines an included view.
excluded - Defines an excluded view.
Default Setting
defaultview (includes access to the entire MIB tree)
Command Mode
Global Configuration
Command Usage
◆ Views are used in the snmp-server group command to restrict user access to
specified portions of the MIB tree.
◆ The predefined view “defaultview” includes access to the entire MIB tree.
Examples
This view includes MIB-2.
– 191 –
Chapter 5 | SNMP Commands
SNMPv3 Commands
This view includes the MIB-2 interfaces table, ifDescr. The wild card is used to select
all the index values in the following table.
This view includes the MIB-2 interfaces table, and the mask selects all index entries.
show snmp engine-id This command shows the SNMP engine ID.
Command Mode
Privileged Exec
Example
This example shows the default engine ID.
Local SNMP engineBoots The number of times that the engine has (re-)initialized since the snmp
EngineID was last configured.
– 192 –
Chapter 5 | SNMP Commands
SNMPv3 Commands
show snmp group Four default groups are provided – SNMPv1 read-only access and read/write access,
and SNMPv2c read-only access and read/write access.
Command Mode
Privileged Exec
Example
Console#show snmp group
Group Name : r&d
Security Model : v3
Security Level : Authentication and privacy
Read View : No readview specified
Write View : No writeview specified
Notify View : No notifyview specified
Storage Type : Nonvolatile
Row Status : Active
Security Level This associated security level can use SNMPv3 with authentication, no
authentication, or with authentication and privacy.
– 193 –
Chapter 5 | SNMP Commands
SNMPv3 Commands
Command Mode
Privileged Exec
Example
Console#show snmp user
Engine ID : 800001030300e00c0000fd0000
User Name : steve
Group Name : rd
Security Model : v1
Security Level : None
Authentication Protocol : None
Privacy Protocol : None
Storage Type : Nonvolatile
Row Status : Active
Security Model The user security model: SNMP v1, v2c or v3.
– 194 –
Chapter 5 | SNMP Commands
Notification Log Commands
SNMP remote user A user associated with an SNMP engine on a remote device.
show snmp view This command shows information on the SNMP views.
Command Mode
Privileged Exec
Example
Console#show snmp view
View Name: mib-2
Subtree OID: 1.2.2.3.6.2.1
View Type: included
Storage Type: permanent
Row Status: active
Syntax
[no] nlm filter-name
filter-name - Notification log name. (Range: 1-32 characters)
– 195 –
Chapter 5 | SNMP Commands
Notification Log Commands
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ Notification logging is enabled by default, but will not start recording
information until a logging profile specified by the snmp-server notify-filter
command is enabled by the nlm command.
◆ Disabling logging with this command does not delete the entries stored in the
notification log.
Example
This example enables the notification log A1.
Console(config)#nlm A1
Console(config)#
snmp-server This command creates an SNMP notification log. Use the no form to remove this
notify-filter log.
Syntax
[no] snmp-server notify-filter profile-name remote ip-address
profile-name - Notification log profile name. (Range: 1-32 characters)
ip-address - IPv4 or IPv6 address of a remote device. The specified target
host must already have been configured using the snmp-server host
command.
Note: The notification log is stored locally. It is not sent to a remote device. This
remote host parameter is only required to complete mandatory fields in the SNMP
Notification MIB.
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ Systems that support SNMP often need a mechanism for recording Notification
information as a hedge against lost notifications, whether there are Traps or
Informs that may exceed retransmission limits. The Notification Log MIB (NLM,
– 196 –
Chapter 5 | SNMP Commands
Notification Log Commands
RFC 3014) provides an infrastructure in which information from other MIBs may
be logged.
◆ Given the service provided by the NLM, individual MIBs can now bear less
responsibility to record transient information associated with an event against
the possibility that the Notification message is lost, and applications can poll
the log to verify that they have not missed any important Notifications.
◆ If notification logging is not configured and enabled, when the switch reboots,
some SNMP traps (such as warm start) cannot be logged.
◆ When this command is executed, a notification log is created (with the default
parameters defined in RFC 3014). Notification logging is enabled by default
(see the nlm command), but will not start recording information until a logging
profile specified with this command is enabled with the nlm command.
◆ Based on the default settings used in RFC 3014, a notification log can contain
up to 256 entries, and the entry aging time is 1440 minutes. Information
recorded in a notification log, and the entry aging time can only be configured
using SNMP from a network management station.
◆ When a trap host is created with the snmp-server host command, a default
notify filter will be created as shown in the example under the show snmp
notify-filter command.
Example
This example first creates an entry for a remote host, and then instructs the switch
to record this device as the remote host for the specified notification log.
– 197 –
Chapter 5 | SNMP Commands
Additional Trap Commands
show nlm oper-status This command shows the operational status of configured notification logs.
Command Mode
Privileged Exec
Example
Console#show nlm oper-status
Filter Name: A1
Oper-Status: Operational
Console#
Example
This example displays the configured notification logs and associated target hosts.
memory This command sets an SNMP trap based on configured thresholds for memory
utilization. Use the no form to restore the default setting.
Syntax
memory {rising rising-threshold | falling falling-threshold}
no memory {rising | falling}
rising-threshold - Rising threshold for memory utilization alarm expressed in
percentage. (Range: 1-100)
falling-threshold - Falling threshold for memory utilization alarm expressed
in percentage. (Range: 1-100)
Default Setting
Rising Threshold: 90%
Falling Threshold: 70%
Command Mode
Global Configuration
– 198 –
Chapter 5 | SNMP Commands
Additional Trap Commands
Command Usage
Once the rising alarm threshold is exceeded, utilization must drop beneath the
falling threshold before the alarm is terminated, and then exceed the rising
threshold again before another alarm is triggered.
Example
Console(config)#memory rising 80
Console(config)#memory falling 60
Console#
Related Commands
show memory (105)
process cpu This command sets an SNMP trap based on configured thresholds for CPU
utilization. Use the no form to restore the default setting.
Syntax
process cpu {rising rising-threshold | falling falling-threshold}
no process cpu {rising | falling}
rising-threshold - Rising threshold for CPU utilization alarm expressed in
percentage. (Range: 1-100)
falling-threshold - Falling threshold for CPU utilization alarm expressed in
percentage. (Range: 1-100)
Default Setting
Rising Threshold: 90%
Falling Threshold: 70%
Command Mode
Global Configuration
Command Usage
Once the rising alarm threshold is exceeded, utilization must drop beneath the
falling threshold before the alarm is terminated, and then exceed the rising
threshold again before another alarm is triggered.
Example
Console(config)#process cpu rising 80
Console(config)#process cpu falling 60
Console#
Related Commands
show process cpu (106)
– 199 –
Chapter 5 | SNMP Commands
Additional Trap Commands
process cpu guard This command sets the CPU utilization high and low watermarks in percentage of
CPU time utilized and the CPU high and low thresholds in the number of packets
being processed per second. Use the no form of this command without any
parameters to restore all of the default settings, or with a specific parameter to
restore the default setting for that item.
Syntax
process cpu guard [high-watermark high-watermark |
low-watermark low-watermark | max-threshold max-threshold |
min-threshold min-threshold | trap]
high-watermark - If the percentage of CPU usage time is higher than the
high-watermark, the switch stops packet flow to the CPU (allowing it to
catch up with packets already in the buffer) until usage time falls below the
low watermark. (Range: 40-100%)
low-watermark - If packet flow has been stopped after exceeding the high
watermark, normal flow will be restored after usage falls beneath the low
watermark. (Range: 40-100%)
max-threshold - If the number of packets being processed per second by
the CPU is higher than the maximum threshold, the switch stops packet
flow to the CPU (allowing it to catch up with packets already in the buffer)
until the number of packets being processed falls below the minimum
threshold. (Range: 50-500 pps)
min-threshold - If packet flow has been stopped after exceeding the
maximum threshold, normal flow will be restored after usage falls beneath
the minimum threshold. (Range: 50-500 pps)
trap - If traps are enabled, the switch will send an alarm message if CPU
utilization exceeds the high watermark in percentage of CPU usage time or
exceeds the maximum threshold in the number of packets being processed
by the CPU.
Default Setting
Guard Status: Disabled
High Watermark: 90%
Low Watermark: 70%
Maximum Threshold: 500 packets per second
Minimum Threshold: 50 packets per second
Trap Status: Disabled
Command Mode
Global Configuration
Command Usage
◆ Once the high watermark is exceeded, utilization must drop beneath the low
watermark before the alarm is terminated, and then exceed the high
watermark again before another alarm is triggered.
– 200 –
Chapter 5 | SNMP Commands
Additional Trap Commands
◆ Once the maximum threshold is exceeded, utilization must drop beneath the
minimum threshold before the alarm is terminated, and then exceed the
maximum threshold again before another alarm is triggered.
Example
Console(config)#process cpu guard high-watermark 80
Console(config)#process cpu guard low-watermark 60
Console(config)#
Related Commands
show process cpu guard (106)
– 201 –
Chapter 5 | SNMP Commands
Additional Trap Commands
– 202 –
6 Remote Monitoring Commands
This switch supports mini-RMON, which consists of the Statistics, History, Event and
Alarm groups. When RMON is enabled, the system gradually builds up information
about its physical interfaces, storing this information in the relevant RMON
database group. A management agent then periodically communicates with the
switch using the SNMP protocol. However, if the switch encounters a critical event,
it can automatically send a trap message to the management agent which can then
respond to the event if so configured.
show rmon alarms Shows the settings for all configured alarms PE
show rmon events Shows the settings for all configured events PE
show rmon history Shows the sampling parameters for each entry PE
– 203 –
Chapter 6 | Remote Monitoring Commands
rmon alarm This command sets threshold bounds for a monitored variable. Use the no form to
remove an alarm.
Syntax
rmon alarm index variable interval {absolute | delta}
rising-threshold threshold [event-index] falling-threshold threshold
[event-index] [owner name]
no rmon alarm index
index – Index to this entry. (Range: 1-65535)
variable – The object identifier of the MIB variable to be sampled. Only
variables of the type etherStatsEntry.n.n may be sampled. Note that
etherStatsEntry.n uniquely defines the MIB variable, and
etherStatsEntry.n.n defines the MIB variable, plus the etherStatsIndex. For
example, 1.3.6.1.2.1.16.1.1.1.6.1 denotes etherStatsBroadcastPkts, plus the
etherStatsIndex of 1.
interval – The polling interval. (Range: 1-31622400 seconds)
absolute – The variable is compared directly to the thresholds at the end of
the sampling period.
delta – The last sample is subtracted from the current value and the
difference is then compared to the thresholds.
threshold – An alarm threshold for the sampled variable.
(Range: 0-2147483647)
event-index – The index of the event to use if an alarm is triggered. If there is
no corresponding entry in the event control table, then no event will be
generated. (Range: 1-65535)
name – Name of the person who created this entry. (Range: 1-127
characters)
Default Setting
1.3.6.1.2.1.16.1.1.1.6.1 - 1.3.6.1.2.1.16.1.1.1.6.18/
Taking delta samples every 30 seconds, last value was 0
Rising threshold is 892800, assigned to event 0
Falling threshold is 446400, assigned to event 0
Command Mode
Global Configuration
Command Usage
◆ If an event is already defined for an index, the entry must be deleted before any
changes can be made with this command.
◆ If the current value is greater than or equal to the rising threshold, and the last
sample value was less than this threshold, then an alarm will be generated.
After a rising event has been generated, another such event will not be
– 204 –
Chapter 6 | Remote Monitoring Commands
generated until the sampled value has fallen below the rising threshold,
reaches the falling threshold, and again moves back up to the rising threshold.
◆ If the current value is less than or equal to the falling threshold, and the last
sample value was greater than this threshold, then an alarm will be generated.
After a falling event has been generated, another such event will not be
generated until the sampled value has risen above the falling threshold,
reaches the rising threshold, and again moves back down to the failing
threshold.
Example
Console(config)#rmon alarm 1 1.3.6.1.2.1.16.1.1.1.6.1 15 delta
rising-threshold 100 1 falling-threshold 30 1 owner mike
Console(config)#
rmon event This command creates a response event for an alarm. Use the no form to remove an
event.
Syntax
rmon event index [log] | [trap community] | [description string] | [owner name]
no rmon event index
index – Index to this entry. (Range: 1-65535)
log – Generates an RMON log entry when the event is triggered. Log
messages are processed based on the current configuration settings for
event logging (see “Event Logging” on page 140).
trap – Sends a trap message to all configured trap managers (see the
snmp-server host command).
community – A password-like community string sent with the trap
operation to SNMP v1 and v2c hosts. Although this string can be set using
the rmon event command by itself, it is recommended that the string be
defined using the snmp-server community command prior to using the
rmon event command. (Range: 1-32 characters)
string – A comment that describes this event. (Range: 1-127 characters)
name – Name of the person who created this entry.
(Range: 1-32 characters)
Default Setting
None
Command Mode
Global Configuration
– 205 –
Chapter 6 | Remote Monitoring Commands
Command Usage
◆ If an event is already defined for an index, the entry must be deleted before any
changes can be made with this command.
◆ The specified events determine the action to take when an alarm triggers this
event. The response to an alarm can include logging the alarm or sending a
message to a trap manager.
Example
Console(config)#rmon event 2 log description urgent owner mike
Console(config)#
rmon collection This command periodically samples statistics on a physical interface. Use the no
history form to disable periodic sampling.
Syntax
rmon collection history controlEntry index
[buckets number [interval seconds]] |
[interval seconds] |
[owner name [buckets number [interval seconds]]
no rmon collection history controlEntry index
index – Index to this entry. (Range: 1-65535)
number – The number of buckets requested for this entry. (Range: 1-65535)
seconds – The polling interval. (Range: 1-3600 seconds)
name – Name of the person who created this entry.
(Range: 1-32 characters)
Default Setting
1.3.6.1.2.1.16.1.1.1.6.1 - 1.3.6.1.2.1.16.1.1.1.6.18
Buckets: 50
Interval: 30 seconds for even numbered entries,
1800 seconds for odd numbered entries
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ By default, each index number equates to a port on the switch, but can be
changed to any number not currently in use.
– 206 –
Chapter 6 | Remote Monitoring Commands
◆ The switch reserves two controlEntry index entries for each port. If a default
index entry is re-assigned to another port by this command, the show
running-config command will display a message indicating that this index is
not available for the port to which is normally assigned.
For example, if control entry 15 is assigned to port 5 as shown below, the show
running-config command will indicate that this entry is not available for port
8.
Console(config)#interface ethernet 1/5
Console(config-if)#rmon collection history controlEntry 15
Console(config-if)#end
Console#show running-config
!
interface ethernet 1/5
rmon collection history controlEntry 15 buckets 50 interval 1800
...
interface ethernet 1/8
no rmon collection history controlEntry 15
Example
Console(config)#interface ethernet 1/1
Console(config-if)#rmon collection history controlentry 21 owner mike buckets
24 interval 60
Console(config-if)#
rmon collection This command enables the collection of statistics on a physical interface. Use the
rmon1 no form to disable statistics collection.
Syntax
rmon collection rmon1 controlEntry index [owner name]
no rmon collection rmon1 controlEntry index
index – Index to this entry. (Range: 1-65535)
name – Name of the person who created this entry.
(Range: 1-32 characters)
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet)
– 207 –
Chapter 6 | Remote Monitoring Commands
Command Usage
◆ By default, each index number equates to a port on the switch, but can be
changed to any number not currently in use.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#rmon collection rmon1 controlentry 1 owner mike
Console(config-if)#
show rmon alarms This command shows the settings for all configured alarms.
Command Mode
Privileged Exec
Example
Console#show rmon alarms
Alarm 1 is valid, owned by
Monitors 1.3.6.1.2.1.16.1.1.1.6.1 every 30 seconds
Taking delta samples, last value was 0
Rising threshold is 892800, assigned to event 0
Falling threshold is 446400, assigned to event 0
.
.
.
show rmon events This command shows the settings for all configured events.
Command Mode
Privileged Exec
Example
Console#show rmon events
Event 2 is valid, owned by mike
Description is urgent
Event firing causes log and trap to community , last fired 00:00:00
Console#
– 208 –
Chapter 6 | Remote Monitoring Commands
show rmon history This command shows the sampling parameters configured for each entry in the
history group.
Command Mode
Privileged Exec
Example
Console#show rmon history
Entry 1 is valid, and owned by
Monitors 1.3.6.1.2.1.2.2.1.1.1 every 1800 seconds
Requested # of time intervals, ie buckets, is 8
Granted # of time intervals, ie buckets, is 8
Sample # 1 began measuring at 00:00:01
Received 77671 octets, 1077 packets,
61 broadcast and 978 multicast packets,
0 undersized and 0 oversized packets,
0 fragments and 0 jabbers packets,
0 CRC alignment errors and 0 collisions.
# of dropped packet events is 0
Network utilization is estimated at 0
.
.
.
show rmon statistics This command shows the information collected for all configured entries in the
statistics group.
Command Mode
Privileged Exec
Example
Console#show rmon statistics
Interface 1 is valid, and owned by
Monitors 1.3.6.1.2.1.2.2.1.1.1 which has
Received 164289 octets, 2372 packets,
120 broadcast and 2211 multicast packets,
0 undersized and 0 oversized packets,
0 fragments and 0 jabbers,
0 CRC alignment errors and 0 collisions.
# of dropped packet events (due to lack of resources): 0
# of packets received of length (in octets):
64: 2245, 65-127: 87, 128-255: 31,
256-511: 5, 512-1023: 2, 1024-1518: 2
.
.
.
– 209 –
Chapter 6 | Remote Monitoring Commands
– 210 –
7 Flow Sampling Commands
Flow sampling (sFlow) can be used with a remote sFlow Collector to provide an
accurate, detailed and real-time overview of the types and levels of traffic present
on the network. The sFlow Agent samples 1 out of n packets from all data
traversing the switch, re-encapsulates the samples as sFlow datagrams and
transmits them to the sFlow Collector. This sampling occurs at the internal
hardware level where all traffic is seen, whereas traditional probes only have a
partial view of traffic as it is sampled at the monitored interface. Moreover, the
processor and memory load imposed by the sFlow agent is minimal since local
analysis does not take place.
Note: The terms “collector”, “receiver” and “owner”, in the context of this chapter, all
refer to a remote server capable of receiving the sFlow datagrams generated by the
sFlow agent of the switch.
sflow owner Creates an sFlow collector which the switch uses to send PE
samples to.
sflow polling instance Configures an sFlow polling data source that takes samples PE
periodically based on time.
sflow sampling instance Configures an sFlow sampling data source that samples PE
periodically based on a packet count.
show sflow Shows the global and interface settings for the sFlow PE
process
– 211 –
Chapter 7 | Flow Sampling Commands
sflow owner This command creates an sFlow collector on the switch. Use the no form to remove
the sFlow receiver.
Syntax
sflow owner owner-name timeout timeout-value
[destination {ipv4-address | ipv6-address}
[max-datagram-size max-datagram-size] [version {v4 | v5}]
[port destination-udp-port ] [max-datagram-size max-datagram-size]
[version {v4 | v5}]]
[port destination-udp-port]
no sflow owner owner-name
owner-name - Name of the collector. (Range: 1-30 alphanumeric characters)
timeout-value - The length of time the sFlow interface is available to send
samples to a receiver, after which the owner and associated polling and
sampling data source instances are removed from the configuration.
(Range: 30-10000000 seconds)
ipv4-address - IPv4 address of the sFlow collector. Valid IPv4 addresses
consist of four decimal numbers, 0 to 255, separated by periods.
ipv6-address - IPv6 address of the sFlow collector. A full IPv6 address
including the network prefix and host address bits. An IPv6 address consists
of 8 colon-separated 16-bit hexadecimal values. One double colon may be
used to indicate the appropriate number of zeros required to fill the
undefined fields.
destination-udp-port - The UDP port on which the collector is listening for
sFlow streams. (Range: 1-65535)
max-datagram-size - The maximum size of the sFlow datagram payload.
(Range: 200-1500 bytes)
version {v4 | v5} - Sends either v4 or v5 sFlow datagrams to the receiver.
Default Setting
No owner is configured
UDP Port: 6343
Version: v5
Maximum Datagram Size: 1400 bytes
Command Mode
Privileged Exec
Command Usage
◆ Use the sflow owner command to create an owner instance of an sFlow
collector. If the socket port, maximum datagram size, and datagram version are
not specified, then the default values are used.
– 212 –
Chapter 7 | Flow Sampling Commands
◆ Once an owner is created, the sflow owner command can again be used to
modify the owner’s port number. All other parameter values for the owner will
be retained if the port is modified.
◆ When the sflow owner command is issued, it’s associated timeout value will
immediately begin to count down. Once the timeout value has reached zero
seconds, the sFlow owner and it’s associated sampling sources will be deleted
from the configuration.
Example
This example shows an sflow collector being created on the switch.
This example shows how to modify the sFlow port number for an already
configured collector.
sflow polling instance This command enables an sFlow polling data source, for a specified interface, that
polls periodically based on a specified time interval. Use the no form to remove the
polling data source instance from the switch’s sFlow configuration.
Syntax
sflow polling {interface interface} instance instance-id receiver owner-name
polling-interval seconds
no sflow polling {interface interface} instance instance-id
interface - The source from which the samples will be taken at specified
intervals and sent to a collector.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-18)
– 213 –
Chapter 7 | Flow Sampling Commands
Default Setting
No sFlow polling instance is configured.
Command Mode
Privileged Exec
Command Usage
This command enables a polling data source and configures the interval at which
counter values are added to the sample datagram.
Example
This example sets the polling interval to 10 seconds.
sflow sampling This command enables an sFlow data source instance for a specific interface that
instance takes samples periodically based on the number of packets processed. Use the no
form to remove the sampling data source instance from the switch’s sFlow
configuration.
Syntax
sflow sampling {interface interface} instance instance-id receiver owner-name
sampling-rate sample-rate
[max-header-size max-header-size]
no sflow sample {interface interface} instance instance-id
interface - The source from which the samples will be taken and sent to a
collector.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-18)
– 214 –
Chapter 7 | Flow Sampling Commands
Default Setting
No sFlow sampling instance id configured.
Maximum Header Size: 128 bytes
Command Mode
Privileged Exec
Example
This example enables a sampling data source on Ethernet interface 1/1, an
associated receiver named “owner1”, and a sampling rate of one out of 100. The
maximum header size is also set to 200 bytes.
The following command removes a sampling data source from Ethernet interface
1/1.
show sflow This command shows the global and interface settings for the sFlow process.
Syntax
show sflow [owner owner-name | interface interface]
owner-name - The associated receiver, to which the samples are sent.
(Range: 1-30 alphanumeric characters)
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-18)
– 215 –
Chapter 7 | Flow Sampling Commands
Command Mode
Privileged Exec
Example
Console#show sflow interface ethernet 1/2
Console#
– 216 –
8 Authentication Commands
You can configure this switch to authenticate users logging into the system for
management access using local or remote authentication methods. Port-based
authentication using IEEE 802.1X can also be configured to control either
management access to the uplink ports or client access3 to the data ports.
User Accounts and Configures the basic user names and passwords for management
Privilege Levels access, and assigns a privilege level to specified command groups or
individual commands
802.1X Port Authentication Configures host authentication on specific ports using 802.1X
PPPoE Intermediate Agent Configures relay parameters required for sending authentication
messages between a client and broadband remote access servers
3. For other methods of controlling client access, see “General Security Measures” on
page 283.
– 217 –
Chapter 8 | Authentication Commands
User Accounts and Privilege Levels
show privilege Shows the privilege level for the current user, or the PE
privilege level for commands modified by the privilege
command
enable password After initially logging onto the system, you should set the Privileged Exec password.
Remember to record it in a safe place. This command controls access to the
Privileged Exec level from the Normal Exec level. Use the no form to reset the
default password.
Syntax
enable password [level level] {0 | 7} password
no enable password [level level]
level level - Sets the command access privileges. (Range: 0-15)
Level 0, 8 and 15 are designed for users (guest), managers (network
maintenance), and administrators (top-level access). The other levels can
be used to configured specialized access profiles.
Level 0-7 provide the same default access privileges, all within Normal
Exec mode under the “Console>” command prompt.
Level 8-14 provide the same default access privileges, including
additional commands in Normal Exec mode, and a subset of commands
in Privileged Exec mode under the “Console#” command prompt.
Level 15 provides full access to all commands.
The privilege level associated with any command can be changed using
the privilege command.
{0 | 7} - 0 means plain password, 7 means encrypted password.
password - Password for this privilege level.
(Maximum length: 32 characters plain text or encrypted, case sensitive)
– 218 –
Chapter 8 | Authentication Commands
User Accounts and Privilege Levels
Default Setting
The default is level 15.
The default password is “super”
Command Mode
Global Configuration
Command Usage
◆ You cannot set a null password. You will have to enter a password to change the
command mode from Normal Exec to Privileged Exec with the enable
command.
Example
Console(config)#enable password level 15 0 admin
Console(config)#
Related Commands
enable (87)
authentication enable (222)
username This command adds named users, requires authentication at login, specifies or
changes a user's password (or specify that no password is required), or specifies or
changes a user's access level. Use the no form to remove a user name.
Syntax
username name {access-level level | nopassword | password {0 | 7} password}
no username name
name - The name of the user. (Maximum length: 32 characters,
case sensitive. Maximum users: 16)
The device has two predefined users, guest which is assigned privilege
level 0 (Normal Exec) and has access to a limited number of commands,
and admin which is assigned privilege level 15 and has full access to all
commands.
access-level level - Specifies command access privileges. (Range: 0-15)
Level 0, 8 and 15 are designed for users (guest), managers (network
maintenance), and administrators (top-level access). The other levels can
be used to configured specialized access profiles.
Level 0-7 provide the same default access privileges, all within Normal
Exec mode under the “Console>” command prompt.
– 219 –
Chapter 8 | Authentication Commands
User Accounts and Privilege Levels
Default Setting
The default access level is 0 (Normal Exec).
The factory defaults for the user names and passwords are:
guest 0 guest
admin 15 admin
Command Mode
Global Configuration
Command Usage
The encrypted password is required for compatibility with legacy password
settings (i.e., plain text or encrypted) when reading the configuration file during
system bootup or when downloading the configuration file from an FTP server.
There is no need for you to manually configure encrypted passwords.
Example
This example shows how the set the access level and password for a user.
– 220 –
Chapter 8 | Authentication Commands
User Accounts and Privilege Levels
privilege This command assigns a privilege level to specified command groups or individual
commands. Use the no form to restore the default setting.
Syntax
privilege mode [all] level level command
no privilege mode [all] command
mode - The configuration mode containing the specified command.
(See “Understanding Command Modes” on page 78 and “Configuration
Commands” on page 80.)
all - Modifies the privilege level for all subcommands under the specified
command.
level level - Specifies the privilege level for the specified command. Refer to
the default settings described for the access level parameter under the
username command. (Range: 0-15)
command - Specifies any command contained within the specified mode.
Default Setting
Privilege level 0 provides access to a limited number of the commands which
display the current status of the switch, as well as several database clear and reset
functions. Level 8 provides access to all display status and configuration
commands, except for those controlling various authentication and security
features. Level 15 provides full access to all commands.
Command Mode
Global Configuration
Example
This example sets the privilege level for the ping command to Privileged Exec.
show privilege This command shows the privilege level for the current user, or the privilege level
for commands modified by the privilege command.
Syntax
show privilege [command]
command - Displays the privilege level for all commands modified by the
privilege command.
Command Mode
Privileged Exec
– 221 –
Chapter 8 | Authentication Commands
Authentication Sequence
Example
This example shows the privilege level for any command modified by the privilege
command.
Authentication Sequence
Three authentication methods can be specified to authenticate users logging into
the system for management access. The commands in this section can be used to
define the authentication method and sequence.
authentication enable This command defines the authentication method and precedence to use when
changing from Exec command mode to Privileged Exec command mode with the
enable command. Use the no form to restore the default.
Syntax
authentication enable {[local] [radius] [tacacs]}
no authentication enable
local - Use local password only.
radius - Use RADIUS server password only.
tacacs - Use TACACS server password.
Default Setting
Local
Command Mode
Global Configuration
Command Usage
◆ RADIUS uses UDP while TACACS+ uses TCP. UDP only offers best effort delivery,
while TCP offers a connection-oriented transport. Also, note that RADIUS
encrypts only the password in the access-request packet from the client to the
server, while TACACS+ encrypts the entire body of the packet.
– 222 –
Chapter 8 | Authentication Commands
Authentication Sequence
◆ RADIUS and TACACS+ logon authentication assigns a specific privilege level for
each user name and password pair. The user name, password, and privilege
level must be configured on the authentication server.
Example
Console(config)#authentication enable radius
Console(config)#
Related Commands
enable password - sets the password for changing command modes (218)
authentication login This command defines the login authentication method and precedence. Use the
no form to restore the default.
Syntax
authentication login {[local] [radius] [tacacs]}
no authentication login
local - Use local password.
radius - Use RADIUS server password.
tacacs - Use TACACS server password.
Default Setting
Local
Command Mode
Global Configuration
Command Usage
◆ RADIUS uses UDP while TACACS+ uses TCP. UDP only offers best effort delivery,
while TCP offers a connection-oriented transport. Also, note that RADIUS
encrypts only the password in the access-request packet from the client to the
server, while TACACS+ encrypts the entire body of the packet.
◆ RADIUS and TACACS+ logon authentication assigns a specific privilege level for
each user name and password pair. The user name, password, and privilege
level must be configured on the authentication server.
– 223 –
Chapter 8 | Authentication Commands
RADIUS Client
Example
Console(config)#authentication login radius
Console(config)#
Related Commands
username - for setting the local user names and passwords (219)
RADIUS Client
Remote Authentication Dial-in User Service (RADIUS) is a logon authentication
protocol that uses software running on a central server to control access to RADIUS-
aware devices on the network. An authentication server contains a database of
multiple user name/password pairs with associated privilege levels for each user or
group that require management access to a switch.
radius-server encrypted- Sets the RADIUS encryption key sent in encrypted text GC
key
radius-server This command sets the RADIUS server network port for accounting messages. Use
acct-port the no form to restore the default.
Syntax
radius-server acct-port port-number
no radius-server acct-port
– 224 –
Chapter 8 | Authentication Commands
RADIUS Client
Default Setting
1813
Command Mode
Global Configuration
Example
Console(config)#radius-server acct-port 181
Console(config)#
radius-server This command sets the RADIUS server network port. Use the no form to restore the
auth-port default.
Syntax
radius-server auth-port port-number
no radius-server auth-port
port-number - RADIUS server UDP port used for authentication messages.
(Range: 1-65535)
Default Setting
1812
Command Mode
Global Configuration
Example
Console(config)#radius-server auth-port 181
Console(config)#
radius-server host This command specifies primary and backup RADIUS servers, and authentication
and accounting parameters that apply to each server. Use the no form to remove a
specified server, or to restore the default values.
Syntax
[no] radius-server index host host-ip-address [acct-port acct-port] [auth-
port auth-port] [key key] [retransmit retransmit] [timeout timeout]
index - Allows you to specify up to five servers. These servers are queried in
sequence until a server responds or the retransmit period expires.
host-ip-address - IP address of server.
– 225 –
Chapter 8 | Authentication Commands
RADIUS Client
Default Setting
auth-port - 1812
acct-port - 1813
timeout - 5 seconds
retransmit - 3
Command Mode
Global Configuration
Example
Console(config)#radius-server 1 host 192.168.1.20 auth-port 181 timeout 10
retransmit 5 key green
Console(config)#
radius-server key This command sets the RADIUS encryption key. Use the no form to restore the
default.
Syntax
radius-server key key-string
no radius-server key
key-string - Encryption key used to authenticate logon access for client.
Enclose any string containing blank spaces in double quotes.
(Maximum length: 48 characters)
Default Setting
None
Command Mode
Global Configuration
– 226 –
Chapter 8 | Authentication Commands
RADIUS Client
Example
Console(config)#radius-server key green
Console(config)#
radius-server This command sets the RADIUS encryption key to be sent in encrypted text. Use the
encrypted-key no form to restore the default.
Syntax
radius-server key key-string
no radius-server key
key-string - Encryption key sent in encrypted text and used to authenticate
logon access for client. Enclose any character string using ASCII characters
“A-Z” or “a-z”. (Maximum length: 48 characters)
Default Setting
None
Command Mode
Global Configuration
Example
Console(config)#radius-server encrypted-key green
Console(config)#
radius-server This command sets the number of retries. Use the no form to restore the default.
retransmit
Syntax
radius-server retransmit number-of-retries
no radius-server retransmit
number-of-retries - Number of times the switch will try to authenticate
logon access via the RADIUS server. (Range: 1 - 5)
Default Setting
3
Command Mode
Global Configuration
Example
Console(config)#radius-server retransmit 5
Console(config)#
– 227 –
Chapter 8 | Authentication Commands
RADIUS Client
radius-server timeout This command sets the interval between transmitting authentication requests to
the RADIUS server. Use the no form to restore the default.
Syntax
radius-server timeout number-of-seconds
no radius-server timeout
number-of-seconds - Number of seconds the switch waits for a reply before
resending a request. (Range: 1-10)
Default Setting
5
Command Mode
Global Configuration
Example
Console(config)#radius-server timeout 10
Console(config)#
show radius-server This command displays the current settings for the RADIUS server.
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show radius-server
Global Settings:
Authentication Port Number : 1812
Accounting Port Number : 1813
Retransmit Times : 3
Request Timeout : 5
Server 1:
Server IP Address : 192.168.1.1
Authentication Port Number : 1812
Accounting Port Number : 1813
Retransmit Times : 2
Request Timeout : 5
– 228 –
Chapter 8 | Authentication Commands
TACACS+ Client
radius 1
Console#
TACACS+ Client
Terminal Access Controller Access Control System (TACACS+) is a logon
authentication protocol that uses software running on a central server to control
access to TACACS-aware devices on the network. An authentication server contains
a database of multiple user name/password pairs with associated privilege levels
for each user or group that require management access to a switch.
tacacs-server encrypted- Sets the TACACS+ encryption key sent in encrypted text GC
key
tacacs-server host This command specifies the TACACS+ server and other optional parameters. Use
the no form to remove the server, or to restore the default values.
Syntax
tacacs-server index host host-ip-address [key key] [port port-number]
[retransmit retransmit] [timeout timeout]
no tacacs-server index
index - The index for this server. (Range: 1-5)
host-ip-address - IPv4 or IPv6 address of a TACACS+ server.
key - Encryption key used to authenticate logon access for the client.
Enclose any string containing blank spaces in double quotes.
(Maximum length: 48 characters)
port-number - TACACS+ server TCP port used for authentication messages.
(Range: 1-65535)
retransmit - Number of times the switch will try to authenticate logon
access via the TACACS+ server. (Range: 1-5)
timeout - Number of seconds the switch waits for a reply before resending
a request. (Range: 1-10)
– 229 –
Chapter 8 | Authentication Commands
TACACS+ Client
Default Setting
authentication port - 49
timeout - 5 seconds
retransmit - 3
Command Mode
Global Configuration
Example
Console(config)#tacacs-server 1 host 192.168.1.25 port 181 timeout 10
retransmit 5 key green
Console(config)#
tacacs-server key This command sets the TACACS+ encryption key. Use the no form to restore the
default.
Syntax
tacacs-server key key-string
no tacacs-server key
key-string - Encryption key used to authenticate logon access for the client.
Enclose any string containing blank spaces in double quotes.
(Maximum length: 48 characters)
Default Setting
None
Command Mode
Global Configuration
Example
Console(config)#tacacs-server key green
Console(config)#
– 230 –
Chapter 8 | Authentication Commands
TACACS+ Client
tacacs-server This command sets the TACACS+ encryption key to be sent in encrypted text. Use
encrypted-key the no form to restore the default.
Syntax
tacacs-server encrypted-key key-string
no tacacs-server encrypted-key
key-string - Encryption key sent in encrypted text and used to authenticate
logon access for client. Enclose any character string using ASCII characters
“A-Z” or “a-z”. (Maximum length: 48 characters)
Default Setting
None
Command Mode
Global Configuration
Example
Console(config)#tacacs-server encrypted-key green
Console(config)#
tacacs-server port This command specifies the TACACS+ server network port. Use the no form to
restore the default.
Syntax
tacacs-server port port-number
no tacacs-server port
port-number - TACACS+ server TCP port used for authentication messages.
(Range: 1-65535)
Default Setting
49
Command Mode
Global Configuration
Example
Console(config)#tacacs-server port 181
Console(config)#
– 231 –
Chapter 8 | Authentication Commands
TACACS+ Client
tacacs-server This command sets the number of retries. Use the no form to restore the default.
retransmit
Syntax
tacacs-server retransmit number-of-retries
no tacacs-server retransmit
number-of-retries - Number of times the switch will try to authenticate
logon access via the TACACS+ server. (Range: 1 - 5)
Default Setting
3
Command Mode
Global Configuration
Example
Console(config)#tacacs-server retransmit 5
Console(config)#
tacacs-server timeout This command sets the interval between transmitting authentication requests to
the TACACS+ server. Use the no form to restore the default.
Syntax
tacacs-server timeout number-of-seconds
no tacacs-server timeout
number-of-seconds - Number of seconds the switch waits for a reply before
resending a request. (Range: 1-10)
Default Setting
5
Command Mode
Global Configuration
Example
Console(config)#tacacs-server timeout 10
Console(config)#
– 232 –
Chapter 8 | Authentication Commands
AAA
show tacacs-server This command displays the current settings for the TACACS+ server.
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show tacacs-server
Global Settings:
Server Port Number : 49
Retransmit Times : 3
Timeout : 5
Server 1:
Server IP Address : 10.11.12.13
Server Port Number : 49
Retransmit Times : 2
Timeout : 4
AAA
The Authentication, Authorization, and Accounting (AAA) feature provides the
main framework for configuring access control on the switch. The AAA functions
require the use of configured RADIUS or TACACS+ servers in the network.
– 233 –
Chapter 8 | Authentication Commands
AAA
aaa accounting This command enables the accounting of Exec mode commands. Use the no form
commands to disable the accounting service.
Syntax
aaa accounting commands level {default | method-name} start-stop group
{tacacs+ | server-group}
no aaa accounting commands level {default | method-name}
level - The privilege level for executing commands. (Range: 0-15)
default - Specifies the default accounting method for service requests.
method-name - Specifies an accounting method for service requests.
(Range: 1-64 characters)
start-stop - Records accounting from starting point and stopping point.
group - Specifies the server group to use.
tacacs+ - Specifies all TACACS+ hosts configured with the tacacs-server
host command.
server-group - Specifies the name of a server group configured with the
aaa group server command. (Range: 1-64 characters)
Default Setting
Accounting is not enabled
No servers are specified
Command Mode
Global Configuration
– 234 –
Chapter 8 | Authentication Commands
AAA
Command Usage
◆ The accounting of Exec mode commands is only supported by TACACS+
servers.
◆ Note that the default and method-name fields are only used to describe the
accounting method(s) configured on the specified TACACS+ server, and do not
actually send any information to the server about the methods to use.
Example
Console(config)#aaa accounting commands 15 default start-stop group tacacs+
Console(config)#
aaa accounting dot1x This command enables the accounting of requested 802.1X services for network
access. Use the no form to disable the accounting service.
Syntax
aaa accounting dot1x {default | method-name}
start-stop group {radius | tacacs+ |server-group}
no aaa accounting dot1x {default | method-name}
default - Specifies the default accounting method for service requests.
method-name - Specifies an accounting method for service requests.
(Range: 1-64 characters)
start-stop - Records accounting from starting point and stopping point.
group - Specifies the server group to use.
radius - Specifies all RADIUS hosts configure with the radius-server
host command.
tacacs+ - Specifies all TACACS+ hosts configure with the tacacs-server
host command.
server-group - Specifies the name of a server group configured with the
aaa group server command. (Range: 1-64 characters)
Default Setting
Accounting is not enabled
No servers are specified
Command Mode
Global Configuration
Command Usage
Note that the default and method-name fields are only used to describe the
accounting method(s) configured on the specified RADIUS or TACACS+ servers, and
do not actually send any information to the servers about the methods to use.
– 235 –
Chapter 8 | Authentication Commands
AAA
Example
Console(config)#aaa accounting dot1x default start-stop group radius
Console(config)#
aaa accounting exec This command enables the accounting of requested Exec services for network
access. Use the no form to disable the accounting service.
Syntax
aaa accounting exec {default | method-name}
start-stop group {radius | tacacs+ |server-group}
no aaa accounting exec {default | method-name}
default - Specifies the default accounting method for service requests.
method-name - Specifies an accounting method for service requests.
(Range: 1-64 characters)
start-stop - Records accounting from starting point and stopping point.
group - Specifies the server group to use.
radius - Specifies all RADIUS hosts configure with the radius-server
host command.
tacacs+ - Specifies all TACACS+ hosts configure with the tacacs-server
host command.
server-group - Specifies the name of a server group configured with the
aaa group server command. (Range: 1-64 characters)
Default Setting
Accounting is not enabled
No servers are specified
Command Mode
Global Configuration
Command Usage
◆ This command runs accounting for Exec service requests for the local console
and Telnet connections.
◆ Note that the default and method-name fields are only used to describe the
accounting method(s) configured on the specified RADIUS or TACACS+ servers,
and do not actually send any information to the servers about the methods to
use.
Example
Console(config)#aaa accounting exec default start-stop group tacacs+
Console(config)#
– 236 –
Chapter 8 | Authentication Commands
AAA
aaa accounting This command enables the sending of periodic updates to the accounting server.
update Use the no form to disable accounting updates.
Syntax
aaa accounting update [periodic interval]
no aaa accounting update
interval - Sends an interim accounting record to the server at this interval.
(Range: 1-2147483647 minutes)
Default Setting
1 minute
Command Mode
Global Configuration
Command Usage
◆ When accounting updates are enabled, the switch issues periodic interim
accounting records for all users on the system.
Example
Console(config)#aaa accounting update periodic 30
Console(config)#
aaa authorization This command enables the authorization of Exec mode commands. Use the no
commands form to disable the authorization service.
Syntax
aaa authorization commands level {default | method-name} group {tacacs+ |
server-group}
no aaa authorization commands level {default | method-name}
level - The privilege level for executing commands. (Range: 0-15)
default - Specifies the default authorization method for service requests.
method-name - Specifies an authorization method for service requests.
(Range: 1-64 characters)
group - Specifies the server group to use.
tacacs+ - Specifies all TACACS+ hosts configured with the tacacs-server
host command.
server-group - Specifies the name of a server group configured with the
aaa group server command. (Range: 1-64 characters)
– 237 –
Chapter 8 | Authentication Commands
AAA
Default Setting
Authorization is not enabled
No servers are specified
Command Mode
Global Configuration
Command Usage
◆ The authorization of Exec mode commands is only supported by TACACS+
servers.
◆ Note that the default and method-name fields are only used to describe the
authorization method(s) configured on the specified TACACS+ server, and do
not actually send any information to the server about the methods to use.
Example
Console(config)#aaa authorization commands 15 default group tacacs+
Console(config)#
aaa authorization exec This command enables the authorization for Exec access. Use the no form to
disable the authorization service.
Syntax
aaa authorization exec {default | method-name}
group {tacacs+ | server-group}
no aaa authorization exec {default | method-name}
default - Specifies the default authorization method for Exec access.
method-name - Specifies an authorization method for Exec access.
(Range: 1-64 characters)
group - Specifies the server group to use.
tacacs+ - Specifies all TACACS+ hosts configured with the tacacs-server
host command.
server-group - Specifies the name of a server group configured with the
aaa group server command. (Range: 1-64 characters)
Default Setting
Authorization is not enabled
No servers are specified
Command Mode
Global Configuration
– 238 –
Chapter 8 | Authentication Commands
AAA
Command Usage
◆ This command performs authorization to determine if a user is allowed to run
an Exec shell for local console, Telnet, or SSH connections.
Example
Console(config)#aaa authorization exec default group tacacs+
Console(config)#
aaa group server Use this command to name a group of security server hosts. To remove a server
group from the configuration list, enter the no form of this command.
Syntax
[no] aaa group server {radius | tacacs+} group-name
radius - Defines a RADIUS server group.
tacacs+ - Defines a TACACS+ server group.
group-name - A text string that names a security server group.
(Range: 1-64 characters)
Default Setting
None
Command Mode
Global Configuration
Example
Console(config)#aaa group server radius tps
Console(config-sg-radius)#
server This command adds a security server to an AAA server group. Use the no form to
remove the associated server from the group.
Syntax
[no] server {index | ip-address}
index - Specifies the server index. (Range: RADIUS 1-5, TACACS+ 1)
ip-address - Specifies the host IP address of a server.
– 239 –
Chapter 8 | Authentication Commands
AAA
Default Setting
None
Command Mode
Server Group Configuration
Command Usage
◆ When specifying the index for a RADIUS server, that server index must already
be defined by the radius-server host command.
◆ When specifying the index for a TACACS+ server, that server index must already
be defined by the tacacs-server host command.
Example
Console(config)#aaa group server radius tps
Console(config-sg-radius)#server 10.2.68.120
Console(config-sg-radius)#
accounting dot1x This command applies an accounting method for 802.1X service requests on an
interface. Use the no form to disable accounting on the interface.
Syntax
accounting dot1x {default | list-name}
no accounting dot1x
default - Specifies the default method list created with the aaa accounting
dot1x command.
list-name - Specifies a method list created with the aaa accounting dot1x
command.
Default Setting
None
Command Mode
Interface Configuration
Example
Console(config)#interface ethernet 1/2
Console(config-if)#accounting dot1x tps
Console(config-if)#
accounting This command applies an accounting method to entered CLI commands. Use the
commands no form to disable accounting for entered CLI commands.
– 240 –
Chapter 8 | Authentication Commands
AAA
Syntax
accounting commands level {default | list-name}
no accounting commands level
level - The privilege level for executing commands. (Range: 0-15)
default - Specifies the default method list created with the aaa accounting
commands command.
list-name - Specifies a method list created with the aaa accounting
commands command.
Default Setting
None
Command Mode
Line Configuration
Example
Console(config)#line console
Console(config-line)#accounting commands 15 default
Console(config-line)#
accounting exec This command applies an accounting method to local console, Telnet or SSH
connections. Use the no form to disable accounting on the line.
Syntax
accounting exec {default | list-name}
no accounting exec
default - Specifies the default method list created with the aaa accounting
exec command.
list-name - Specifies a method list created with the aaa accounting exec
command.
Default Setting
None
Command Mode
Line Configuration
Example
Console(config)#line console
Console(config-line)#accounting exec tps
Console(config-line)#exit
Console(config)#line vty
– 241 –
Chapter 8 | Authentication Commands
AAA
authorization This command applies an authorization method to entered CLI commands. Use the
commands no form to disable authorization for entered CLI commands.
Syntax
authorization commands level {default | list-name}
no authorization commands level
level - The privilege level for executing commands. (Range: 0-15)
default - Specifies the default method list created with the aaa
authorization commands command.
list-name - Specifies a method list created with the aaa authorization
commands command.
Default Setting
None
Command Mode
Line Configuration
Example
Console(config)#line console
Console(config-line)#authorization commands 15 default
Console(config-line)#
authorization exec This command applies an authorization method to local console, Telnet or SSH
connections. Use the no form to disable authorization on the line.
Syntax
authorization exec {default | list-name}
no authorization exec
default - Specifies the default method list created with the aaa
authorization exec command.
list-name - Specifies a method list created with the aaa authorization exec
command.
Default Setting
None
Command Mode
Line Configuration
– 242 –
Chapter 8 | Authentication Commands
AAA
Example
Console(config)#line console
Console(config-line)#authorization exec tps
Console(config-line)#exit
Console(config)#line vty
Console(config-line)#authorization exec default
Console(config-line)#
show accounting This command displays the current accounting settings per function and per port.
Syntax
show accounting [commands [level]] |
[[dot1x [statistics [username user-name | interface interface]] |
exec [statistics] | statistics]
commands - Displays command accounting information.
level - Displays command accounting information for a specifiable
command level.
dot1x - Displays dot1x accounting information.
exec - Displays Exec accounting records.
statistics - Displays accounting records.
user-name - Displays accounting records for a specifiable username.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show accounting
Accounting Type : dot1x
Method List : default
Group List : radius
Interface : Eth 1/1
– 243 –
Chapter 8 | Authentication Commands
AAA
Interface : vty
Console#
show authorization This command displays the current authorization settings per function and per
port.
Syntax
show authorization [commands [level] | exec]
commands - Displays command authorization information.
level - Displays command authorization information for a specifiable
command level.
exec - Displays Exec authorization records.
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show authorization
Authorization Type : EXEC
Method List : default
Group List : tacacs+
Interface : vty
Console#
– 244 –
Chapter 8 | Authentication Commands
Web Server
Web Server
This section describes commands used to configure web browser management
access to the switch.
ip http authentication Sets the method list for EXEC authorization of an EXEC GC
session
ip http port Specifies the port to be used by the web browser interface GC
Note: Users are automatically logged off of the HTTP server or HTTPS server if no
input is detected for 300 seconds.
ip http authentication This command specifies the method list for EXEC authorization for starting an EXEC
session used by the web browser interface. Use the no form to use the default port.
Syntax
ip http authentication aaa exec-authorization {default | list-name}
no ip http authentication aaa exec-authorization
default - Specifies the default method list used for authorization requests.
list-name - Specifies a method list created with the aaa authorization
commands command.
Default Setting
None
Command Mode
Global Configuration
Example
Console(config)#ip http authentication aaa exec-authorization default
Console(config)#
– 245 –
Chapter 8 | Authentication Commands
Web Server
Related Commands
aaa authorization commands (237)
ip http server (246)
show system (111)
ip http port This command specifies the TCP port number used by the web browser interface.
Use the no form to use the default port.
Syntax
ip http port port-number
no ip http port
port-number - The TCP port to be used by the browser interface.
(Range: 1-65535)
Default Setting
80
Command Mode
Global Configuration
Example
Console(config)#ip http port 769
Console(config)#
Related Commands
ip http server (246)
show system (111)
ip http server This command allows this device to be monitored or configured from a browser.
Use the no form to disable this function.
Syntax
[no] ip http server
Default Setting
Enabled
Command Mode
Global Configuration
Example
Console(config)#ip http server
Console(config)#
– 246 –
Chapter 8 | Authentication Commands
Web Server
Related Commands
ip http authentication (245)
show system (111)
ip http secure-port This command specifies the TCP port number used for HTTPS connection to the
switch’s web interface. Use the no form to restore the default port.
Syntax
ip http secure-port port_number
no ip http secure-port
port_number – The TCP port used for HTTPS. (Range: 1-65535, except for
the following reserved ports: 1 and 25 - Linux kernel, 23 - Telnet, 80 - HTTP)
Default Setting
443
Command Mode
Global Configuration
Command Usage
◆ You cannot configure the HTTP and HTTPS servers to use the same port.
◆ If you change the HTTPS port number, clients attempting to connect to the
HTTPS server must specify the port number in the URL, in this format: https://
device:port_number
Example
Console(config)#ip http secure-port 1000
Console(config)#
Related Commands
ip http secure-server (247)
show system (111)
ip http secure-server This command enables the secure hypertext transfer protocol (HTTPS) over the
Secure Socket Layer (SSL), providing secure access (i.e., an encrypted connection)
to the switch’s web interface. Use the no form to disable this function.
Syntax
[no] ip http secure-server
Default Setting
Enabled
– 247 –
Chapter 8 | Authentication Commands
Web Server
Command Mode
Global Configuration
Command Usage
◆ Both HTTP and HTTPS service can be enabled independently on the switch.
However, you cannot configure the HTTP and HTTPS servers to use the same
UDP port.
◆ If you enable HTTPS, you must indicate this in the URL that you specify in your
browser: https://device[:port_number]
◆ Connection to the web interface is not supported for HTTPS using an IPv6 link
local address.
Example
Console(config)#ip http secure-server
Console(config)#
Related Commands
ip http secure-port (247)
copy tftp https-certificate (118)
– 248 –
Chapter 8 | Authentication Commands
Telnet Server
Telnet Server
This section describes commands used to configure Telnet management access to
the switch.
ip telnet max-sessions Specifies the maximum number of Telnet sessions that can GC
simultaneously connect to this system
Note: This switch also supports a Telnet client function. A Telnet connection can be
made from this switch to another device by entering the telnet command at the
Privileged Exec configuration level.
ip telnet max-sessions This command specifies the maximum number of Telnet sessions that can
simultaneously connect to this system. Use the no from to restore the default
setting.
Syntax
ip telnet max-sessions session-count
no ip telnet max-sessions
session-count - The maximum number of allowed Telnet session.
(Range: 0-8)
Default Setting
8 sessions
Command Mode
Global Configuration
Command Usage
A maximum of eight sessions can be concurrently opened for Telnet and Secure
Shell (i.e., both Telnet and SSH share a maximum number of eight sessions).
– 249 –
Chapter 8 | Authentication Commands
Telnet Server
Example
Console(config)#ip telnet max-sessions 1
Console(config)#
ip telnet port This command specifies the TCP port number used by the Telnet interface. Use the
no form to use the default port.
Syntax
ip telnet port port-number
no telnet port
port-number - The TCP port number to be used by the browser interface.
(Range: 1-65535)
Default Setting
23
Command Mode
Global Configuration
Example
Console(config)#ip telnet port 123
Console(config)#
ip telnet server This command allows this device to be monitored or configured from Telnet. Use
the no form to disable this function.
Syntax
[no] ip telnet server
Default Setting
Enabled
Command Mode
Global Configuration
Example
Console(config)#ip telnet server
Console(config)#
telnet (client) This command accesses a remote device using a Telnet connection.
– 250 –
Chapter 8 | Authentication Commands
Secure Shell
Syntax
telnet host
host - IP address or alias of a remote device.
Command Mode
Privileged Exec
Example
Console#telnet 192.168.2.254
Connect To 192.168.2.254...
***************************************************************
Username:
Console(config)#
show ip telnet This command displays the configuration settings for the Telnet server.
Command Mode
Normal Exec, Privileged Exec
Example
Console#show ip telnet
IP Telnet Configuration:
Secure Shell
This section describes the commands used to configure the SSH server. Note that
you also need to install a SSH client on the management station when using this
protocol to configure the switch.
– 251 –
Chapter 8 | Authentication Commands
Secure Shell
ip ssh timeout Specifies the authentication timeout for the SSH server GC
copy tftp public-key Copies the user’s public key from a TFTP server to the PE
switch
delete public-key Deletes the public key for the specified user PE
ip ssh save host-key Saves the host key from RAM to flash memory PE
show ip ssh Displays the status of the SSH server and the configured PE
values for authentication timeout and retries
show public-key Shows the public key for the specified user or for the host PE
show users Shows SSH users, including privilege level and public key PE
type
Configuration Guidelines
The SSH server on this switch supports both password and public key
authentication. If password authentication is specified by the SSH client, then the
password can be authenticated either locally or via a RADIUS or TACACS+ remote
authentication server, as specified by the authentication login command. If public
key authentication is specified by the client, then you must configure
authentication keys on both the client and the switch as described in the following
section. Note that regardless of whether you use public key or password
authentication, you still have to generate authentication keys on the switch and
enable the SSH server.
1. Generate a Host Key Pair – Use the ip ssh crypto host-key generate command to
create a host public/private key pair.
2. Provide Host Public Key to Clients – Many SSH client programs automatically
import the host public key during the initial connection setup with the switch.
Otherwise, you need to manually create a known hosts file on the management
station and place the host public key in it. An entry for a public key in the
known hosts file would appear similar to the following example:
– 252 –
Chapter 8 | Authentication Commands
Secure Shell
108259132128902337654680172627257141342876294130119619556678259566410486957427
888146206519417467729848654686157177393901647793559423035774130980227370877945
4524083971752646358058176716709574804776117
3. Import Client’s Public Key to the Switch – Use the copy tftp public-key
command to copy a file containing the public key for all the SSH client’s
granted management access to the switch. (Note that these clients must be
configured locally on the switch with the username command.) The clients are
subsequently authenticated using these keys. The current firmware only
accepts public key files based on standard UNIX format as shown in the
following example for an RSA key:
1024 35
134108168560989392104094492015542534763164192187295892114317388005553616163105
177594083868631109291232226828519254374603100937187721199696317813662774141689
851320491172048303392543241016379975923714490119380060902539484084827178194372
288402533115952134861022902978982721353267131629432532818915045306393916643
steve@192.168.1.19
4. Set the Optional Parameters – Set other optional parameters, including the
authentication timeout and the number of retries.
5. Enable SSH Service – Use the ip ssh server command to enable the SSH server
on the switch.
Note: To use SSH with only password authentication, the host public key must still
be given to the client, either during initial connection or manually entered into the
known host file. However, you do not need to configure the client's keys.
Public Key Authentication – When an SSH client attempts to contact the switch,
the SSH server uses the host key pair to negotiate a session key and encryption
method. Only clients that have a private key corresponding to the public keys
stored on the switch can access it. The following exchanges take place during
this process:
– 253 –
Chapter 8 | Authentication Commands
Secure Shell
c. The client sends a signature generated using the private key to the
switch.
d. When the server receives this message, it checks whether the
supplied key is acceptable for authentication, and if so, it then checks
whether the signature is correct. If both checks succeed, the client is
authenticated.
Note: The SSH server supports up to eight client sessions. The maximum number
of client sessions includes both current Telnet sessions and SSH sessions.
Note: The SSH server can be accessed using any configured IPv4 or IPv6 interface
address on the switch.
ip ssh This command configures the number of times the SSH server attempts to
authentication-retries reauthenticate a user. Use the no form to restore the default setting.
Syntax
ip ssh authentication-retries count
no ip ssh authentication-retries
count – The number of authentication attempts permitted after which the
interface is reset. (Range: 1-5)
Default Setting
3
Command Mode
Global Configuration
Example
Console(config)#ip ssh authentication-retires 2
Console(config)#
Related Commands
show ip ssh (258)
ip ssh server This command enables the Secure Shell (SSH) server on this switch. Use the no
form to disable this service.
Syntax
[no] ip ssh server
– 254 –
Chapter 8 | Authentication Commands
Secure Shell
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ The SSH server supports up to eight client sessions. The maximum number of
client sessions includes both current Telnet sessions and SSH sessions.
◆ The SSH server uses RSA for key exchange when the client first establishes a
connection with the switch, and then negotiates with the client to select either
DES (56-bit) or 3DES (168-bit) for data encryption.
◆ You must generate RSA host keys before enabling the SSH server.
Example
Console#ip ssh crypto host-key generate
Console#configure
Console(config)#ip ssh server
Console(config)#
Related Commands
ip ssh crypto host-key generate (256)
show ssh (259)
ip ssh timeout This command configures the timeout for the SSH server. Use the no form to
restore the default setting.
Syntax
ip ssh timeout seconds
no ip ssh timeout
seconds – The timeout for client response during SSH negotiation.
(Range: 1-120)
Default Setting
120 seconds
Command Mode
Global Configuration
Command Usage
The timeout specifies the interval the switch will wait for a response from the client
during the SSH negotiation phase. Once an SSH session has been established, the
timeout for user input is controlled by the exec-timeout command for vty sessions.
– 255 –
Chapter 8 | Authentication Commands
Secure Shell
Example
Console(config)#ip ssh timeout 60
Console(config)#
Related Commands
exec-timeout (131)
show ip ssh (258)
delete public-key This command deletes the specified user’s public key.
Syntax
delete public-key username
username – Name of an SSH user. (Range: 1-8 characters)
Default Setting
Deletes the RSA key.
Command Mode
Privileged Exec
Example
Console#delete public-key admin
Console#
ip ssh crypto This command generates the host key pair (i.e., public and private).
host-key generate
Syntax
ip ssh crypto host-key generate
Default Setting
Generates the RSA key pairs.
Command Mode
Privileged Exec
Command Usage
◆ The switch uses RSA for SSHv2 clients.
◆ This command stores the host key pair in memory (i.e., RAM). Use the ip ssh
save host-key command to save the host key pair to flash memory.
– 256 –
Chapter 8 | Authentication Commands
Secure Shell
◆ Some SSH client programs automatically add the public key to the known hosts
file as part of the configuration process. Otherwise, you must manually create a
known hosts file and place the host public key in it.
◆ The SSH server uses this host key to negotiate a session key and encryption
method with the client trying to connect to it.
Example
Console#ip ssh crypto host-key generate
Console#
Related Commands
ip ssh crypto zeroize (257)
ip ssh save host-key (258)
ip ssh crypto zeroize This command clears the host key from memory (i.e. RAM).
Syntax
ip ssh crypto zeroize
Default Setting
Clears the RSA key.
Command Mode
Privileged Exec
Command Usage
◆ This command clears the host key from volatile memory (RAM). Use the no ip
ssh save host-key command to clear the host key from flash memory.
◆ The SSH server must be disabled before you can execute this command.
Example
Console#ip ssh crypto zeroize
Console#
Related Commands
ip ssh crypto host-key generate (256)
ip ssh save host-key (258)
no ip ssh server (254)
– 257 –
Chapter 8 | Authentication Commands
Secure Shell
ip ssh save host-key This command saves the host key from RAM to flash memory.
Syntax
ip ssh save host-key
Default Setting
Saves the RSA key.
Command Mode
Privileged Exec
Example
Console#ip ssh save host-key
Console#
Related Commands
ip ssh crypto host-key generate (256)
show ip ssh This command displays the connection settings used when authenticating client
access to the SSH server.
Command Mode
Privileged Exec
Example
Console#show ip ssh
SSH Enabled - Version 2.0
Negotiation Timeout : 120 seconds; Authentication Retries : 3
Console#
show public-key This command shows the public key for the specified user or for the host.
Syntax
show public-key [user [username]| host]
username – Name of an SSH user. (Range: 1-32 characters)
Default Setting
Shows all public keys.
Command Mode
Privileged Exec
– 258 –
Chapter 8 | Authentication Commands
Secure Shell
Command Usage
If no parameters are entered, all keys are displayed. If the user keyword is entered,
but no user name is specified, then the public keys for all users are displayed.
Example
Console#show public-key host
Host:
RSA:
-----BEGIN RSA PUBLIC KEY-----
MIIBCgKCAQEAspl/UuyjRJzxtmsLQUc28rtCzK0zxV4SACwLE4jPdJacX7yIMgyD
P+6wcj6QhZ5LYTByYLtgZ8OpvhgcTcLbOPp/LWEgII+ntzUiJGIqgXgggZtWWsTp
XC9WXgHzknKAvfI0zk2Ec/x4ryvSlWazEb0ygnozDPc8ZRV2iST+nzAKSCb3Oii3
SmpGk/NOzFK4OK3ouX1692PfB64QSDXyi1BcmR0nMU943xC/F8JPtLKxQLiZSnSa
Ef1dcbOIXHKd7dedw4MauUhzDznIawAEu6R4d2HSjxDM9pOIio8he860+S8gpBSN
9kSgNXU7o3BarVvYZo2hPaEOLAFBv+tklQIDAQAB
-----END RSA PUBLIC KEY-----
Console#
show ssh This command displays the current SSH server connections.
Command Mode
Privileged Exec
Example
Console#show ssh
Connection Version State Username Encryption
1 2.0 Session-Started admin ctos aes128-cbc-hmac-md5
stoc aes128-cbc-hmac-md5
Console#
Connection The session number. A total of eight SSH and Telnet sessions are allowed.
– 259 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
General Commands
dot1x eapol-pass-through Passes EAPOL frames to all ports in STP forwarding state GC
when dot1x is globally disabled
Authenticator Commands
dot1x max-reauth-req Sets the maximum number of times that the switch sends IC
an EAP-request/identity frame to the client before
restarting the authentication process
dot1x max-req Sets the maximum number of times that the switch IC
retransmits an EAP request/identity packet to the client
before it times out the authentication session
dot1x timeout quiet-period Sets the time that a switch port waits after the Max Request IC
Count has been exceeded before attempting to acquire a
new client
dot1x timeout re-authperiod Sets the time period after which a connected client must IC
be re-authenticated
dot1x timeout tx-period Sets the time period during an authentication session that IC
the switch waits before re-transmitting an EAP packet
– 260 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
General Commands
dot1x default This command sets all configurable dot1x authenticator global and port settings to
their default values.
Command Mode
Global Configuration
Command Usage
This command resets the following commands to their default settings:
◆ dot1x system-auth-control
◆ dot1x eapol-pass-through
◆ dot1x port-control
◆ dot1x port-control multi-host max-count
◆ dot1x operation-mode
◆ dot1x max-req
◆ dot1x timeout quiet-period
◆ dot1x timeout tx-period
◆ dot1x timeout re-authperiod
◆ dot1x timeout sup-timeout
◆ dot1x re-authentication
◆ dot1x intrusion-action
Example
Console(config)#dot1x default
Console(config)#
dot1x eapol-pass- This command passes EAPOL frames through to all ports in STP forwarding state
through when dot1x is globally disabled. Use the no form to restore the default.
Syntax
[no] dot1x eapol-pass-through
Default Setting
Discards all EAPOL frames when dot1x is globally disabled
Command Mode
Global Configuration
– 261 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
Command Usage
◆ When this device is functioning as intermediate node in the network and does
not need to perform dot1x authentication, the dot1x eapol pass-through
command can be used to forward EAPOL frames from other switches on to the
authentication servers, thereby allowing the authentication process to still be
carried out by switches located on the edge of the network.
◆ When this device is functioning as an edge switch but does not require any
attached clients to be authenticated, the no dot1x eapol-pass-through
command can be used to discard unnecessary EAPOL traffic.
Example
This example instructs the switch to pass all EAPOL frame through to any ports in
STP forwarding state.
Console(config)#dot1x eapol-pass-through
Console(config)#
dot1x system- This command enables IEEE 802.1X port authentication globally on the switch.
auth-control Use the no form to restore the default.
Syntax
[no] dot1x system-auth-control
Default Setting
Disabled
Command Mode
Global Configuration
Example
Console(config)#dot1x system-auth-control
Console(config)#
Authenticator Commands
dot1x intrusion-action This command sets the port’s response to a failed authentication, either to block all
traffic, or to assign all traffic for the port to a guest VLAN. Use the no form to reset
the default.
Syntax
dot1x intrusion-action {block-traffic | guest-vlan}
no dot1x intrusion-action
– 262 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
Default
block-traffic
Command Mode
Interface Configuration
Command Usage
◆ For guest VLAN assignment to be successful, the VLAN must be configured and
set as active (see the vlan database command) and assigned as the guest VLAN
for the port (see the network-access guest-vlan command).
◆ A port can only be assigned to the guest VLAN in case of failed authentication,
if switchport mode is set to Hybrid.
Example
Console(config)#interface eth 1/2
Console(config-if)#dot1x intrusion-action guest-vlan
Console(config-if)#
dot1x max-reauth-req This command sets the maximum number of times that the switch sends an EAP-
request/identity frame to the client before restarting the authentication process.
Use the no form to restore the default.
Syntax
dot1x max-reauth-req count
no dot1x max-reauth-req
count – The maximum number of requests (Range: 1-10)
Default
2
Command Mode
Interface Configuration
Example
Console(config)#interface eth 1/2
Console(config-if)#dot1x max-reauth-req 2
Console(config-if)#
– 263 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
dot1x max-req This command sets the maximum number of times the switch port will retransmit
an EAP request/identity packet to the client before it times out the authentication
session. Use the no form to restore the default.
Syntax
dot1x max-req count
no dot1x max-req
count – The maximum number of requests (Range: 1-10)
Default
2
Command Mode
Interface Configuration
Example
Console(config)#interface eth 1/2
Console(config-if)#dot1x max-req 2
Console(config-if)#
dot1x This command allows hosts (clients) to connect to an 802.1X-authorized port. Use
operation-mode the no form with no keywords to restore the default to single host. Use the no form
with the multi-host max-count keywords to restore the default maximum count.
Syntax
dot1x operation-mode {single-host | multi-host [max-count count] | mac-
based-auth}
no dot1x operation-mode [multi-host max-count]
single-host – Allows only a single host to connect to this port.
multi-host – Allows multiple host to connect to this port.
max-count – Keyword for the maximum number of hosts.
count – The maximum number of hosts that can connect to a port.
(Range: 1-1024; Default: 5)
mac-based – Allows multiple hosts to connect to this port, with each host
needing to be authenticated.
Default
Single-host
Command Mode
Interface Configuration
– 264 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
Command Usage
◆ The “max-count” parameter specified by this command is only effective if the
dot1x mode is set to “auto” by the dot1x port-control command.
Example
Console(config)#interface eth 1/2
Console(config-if)#dot1x operation-mode multi-host max-count 10
Console(config-if)#
dot1x port-control This command sets the dot1x mode on a port interface. Use the no form to restore
the default.
Syntax
dot1x port-control {auto | force-authorized | force-unauthorized}
no dot1x port-control
auto – Requires a dot1x-aware connected client to be authorized by the
RADIUS server. Clients that are not dot1x-aware will be denied access.
force-authorized – Configures the port to grant access to all clients, either
dot1x-aware or otherwise.
force-unauthorized – Configures the port to deny access to all clients,
either dot1x-aware or otherwise.
Default
force-authorized
Command Mode
Interface Configuration
Example
Console(config)#interface eth 1/2
Console(config-if)#dot1x port-control auto
Console(config-if)#
– 265 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
dot1x This command enables periodic re-authentication for a specified port. Use the no
re-authentication form to disable re-authentication.
Syntax
[no] dot1x re-authentication
Command Mode
Interface Configuration
Command Usage
◆ The re-authentication process verifies the connected client’s user ID and
password on the RADIUS server. During re-authentication, the client remains
connected the network and the process is handled transparently by the dot1x
client software. Only if re-authentication fails is the port blocked.
Example
Console(config)#interface eth 1/2
Console(config-if)#dot1x re-authentication
Console(config-if)#
Related Commands
dot1x timeout re-authperiod (267)
dot1x timeout This command sets the time that a switch port waits after the maximum request
quiet-period count (see page 264) has been exceeded before attempting to acquire a new client.
Use the no form to reset the default.
Syntax
dot1x timeout quiet-period seconds
no dot1x timeout quiet-period
seconds - The number of seconds. (Range: 1-65535)
Default
60 seconds
Command Mode
Interface Configuration
– 266 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
Example
Console(config)#interface eth 1/2
Console(config-if)#dot1x timeout quiet-period 350
Console(config-if)#
dot1x timeout This command sets the time period after which a connected client must be re-
re-authperiod authenticated. Use the no form of this command to reset the default.
Syntax
dot1x timeout re-authperiod seconds
no dot1x timeout re-authperiod
seconds - The number of seconds. (Range: 1-65535)
Default
3600 seconds
Command Mode
Interface Configuration
Example
Console(config)#interface eth 1/2
Console(config-if)#dot1x timeout re-authperiod 300
Console(config-if)#
dot1x timeout This command sets the time that an interface on the switch waits for a response to
supp-timeout an EAP request from a client before re-transmitting an EAP packet. Use the no form
to reset to the default value.
Syntax
dot1x timeout supp-timeout seconds
no dot1x timeout supp-timeout
seconds - The number of seconds. (Range: 1-65535)
Default
30 seconds
Command Mode
Interface Configuration
Command Usage
This command sets the timeout for EAP-request frames other than EAP-request/
identity frames. If dot1x authentication is enabled on a port, the switch will initiate
– 267 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
authentication when the port link state comes up. It will send an EAP-request/
identity frame to the client to request its identity, followed by one or more requests
for authentication information. It may also send other EAP-request frames to the
client during an active connection as required for reauthentication.
Example
Console(config)#interface eth 1/2
Console(config-if)#dot1x timeout supp-timeout 300
Console(config-if)#
dot1x timeout This command sets the time that an interface on the switch waits during an
tx-period authentication session before re-transmitting an EAP packet. Use the no form to
reset to the default value.
Syntax
dot1x timeout tx-period seconds
no dot1x timeout tx-period
seconds - The number of seconds. (Range: 1-65535)
Default
30 seconds
Command Mode
Interface Configuration
Example
Console(config)#interface eth 1/2
Console(config-if)#dot1x timeout tx-period 300
Console(config-if)#
dot1x re-authenticate This command forces re-authentication on all ports or a specific interface.
Syntax
dot1x re-authenticate [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
– 268 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
Command Usage
The re-authentication process verifies the connected client’s user ID and password
on the RADIUS server. During re-authentication, the client remains connected the
network and the process is handled transparently by the dot1x client software.
Only if re-authentication fails is the port blocked.
Example
Console#dot1x re-authenticate
Console#
show dot1x This command shows general port authentication related settings on the switch or
a specific interface.
Syntax
show dot1x [statistics] [interface interface]
statistics - Displays dot1x status for each port.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Command Usage
This command displays the following information:
◆ 802.1X Port Summary – Displays the port access control parameters for each
interface that has enabled 802.1X, including the following items:
■ Type – Administrative state for port access control (Enabled, Authenticator,
or Supplicant).
■ Operation Mode – Allows single or multiple hosts (page 264).
■ Control Mode – Dot1x port control mode (page 265).
■ Authorized – Authorization status (yes or n/a - not authorized).
◆ 802.1X Port Details – Displays the port access control parameters for each
interface, including the following items:
■ Reauthentication – Periodic re-authentication (page 266).
– 269 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
Example
Console#show dot1x
Global 802.1X Parameters
System Auth Control : Enabled
Authenticator Parameters:
EAPOL Pass Through : Disabled
– 270 –
Chapter 8 | Authentication Commands
802.1X Port Authentication
Supplicant : 00-e0-29-94-34-65
– 271 –
Chapter 8 | Authentication Commands
Management IP Filter
Management IP Filter
This section describes commands used to configure IP management access to the
switch.
management This command specifies the client IP addresses that are allowed management
access to the switch through various protocols. A list of up to 15 IP addresses or IP
address groups can be specified. Use the no form to restore the default setting.
Syntax
[no] management {all-client | http-client | snmp-client | telnet-client}
start-address [end-address]
all-client - Adds IP address(es) to all groups.
http-client - Adds IP address(es) to the web group.
snmp-client - Adds IP address(es) to the SNMP group.
telnet-client - Adds IP address(es) to the Telnet group.
start-address - A single IP address, or the starting address of a range.
end-address - The end address of a range.
Default Setting
All addresses
Command Mode
Global Configuration
Command Usage
◆ The management interfaces are open to all IP addresses by default. Once you
add an entry to a filter list, access to that interface is restricted to the specified
addresses.
– 272 –
Chapter 8 | Authentication Commands
Management IP Filter
◆ IP address can be configured for SNMP, web, and Telnet access respectively.
Each of these groups can include up to five different sets of addresses, either
individual addresses or address ranges.
◆ When entering addresses for the same group (i.e., SNMP, web, or Telnet), the
switch will not accept overlapping address ranges. When entering addresses
for different groups, the switch will accept overlapping address ranges.
◆ You cannot delete an individual address from a specified range. You must
delete the entire range, and re-enter the addresses.
◆ You can delete an address range just by specifying the start address, or by
specifying both the start address and end address.
Example
This example restricts management access to the indicated addresses.
show management This command displays the client IP addresses that are allowed management
access to the switch through various protocols.
Syntax
show management {all-client | http-client | snmp-client | telnet-client}
all-client - Displays IP addresses for all groups.
http-client - Displays IP addresses for the web group.
snmp-client - Displays IP addresses for the SNMP group.
telnet-client - Displays IP addresses for the Telnet group.
Command Mode
Privileged Exec
Example
Console#show management all-client
Management Ip Filter
HTTP-Client:
Start IP address End IP address
-----------------------------------------------
1. 192.168.1.19 192.168.1.19
2. 192.168.1.25 192.168.1.30
SNMP-Client:
Start IP address End IP address
-----------------------------------------------
1. 192.168.1.19 192.168.1.19
2. 192.168.1.25 192.168.1.30
– 273 –
Chapter 8 | Authentication Commands
PPPoE Intermediate Agent
TELNET-Client:
Start IP address End IP address
-----------------------------------------------
1. 192.168.1.19 192.168.1.19
2. 192.168.1.25 192.168.1.30
Console#
pppoe intermediate-agent Sets the access node identifier, generic error message, or GC
format-type vendor identifier for the switch
pppoe intermediate-agent Enables the stripping of vendor tags from PPPoE Discovery IC
vendor-tag strip packets sent from a PPPoE server
pppoe intermediate- This command enables the PPPoE Intermediate Agent globally on the switch. Use
agent the no form to disable this feature.
Syntax
[no] pppoe intermediate-agent
Default Setting
Disabled
– 274 –
Chapter 8 | Authentication Commands
PPPoE Intermediate Agent
Command Mode
Global Configuration
Command Usage
◆ The switch inserts a tag identifying itself as a PPPoE Intermediate Agent
residing between the attached client requesting network access and the ports
connected to broadband remote access servers (BRAS). The switch extracts
access-loop information from the client’s PPPoE Active Discovery Request, and
forwards this information to all trusted ports designated by the pppoe
intermediate-agent trust command. The BRAS detects the presence of the
subscriber’s circuit-ID tag inserted by the switch during the PPPoE discovery
phase, and sends this tag as a NAS-port-ID attribute in PPP authentication and
AAA accounting requests to a RADIUS server.
◆ PPPoE IA must be enabled globally by this command before this feature can be
enabled on an interface using the pppoe intermediate-agent port-enable
command.
Example
Console(config)#pppoe intermediate-agent
Console(config)#
pppoe intermediate- This command sets the access node identifier, generic error message, or vendor
agent format-type identifier for the switch. Use the no form to restore the default settings.
Syntax
pppoe intermediate-agent format-type {access-node-identifier node-id-
string | generic-error-message error-message | vendor-id vendor-id-string}
no pppoe intermediate-agent format-type {access-node-identifier |
generic-error-message}
node-id-string - String identifying this switch as an PPPoE IA to the PPPoE
server. (Range: 1-48 ASCII characters)
error-message - An error message notifying the sender that the PPPoE
Discovery packet was too large.
vendor-id-string - This tag is used to pass vendor proprietary information.
The first four octets of the tag contain the vendor id and the remainder is
unspecified. The high-order octet of the vendor id is 0 and the low-order 3
octets are the SMI Network Management Private Enterprise Code of the
Vendor in network byte order, as defined in the Assigned Numbers RFC
(RFC 1700). (Range: 0-4294967295)
– 275 –
Chapter 8 | Authentication Commands
PPPoE Intermediate Agent
Default Setting
◆ Access Node Identifier: IP address of the first IPv4 interface on the switch.
◆ Generic Error Message: PPPoE Discover packet too large to process. Try
reducing the number of tags added.
Command Mode
Global Configuration
Command Usage
◆ The switch uses the access-node-identifier to generate the circuit-id for PPPoE
discovery stage packets sent to the BRAS, but does not modify the source or
destination MAC address of these PPPoE discovery packets.
◆ These messages are forwarded to all trusted ports designated by the pppoe
intermediate-agent trust command.
Example
Console(config)#pppoe intermediate-agent format-type access-node-identifier
billibong
Console(config)#
pppoe intermediate- This command enables the PPPoE IA on an interface. Use the no form to disable this
agent port-enable feature.
Syntax
[no] pppoe intermediate-agent port-enable
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
PPPoE IA must also be enabled globally on the switch for this command to take
effect.
– 276 –
Chapter 8 | Authentication Commands
PPPoE Intermediate Agent
Example
Console(config)#interface ethernet 1/5
Console(config-if)#pppoe intermediate-agent port-enable
Console(config-if)#
pppoe intermediate- This command sets the circuit-id, remote-id, or remote-id delimiter for an interface.
agent port-format- Use the no form to restore the default settings.
type
Syntax
pppoe intermediate-agent port-format-type
{carry-to-client |
circuit-id [string | hostname-port-vlan] circuit-id-string |
remote-id {mac-cpe | string remote-id-string} |
remote-id-delimiter {enable | ascii-code}}
no pppoe intermediate-agent port-format-type {carry-to-client | circuit-id
| remote-id | remote-id-delimiter enable}
carry-to-client - Carries circuit ID/remote ID to the client.
circuit-id-string - String identifying the circuit identifier (or interface) on this
switch to which the user is connected. (Range: 1-10 ASCII characters)
circuit-id hostname-port-vlan - Specifies circuit ID format hostname/port/
vlan
mac-cpe - The MAC address of the CPE attached to this interface is used as
the remote ID.
remote-id-string - String identifying the remote identifier (or interface) on
this switch to which the user is connected. (Range: 1-63 ASCII characters)
remote-id-delimiter enable - Enables a user-specified delimiter value for
the remote ID.
ascii-code - A character used to separate components in the remote circuit
ID value. (Range: 0-255)
Default Setting
carry-to-client: No
circuit-id: unit/port:vlan-id or 0/trunk-id:vlan-id
remote-id: port MAC address
remote-id-delimiter: ASCII code 35, ASCII character "#"
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ The PPPoE server extracts the Line-ID tag from PPPoE discovery stage
messages, and uses the Circuit-ID field of that tag as a NAS-Port-ID attribute in
AAA access and accounting requests.
– 277 –
Chapter 8 | Authentication Commands
PPPoE Intermediate Agent
◆ The switch intercepts PPPoE discovery frames from the client and inserts a
unique line identifier using the PPPoE Vendor-Specific tag (0x0105) to PPPoE
Active Discovery Initiation (PADI) and Request (PADR) packets. The switch then
forwards these packets to the PPPoE server. The tag contains the Line-ID of the
customer line over which the discovery packet was received, entering the
switch (or access node) where the intermediate agent resides.
◆ Outgoing PAD Offer (PADO) and Session-confirmation (PADS) packets sent from
the PPPoE Server include the Circuit-Id tag inserted by the switch, and should
be stripped out of PADO and PADS packets which are to be passed directly to
end-node clients using the pppoe intermediate-agent vendor-tag strip
command.
◆ If the remote-id is unspecified, the port name will be used for this parameter. If
the port name is not configured, the remote-id is set to the port MAC (yy-yy-yy-
yy-yy-yy#), where # is the default delimiter.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#pppoe intermediate-agent port-format-type circuit-id
string ECS5520-18X
Console(config-if)#
pppoe This command sets the remote-id delimiter for an interface. Use the enable
intermediate-agent keyword to enable the delimiter. Use the no form with the enable keyword to
port-format-type disable the delimiter. Use the no form without any keywords toto restore the
remote-id-delimiter default settings.
Syntax
pppoe intermediate-agent port-format-type remote-id-delimiter
{enable | ascii-code}
ascii-code - ASCII character of delimiter. (Range: 0-255)
Default Setting
Disabled
ASCII code: 35 (“#”)
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
If the delimiter is enabled and it occurs in the remote ID string, the string will be
truncated at that point.
– 278 –
Chapter 8 | Authentication Commands
PPPoE Intermediate Agent
Example
This command enables the delimiter for port 5.
pppoe intermediate- This command sets an interface to trusted mode to indicate that it is connected to a
agent trust PPPoE server. Use the no form to set an interface to untrusted mode.
Syntax
[no] pppoe intermediate-agent trust
Default Setting
Untrusted
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ Set any interfaces connecting the switch to a PPPoE Server as trusted.
Interfaces that connect the switch to users (PPPoE clients) should be set as
untrusted.
◆ At least one trusted interface must be configured on the switch for the PPPoE
IA to function.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#pppoe intermediate-agent trust
Console(config-if)#
pppoe intermediate- This command enables the stripping of vendor tags from PPPoE Discovery packets
agent vendor-tag strip sent from a PPPoE server. Use the no form to disable this feature.
Syntax
[no] pppoe intermediate-agent vendor-tag strip
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
– 279 –
Chapter 8 | Authentication Commands
PPPoE Intermediate Agent
Command Usage
This command only applies to trusted interfaces. It is used to strip off vendor-
specific tags (which carry subscriber and line identification information) in PPPoE
Discovery packets received from an upstream PPPoE server before forwarding
them to a user.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#pppoe intermediate-agent vendor-tag strip
Console(config-if)#
clear pppoe This command clears statistical counters for the PPPoE Intermediate Agent.
intermediate-agent
statistics Syntax
clear pppoe intermediate-agent statistics interface [interface]
interface
ethernet unit/port
unit - Stack unit (Range: 1)
port - Port number (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#clear pppoe intermediate-agent statistics
Console#
show pppoe This command displays configuration settings for the PPPoE Intermediate Agent.
intermediate-agent
info Syntax
show pppoe intermediate-agent info [interface [interface]]
interface
ethernet unit/port
unit - Stack unit. (Range: 1)
port - Port number (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
– 280 –
Chapter 8 | Authentication Commands
PPPoE Intermediate Agent
Example
Console#show pppoe intermediate-agent info
PPPoE Intermediate Agent Global Status : Enabled
PPPoE Intermediate Agent Vendor ID : 3561
PPPoE Intermediate Agent Admin Access Node Identifier : 192.168.0.2
PPPoE Intermediate Agent Oper Access Node Identifier : 192.168.0.2
PPPoE Intermediate Agent Admin Generic Error Message :
PPPoE Discover packet too large to process. Try reducing the number of tags
added.
PPPoE Intermediate Agent Oper Generic Error Message :
PPPoE Discover packet too large to process. Try reducing the number of tags
added.
Console#show pppoe intermediate-agent info interface ethernet 1/1
Interface PPPoE IA Trusted Vendor-Tag Strip Admin Circuit-ID Admin Remote-ID
--------- -------- ------- ---------------- ---------------- ----------------
Eth 1/1 No No No
R-ID Delimiter Delimiter ASCII Oper Circuit-ID Oper Remote-ID
---------------- ---------------- ---------------- -----------------
No 35 1/1:vid CC-37-AB-BC-4F-FB
Carry Circuit and Remote ID to client: FALSE
Console#
show pppoe This command displays statistics for the PPPoE Intermediate Agent.
intermediate-agent
statistics Syntax
show pppoe intermediate-agent statistics interface [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show pppoe intermediate-agent statistics interface ethernet 1/1
Eth 1/1 statistics
-----------------------------------------------------------------------------
Received : All PADI PADO PADR PADS PADT
---------- ---------- ---------- ---------- ---------- ----------
3 0 0 0 0 3
– 281 –
Chapter 8 | Authentication Commands
PPPoE Intermediate Agent
Received
Dropped
Response from Response from an interface which not been configured as trusted.
untrusted
Request towards Request sent to an interface which not been configured as trusted.
untrusted
– 282 –
9 General Security Measures
This switch supports many methods of segregating traffic for clients attached to
each of the data ports, and for ensuring that only authorized clients gain access to
the network. Port-based authentication using IEEE 802.1X is commonly used for
these purposes. In addition to these methods, several other options of providing
client security are described in this chapter. These include port-based
authentication, which can be configured to allow network client access
by specifying a fixed set of MAC addresses. The addresses assigned to DHCP clients
can also be carefully controlled with IP Source Guard and DHCP Snooping
commands.
DHCPv4 Snooping* Filters untrusted DHCPv4 messages on unsecure ports by building and
maintaining a DHCPv4 snooping binding table
DHCPv6 Snooping* Filters untrusted DHCPv6 messages on unsecure ports by building and
maintaining a DHCPv6 snooping binding table
IPv4 Source Guard* Filters IP traffic on insecure ports for which the source address cannot
be identified via DHCP snooping nor static source bindings
IPv6 Source Guard* Filters IPv6 traffic on insecure ports for which the source address cannot
be identified via DHCPv6 snooping nor static source bindings
ND Snooping Maintains IPv6 prefix table and user address binding table which can be
used for stateless address auto-configuration or for address filtering by
IPv6 Source Guard
Port-based Traffic Configures traffic segmentation for different client sessions based on
Segmentation specified downlink and uplink ports
* The priority of execution for these filtering commands is Port Security, Port Authentication,
Network Access, Web Authentication, Access Control Lists, DHCP Snooping, and then IPv4
Source Guard.
– 283 –
Chapter 9 | General Security Measures
Port Security
Port Security
These commands can be used to enable port security on a port.
When MAC address learning is disabled on an interface, only incoming traffic with
source addresses already stored in the dynamic or static address table for this port
will be authorized to access the network.
When using port security, the switch stops learning new MAC addresses on the
specified port when it has reached a configured maximum number. Only incoming
traffic with source addresses already stored in the dynamic or static address table
for this port will be authorized to access the network. The port will drop any
incoming frames with a source MAC address that is unknown or has been
previously learned from another port. If a device with an unauthorized MAC
address attempts to use the switch port, the intrusion will be detected and the
switch can automatically take action by disabling the port and sending a trap
message.
port security mac-address Saves the MAC addresses learned by port security as IC
sticky “sticky” entries
port security mac-address- Saves the MAC addresses learned by port security as static PE
as-permanent entries.
show port security Displays port security status and secure address count PE
mac-learning This command enables MAC address learning on the selected interface. Use the no
form to disable MAC address learning.
Syntax
[no] mac-learning
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet or Port Channel)
– 284 –
Chapter 9 | General Security Measures
Port Security
Command Usage
◆ The no mac-learning command immediately stops the switch from learning
new MAC addresses on the specified port or trunk. Incoming traffic with source
addresses not stored in the static address table, will be flooded. However, if a
security function such as 802.1X or DHCP snooping is enabled and mac-
learning is disabled, then only incoming traffic with source addresses stored in
the static address table will be accepted, all other packets are dropped. Note
that the dynamic addresses stored in the address table when MAC address
learning is disabled are flushed from the system, and no dynamic addresses are
subsequently learned until MAC address learning has been re-enabled.
Example
The following example disables MAC address learning for port 2.
Related Commands
show interfaces status (412)
port security This command enables or configures port security. Use the no form without any
keywords to disable port security. Use the no form with the appropriate keyword to
restore the default settings for a response to security violation or for the maximum
number of allowed addresses.
Syntax
port security [action {shutdown | trap | trap-and-shutdown} |
max-mac-count address-count]
no port security [action | max-mac-count]
action - Response to take when port security is violated.
shutdown - Disable port only.
trap - Issue SNMP trap message only.
trap-and-shutdown - Issue SNMP trap message and disable port.
max-mac-count
address-count - The maximum number of MAC addresses that can be
learned on a port. (Range: 0 - 1024, where 0 means disabled)
– 285 –
Chapter 9 | General Security Measures
Port Security
Default Setting
Status: Disabled
Action: None
Maximum Addresses: 0
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ The default maximum number of MAC addresses allowed on a secure port is
zero (that is, port security is disabled). To use port security, you must configure
the maximum number of addresses allowed on a port using the port security
max-mac-count command.
◆ When port security is enabled using the port security command, or the
maximum number or allowed addresses is set to a value lower than the current
limit after port security has been enabled, the switch first clears all dynamically
learned entries from the address table. It then starts learning new MAC
addresses on the specified port, and stops learning addresses when it reaches a
configured maximum number. Only incoming traffic with source addresses
already stored in the dynamic or static address table will be accepted.
◆ MAC addresses that port security has learned, can be saved in the configuration
file as static entries. See command port security mac-address-as-permanent.
◆ If port security is enabled, and the maximum number of allowed addresses are
set to a non-zero value, any device not in the address table that attempts to use
the port will be prevented from accessing the switch.
– 286 –
Chapter 9 | General Security Measures
Port Security
Example
The following example enables port security for port 5, and sets the response to a
security violation to issue a trap message:
Related Commands
show interfaces status (412)
shutdown (403)
mac-address-table static (484)
port security Use this command to save the MAC addresses that port security has learned as
mac-address sticky “sticky” entries.
Syntax
port security mac-address sticky
Command Mode
Interface Configuration
Command Usage
◆ Sticky MAC addresses that port security has learned are dynamic addresses that
cannot be moved to another port.
◆ If sticky MAC addresses are received on another secure port, then the port
intrusion action is taken.
Example
Console(config-if)#port security mac-address sticky
Console#
port security Use this command to save the MAC addresses that port security has learned as
mac-address-as- static entries.
permanent
Syntax
port security mac-address-as-permanent [interface interface]
interface - Specifies a port interface.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
– 287 –
Chapter 9 | General Security Measures
Port Security
Command Mode
Privileged Exec
Example
This example shows the switch saving the MAC addresses learned by port security
on ethernet port 1/3.
show port security This command displays port security status and the secure address count.
Syntax
show port security [interface interface]
interface - Specifies a port interface.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Example
This example shows the port security settings and number of secure addresses for
all ports.
– 288 –
Chapter 9 | General Security Measures
Port Security
MaxMacCnt The maximum number of addresses which can be stored in the address table for
this interface (either dynamic or static).
The following example shows the port security settings and number of secure
addresses for a specific port. The Last Intrusion MAC and Last Time Detected
Intrusion MAC fields show information about the last detected intrusion MAC
address. These fields are not applicable if no intrusion has been detected or port
security is disabled. The MAC Filter ID field is configured by the network-access
mac-filter command. If this field displays Disabled, then any unknown source MAC
address can be learned as a secure MAC address. If it displays a filter identifier, then
only source MAC address entries in MAC Filter table can be learned as secure MAC
addresses.
– 289 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
mac-authentication reauth-time Sets the time period after which a connected MAC GC
address must be re-authenticated
network-access link-detection Configures the link detection feature to detect and act IC
link-down upon link-down events
network-access link-detection Configures the link detection feature to detect and act IC
link-up upon link-up events
network-access link-detection Configures the link detection feature to detect and act IC
link-up-down upon both link-up and link-down events
network-access max-mac-count Sets the maximum number of MAC addresses that can be IC
authenticated on a port via all forms of authentication
– 290 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
show network-access mac-filter Displays information for entries in the MAC filter tables PE
network-access aging Use this command to enable aging for authenticated MAC addresses stored in the
secure MAC address table. Use the no form of this command to disable address
aging.
Syntax
[no] network-access aging
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ Authenticated MAC addresses are stored as dynamic entries in the switch’s
secure MAC address table and are removed when the aging time expires. The
address aging time is determined by the mac-address-table aging-time
command.
◆ The maximum number of secure MAC addresses supported for the switch
system is 1024.
Example
Console(config)#network-access aging
Console(config)#
– 291 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
network-access Use this command to add a MAC address into a filter table. Use the no form of this
mac-filter command to remove the specified MAC address.
Syntax
network-access mac-filter filter-id
mac-address mac-address [mask mask-address]
no network-access mac-filter filter-id
mac-address mac-address mask mask-address
filter-id - Specifies a MAC address filter table. (Range: 1-64)
mac-address - Specifies a MAC address entry. (Format: xx-xx-xx-xx-xx-xx or
xxxxxxxxxxxx)
mask - Specifies a MAC address bit mask for a range of addresses.
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ Specified addresses are exempt from network access authentication.
◆ This command is different from configuring static addresses with the mac-
address-table static command in that it allows you configure a range of
addresses when using a mask, and then to assign these addresses to one or
more ports with the network-access port-mac-filter command.
◆ There is no limitation on the number of entries that can entered in a filter table.
Example
Console(config)#network-access mac-filter 1 mac-address 11-22-33-44-55-66
Console(config)#
– 292 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
mac-authentication Use this command to set the time period after which an authenticated MAC
reauth-time address is removed from the secure address table. Use the no form of this
command to restore the default value.
Syntax
mac-authentication reauth-time seconds
no mac-authentication reauth-time
seconds - The reauthentication time period. (Range: 120-1000000 seconds)
Default Setting
1800
Command Mode
Global Configuration
Command Usage
◆ The reauthentication time is a global setting and applies to all ports.
Example
Console(config)#mac-authentication reauth-time 300
Console(config)#
network-access Use this command to enable the dynamic QoS feature for an authenticated port.
dynamic-qos Use the no form to restore the default.
Syntax
[no] network-access dynamic-qos
Default Setting
Disabled
Command Mode
Interface Configuration
Command Usage
◆ The RADIUS server may optionally return dynamic QoS assignments to be
applied to a switch port for an authenticated user. The “Filter-ID” attribute
(attribute 11) can be configured on the RADIUS server to pass the following
QoS information:
– 293 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
◆ When the last user logs off of a port with a dynamic QoS assignment, the switch
restores the original QoS configuration for the port.
◆ When a user attempts to log into the network with a returned dynamic QoS
profile that is different from users already logged on to the same port, the user
is denied access.
◆ While a port has an assigned dynamic QoS profile, any manual QoS
configuration changes only take effect after all users have logged off of the
port.
Note: Any configuration changes for dynamic QoS are not saved to the switch
configuration file.
Example
The following example enables the dynamic QoS feature on port 1.
network-access Use this command to enable dynamic VLAN assignment for an authenticated port.
dynamic-vlan Use the no form to disable dynamic VLAN assignment.
Syntax
[no] network-access dynamic-vlan
Default Setting
Enabled
– 294 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
Command Mode
Interface Configuration
Command Usage
◆ When enabled, the VLAN identifiers returned by the RADIUS server through the
802.1X authentication process will be applied to the port, providing the VLANs
have already been created on the switch. GVRP is not used to create the VLANs.
◆ The VLAN settings specified by the first authenticated MAC address are
implemented for a port. Other authenticated MAC addresses on the port must
have same VLAN configuration, or they are treated as an authentication failure.
Example
The following example enables dynamic VLAN assignment on port 1.
network-access Use this command to assign all traffic on a port to a guest VLAN when 802.1x
guest-vlan authentication or MAC authentication is rejected. Use the no form of this command
to disable guest VLAN assignment.
Syntax
network-access guest-vlan vlan-id
no network-access guest-vlan
vlan-id - VLAN ID (Range: 1-4094)
Default Setting
Disabled
Command Mode
Interface Configuration
Command Usage
◆ The VLAN to be used as the guest VLAN must be defined and set as active (See
the vlan database command).
– 295 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
◆ When used with 802.1X authentication, the intrusion-action must be set for
“guest-vlan” to be effective (see the dot1x intrusion-action command).
◆ A port can only be assigned to the guest VLAN in case of failed authentication,
if switchport mode is set to Hybrid.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#network-access guest-vlan 25
Console(config-if)#
network-access Use this command to enable link detection for the selected port. Use the no form of
link-detection this command to restore the default.
Syntax
[no] network-access link-detection
Default Setting
Disabled
Command Mode
Interface Configuration
Example
Console(config)#interface ethernet 1/1
Console(config-if)#network-access link-detection
Console(config-if)#
network-access link- Use this command to detect link-down events. When detected, the switch can shut
detection link-down down the port, send an SNMP trap, or both. Use the no form of this command to
disable this feature.
Syntax
network-access link-detection link-down
action [shutdown | trap | trap-and-shutdown]
no network-access link-detection
action - Response to take when port security is violated.
shutdown - Disable port only.
trap - Issue SNMP trap message only.
trap-and-shutdown - Issue SNMP trap message and disable the port.
– 296 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
Default Setting
Disabled
Command Mode
Interface Configuration
Example
Console(config)#interface ethernet 1/1
Console(config-if)#network-access link-detection link-down action trap
Console(config-if)#
network-access link- Use this command to detect link-up events. When detected, the switch can shut
detection link-up down the port, send an SNMP trap, or both. Use the no form of this command to
disable this feature.
Syntax
network-access link-detection link-up
action [shutdown | trap | trap-and-shutdown]
no network-access link-detection
action - Response to take when port security is violated.
shutdown - Disable port only.
trap - Issue SNMP trap message only.
trap-and-shutdown - Issue SNMP trap message and disable the port.
Default Setting
Disabled
Command Mode
Interface Configuration
Example
Console(config)#interface ethernet 1/1
Console(config-if)#network-access link-detection link-up action trap
Console(config-if)#
– 297 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
network-access Use this command to detect link-up and link-down events. When either event is
link-detection detected, the switch can shut down the port, send an SNMP trap, or both. Use the
link-up-down no form of this command to disable this feature.
Syntax
network-access link-detection link-up-down
action [shutdown | trap | trap-and-shutdown]
no network-access link-detection
action - Response to take when port security is violated.
shutdown - Disable port only.
trap - Issue SNMP trap message only.
trap-and-shutdown - Issue SNMP trap message and disable the port.
Default Setting
Disabled
Command Mode
Interface Configuration
Example
Console(config)#interface ethernet 1/1
Console(config-if)#network-access link-detection link-up-down action trap
Console(config-if)#
network-access max- Use this command to set the maximum number of MAC addresses that can be
mac-count authenticated on a port interface via all forms of authentication. Use the no form of
this command to restore the default.
Syntax
network-access max-mac-count count
no network-access max-mac-count
count - The maximum number of authenticated IEEE 802.1X and MAC
addresses allowed. (Range: 1-2048)
Default Setting
1024
Command Mode
Interface Configuration
– 298 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
Command Usage
The maximum number of MAC addresses per port is 1024, and the maximum
number of secure MAC addresses supported for the switch system is 1024. When
the limit is reached, all new MAC addresses are treated as authentication failures.
Example
Console(config-if)#network-access max-mac-count 5
Console(config-if)#
network-access mode Use this command to enable network access authentication on a port. Use the no
mac-authentication form of this command to disable network access authentication.
Syntax
[no] network-access mode mac-authentication
Default Setting
Disabled
Command Mode
Interface Configuration
Command Usage
◆ When enabled on a port, the authentication process sends a Password
Authentication Protocol (PAP) request to a configured RADIUS server. The user
name and password are both equal to the MAC address being authenticated.
◆ On the RADIUS server, PAP user name and passwords must be configured in the
MAC address format XX-XX-XX-XX-XX-XX (all in upper case).
◆ Configured static MAC addresses are added to the secure address table when
seen on a switch port. Static addresses are treated as authenticated without
sending a request to a RADIUS server.
◆ When port status changes to down, all MAC addresses are cleared from the
secure MAC address table. Static VLAN assignments are not restored.
– 299 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
◆ The RADIUS server may optionally return a VLAN identifier list. VLAN identifier
list is carried in the “Tunnel-Private-Group-ID” attribute. The VLAN list can
contain multiple VLAN identifiers in the format “1u,2t,” where “u” indicates
untagged VLAN and “t” tagged VLAN. The “Tunnel-Type” attribute should be
set to “VLAN,” and the “Tunnel-Medium-Type” attribute set to “802.”
Example
Console(config-if)#network-access mode mac-authentication
Console(config-if)#
network-access port- Use this command to enable the specified MAC address filter. Use the no form of
mac-filter this command to disable the specified MAC address filter.
Syntax
network-access port-mac-filter filter-id
no network-access port-mac-filter
filter-id - Specifies a MAC address filter table. (Range: 1-64)
Default Setting
None
Command Mode
Interface Configuration
Command Mode
◆ Entries in the MAC address filter table can be configured with the network-
access mac-filter command.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#network-access port-mac-filter 1
Console(config-if)#
– 300 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
mac-authentication Use this command to configure the port response to a host MAC authentication
intrusion-action failure. Use the no form of this command to restore the default.
Syntax
mac-authentication intrusion-action {block-traffic | pass-traffic}
no mac-authentication intrusion-action
block-traffic - Blocks traffic when the authentication has failed.
pass-traffic - Allows network access when authentication has failed.
Default Setting
Block Traffic
Command Mode
Interface Configuration
Example
Console(config-if)#mac-authentication intrusion-action block-traffic
Console(config-if)#
mac-authentication Use this command to set the maximum number of MAC addresses that can be
max-mac-count authenticated on a port via MAC authentication. Use the no form of this command
to restore the default.
Syntax
mac-authentication max-mac-count count
no mac-authentication max-mac-count
count - The maximum number of MAC-authenticated MAC addresses
allowed. (Range: 1-1024)
Default Setting
1024
Command Mode
Interface Configuration
Example
Console(config-if)#mac-authentication max-mac-count 32
Console(config-if)#
– 301 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
clear network-access Use this command to clear entries from the secure MAC addresses table.
Syntax
clear network-access mac-address-table [static | dynamic]
[address mac-address] [interface interface]
static - Specifies static address entries.
dynamic - Specifies dynamic address entries.
mac-address - Specifies a MAC address entry. (Format: xx-xx-xx-xx-xx-xx)
interface - Specifies a port interface.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
Example
Console#clear network-access mac-address-table interface ethernet 1/1
Console#
show network-access Use this command to display the MAC authentication settings for port interfaces.
Syntax
show network-access [interface interface]
interface - Specifies a port interface.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Default Setting
Displays the settings for all interfaces.
Command Mode
Privileged Exec
– 302 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
Example
Console#show network-access interface ethernet 1/1
Global secure port information
Reauthentication Time : 1800
MAC Address Aging : Disabled
Port : 1/1
MAC Authentication : Disabled
MAC Authentication Intrusion Action : Block traffic
MAC Authentication Maximum MAC Counts : 1024
Maximum MAC Counts : 1024
Dynamic VLAN Assignment : Enabled
Dynamic QoS Assignment : Disabled
MAC Filter ID : Disabled
Guest VLAN : Disabled
Link Detection : Disabled
Detection Mode : Link-down
Detection Action : Trap
Console#
show network-access Use this command to display secure MAC address table entries.
mac-address-table
Syntax
show network-access mac-address-table [static | dynamic]
[address mac-address [mask]] [interface interface] [sort {address |
interface}]
static - Specifies static address entries.
dynamic - Specifies dynamic address entries.
mac-address - Specifies a MAC address entry.
(Format: xx-xx-xx-xx-xx-xx or xxxxxxxxxxxx)
mask - Specifies a MAC address bit mask for filtering displayed addresses.
interface - Specifies a port interface.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
sort - Sorts displayed entries by either MAC address or interface.
Default Setting
Displays all filters.
Command Mode
Privileged Exec
Command Usage
When using a bit mask to filter displayed MAC addresses, a 1 means “care” and a 0
means “don't care”. For example, a MAC of 00-00-01-02-03-04 and mask FF-FF-FF-
– 303 –
Chapter 9 | General Security Measures
Network Access (MAC Address Authentication)
Example
Console#show network-access mac-address-table
Interface MAC Address RADIUS Server Time Attribute
--------- ----------------- --------------- ------------------------- ---------
1/1 00-00-01-02-03-04 172.155.120.17 00d06h32m50s Static
1/1 00-00-01-02-03-05 172.155.120.17 00d06h33m20s Dynamic
1/1 00-00-01-02-03-06 172.155.120.17 00d06h35m10s Static
1/3 00-00-01-02-03-07 172.155.120.17 00d06h34m20s Dynamic
Console#
show network-access Use this command to display information for entries in the MAC filter tables.
mac-filter
Syntax
show network-access mac-filter [filter-id]
filter-id - Specifies a MAC address filter table. (Range: 1-64)
Default Setting
Displays all filters.
Command Mode
Privileged Exec
Example
Console#show network-access mac-filter
Filter ID MAC Address MAC Mask
--------- ----------------- -----------------
1 00-00-01-02-03-08 FF-FF-FF-FF-FF-FF
Console#
– 304 –
Chapter 9 | General Security Measures
Web Authentication
Web Authentication
Web authentication allows stations to authenticate and access the network in
situations where 802.1X or Network Access authentication are infeasible or
impractical. The web authentication feature allows unauthenticated hosts to
request and receive a DHCP assigned IP address and perform DNS queries. All other
traffic, except for HTTP protocol traffic, is blocked. The switch intercepts HTTP
protocol traffic and redirects it to a switch-generated web page that facilitates user
name and password authentication via RADIUS. Once authentication is successful,
the web browser is forwarded on to the originally requested web page. Successful
authentication is valid for all hosts connected to the port.
Note: RADIUS authentication must be activated and configured for the web
authentication feature to work properly (see “Authentication Sequence” on
page 222).
Note: Web authentication cannot be configured on trunk ports.
web-auth login-attempts Defines the limit for failed web authentication login GC
attempts
web-auth quiet-period Defines the amount of time to wait after the limit for GC
failed login attempts is exceeded.
web-auth re-authenticate (Port) Ends all web authentication sessions on the port and PE
forces the users to re-authenticate
web-auth re-authenticate (IP) Ends the web authentication session associated with the PE
designated IP address and forces the user to re-
authenticate
– 305 –
Chapter 9 | General Security Measures
Web Authentication
web-auth This command defines the limit for failed web authentication login attempts. After
login-attempts the limit is reached, the switch refuses further login attempts until the quiet time
expires. Use the no form to restore the default.
Syntax
web-auth login-attempts count
no web-auth login-attempts
count - The limit of allowed failed login attempts. (Range: 1-3)
Default Setting
3 login attempts
Command Mode
Global Configuration
Example
Console(config)#web-auth login-attempts 2
Console(config)#
web-auth This command defines the amount of time a host must wait after exceeding the
quiet-period limit for failed login attempts, before it may attempt web authentication again. Use
the no form to restore the default.
Syntax
web-auth quiet-period time
no web-auth quiet period
time - The amount of time the host must wait before attempting
authentication again. (Range: 1-180 seconds)
Default Setting
60 seconds
Command Mode
Global Configuration
Example
Console(config)#web-auth quiet-period 120
Console(config)#
– 306 –
Chapter 9 | General Security Measures
Web Authentication
web-auth This command defines the amount of time a web-authentication session remains
session-timeout valid. When the session timeout has been reached, the host is logged off and must
re-authenticate itself the next time data transmission takes place. Use the no form
to restore the default.
Syntax
web-auth session-timeout timeout
no web-auth session timeout
timeout - The amount of time that an authenticated session remains valid.
(Range: 300-3600 seconds)
Default Setting
3600 seconds
Command Mode
Global Configuration
Example
Console(config)#web-auth session-timeout 1800
Console(config)#
web-auth system- This command globally enables web authentication for the switch. Use the no form
auth-control to restore the default.
Syntax
[no] web-auth system-auth-control
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
Both web-auth system-auth-control for the switch and web-auth for an interface
must be enabled for the web authentication feature to be active.
Example
Console(config)#web-auth system-auth-control
Console(config)#
– 307 –
Chapter 9 | General Security Measures
Web Authentication
web-auth This command enables web authentication for an interface. Use the no form to
restore the default.
Syntax
[no] web-auth
Default Setting
Disabled
Command Mode
Interface Configuration
Command Usage
Both web-auth system-auth-control for the switch and web-auth for a port must
be enabled for the web authentication feature to be active.
Example
Console(config-if)#web-auth
Console(config-if)#
web-auth re- This command ends all web authentication sessions connected to the port and
authenticate (Port) forces the users to re-authenticate.
Syntax
web-auth re-authenticate interface interface
interface - Specifies a port interface.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
Example
Console#web-auth re-authenticate interface ethernet 1/2
Console#
– 308 –
Chapter 9 | General Security Measures
Web Authentication
web-auth re- This command ends the web authentication session associated with the
authenticate (IP) designated IP address and forces the user to re-authenticate.
Syntax
web-auth re-authenticate interface interface ip
interface - Specifies a port interface.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
ip - IPv4 formatted IP address
Default Setting
None
Command Mode
Privileged Exec
Example
Console#web-auth re-authenticate interface ethernet 1/2 192.168.1.5
Console#
Command Mode
Privileged Exec
Example
Console#show web-auth
Global Web-Auth Parameters
System Auth Control : Enabled
Session Timeout : 3600
Quiet Period : 60
Max Login Attempts : 3
Console#
– 309 –
Chapter 9 | General Security Measures
Web Authentication
show web-auth This command displays interface-specific web authentication parameters and
interface statistics.
Syntax
show web-auth interface interface
interface - Specifies a port interface.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show web-auth interface ethernet 1/2
Web Auth Status : Enabled
Host Summary
show web-auth This command displays a summary of web authentication port parameters and
summary statistics.
Command Mode
Privileged Exec
Example
Console#show web-auth summary
Global Web-Auth Parameters
System Auth Control : Enabled
Port Status Authenticated Host Count
---- ------ ------------------------
1/ 1 Disabled 0
1/ 2 Enabled 8
1/ 3 Disabled 0
1/ 4 Disabled 0
1/ 5 Disabled 0
.
.
.
– 310 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
DHCPv4 Snooping
DHCPv4 snooping allows a switch to protect a network from rogue DHCPv4 servers
or other devices which send port-related information to a DHCPv4 server. This
information can be useful in tracking an IP address back to a physical port. This
section describes commands used to configure DHCPv4 snooping.
ip dhcp snooping information Disables use of sub-type and sub-length for the GC
option encode no-subtype CID/RID in Option 82 information
ip dhcp snooping information Sets the remote ID to the switch’s IP address, MAC GC
option remote-id address, arbitrary string, TR-101 compliant node
identifier, or removes VLAN ID from the end of the TR101
field
ip dhcp snooping information Sets the board identifier used in Option 82 information GC
option tr101 board-id based on TR-101 syntax
ip dhcp snooping information Sets the information option policy for DHCP client GC
policy packets that include Option 82 information
ip dhcp snooping verify Verifies the client’s hardware address stored in the DHCP GC
mac-address packet against the source MAC address in the Ethernet
header
ip dhcp snooping max- configures the maximum number of DHCP clients which IC
number can be supported per interface
clear ip dhcp snooping Clears DHCP snooping binding table entries from RAM PE
binding
clear ip dhcp snooping Removes all dynamically learned snooping entries from PE
database flash flash memory.
ip dhcp snooping database Writes all dynamically learned snooping entries to flash PE
flash memory
show ip dhcp snooping Shows the DHCP snooping binding table entries PE
binding
– 311 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
ip dhcp snooping This command enables DHCP snooping globally. Use the no form to restore the
default setting.
Syntax
[no] ip dhcp snooping
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ Network traffic may be disrupted when malicious DHCP messages are received
from an outside source. DHCP snooping is used to filter DHCP messages
received on an unsecure interface from outside the network or fire wall. When
DHCP snooping is enabled globally by this command, and enabled on a VLAN
interface by the ip dhcp snooping vlan command, DHCP messages received on
an untrusted interface (as specified by the no ip dhcp snooping trust
command) from a device not listed in the DHCP snooping table will be
dropped.
◆ Table entries are only learned for trusted interfaces. Each entry includes a MAC
address, IP address, lease time, VLAN identifier, and port identifier.
◆ When DHCP snooping is enabled, the rate limit for the number of DHCP
messages that can be processed by the switch is 100 packets per second. Any
DHCP packets in excess of this limit are dropped.
■ If DHCP snooping is enabled globally, and also enabled on the VLAN where
the DHCP packet is received, all DHCP packets are forwarded for a trusted
port. If the received packet is a DHCP ACK message, a dynamic DHCP
snooping entry is also added to the binding table.
■ If DHCP snooping is enabled globally, and also enabled on the VLAN where
the DHCP packet is received, but the port is not trusted, it is processed as
follows:
– 312 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
■ If a DHCP packet from a client passes the filtering criteria above, it will only
be forwarded to trusted ports in the same VLAN.
◆ If DHCP snooping is globally disabled, all dynamic bindings are removed from
the binding table.
◆ Additional considerations when the switch itself is a DHCP client – The port(s)
through which the switch submits a client request to the DHCP server must be
configured as trusted (using the ip dhcp snooping trust command). Note that
the switch will not add a dynamic entry for itself to the binding table when it
receives an ACK message from a DHCP server. Also, when the switch sends out
DHCP client packets for itself, no filtering takes place. However, when the
switch receives any messages from a DHCP server, any packets received from
untrusted ports are dropped.
Example
This example enables DHCP snooping globally for the switch.
Related Commands
ip dhcp snooping vlan (320)
ip dhcp snooping trust (323)
– 313 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
ip dhcp snooping This command enables the use of DHCP Option 82 information for the switch, and
information option specifies the frame format to use for the remote-id when Option 82 information is
generated by the switch. Use the no form without any keywords to disable this
function.
Syntax
ip dhcp snooping information option
no ip dhcp snooping information option
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ DHCP provides a relay mechanism for sending information about the switch
and its DHCP clients to the DHCP server. Known as DHCP Option 82, it allows
compatible DHCP servers to use the information when assigning IP addresses,
or to set other services or policies for clients.
– 314 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
ip dhcp snooping This command disables the use of sub-type and sub-length fields for the
information option circuit-ID (CID) and remote-ID (RID) in Option 82 information generated by the
encode no-subtype switch. Use the no form to enable the use of these fields.
Syntax
[no] ip dhcp snooping information option encode no-subtype
Default Setting
CID/RID sub-type: Enabled
Command Mode
Global Configuration
Command Usage
◆ Option 82 information generated by the switch is based on TR-101 syntax as
shown below:
The circuit identifier used by this switch starts at sub-option1 and goes to the
end of the R-124 string. The R-124 string includes the following information:
■ sub-type - Distinguishes different types of circuit IDs.
■ sub-length - Length of the circuit ID type
■ access node identifier - ASCII string. Default is the MAC address of the
switch’s CPU. This field is set by the ip dhcp snooping information option
command,
■ eth - The second field is the fixed string “eth”
■ slot - The slot represents the stack unit for this system.
■ port - The port which received the DHCP request. If the packet arrives over
a trunk, the value is the ifIndex of the trunk.
■ vlan - Tag of the VLAN which received the DHCP request.
Note that the sub-type and sub-length fields can be enabled or disabled
using the ip dhcp snooping information option command.
– 315 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
◆ The format for TR101 option 82 is: “<IP> eth <SID>/<PORT>[:<VLAN>]”. Note
that the SID (Switch ID) is always 0. By default the PVID is added to the end of
the TR101 field for untagged packets. For tagged packets, the VLAN ID is always
added.
Example
This example enables the use of sub-type and sub-length fields for the
circuit-ID (CID) and remote-ID (RID).
ip dhcp snooping This command sets the remote ID to the switch’s IP address, MAC address, arbitrary
information option string, TR-101 compliant node identifier, or removes VLAN ID from the end of the
remote-id TR101 field. Use the no form to restore the default setting.
Syntax
ip dhcp snooping information option remote-id
{ip-address [encode {ascii | hex}] |
mac-address [encode {ascii | hex}] | string string [sub-option port-
description [delimiter delimiter]] |
tr101 {node-identifier {ip | sysname} | no-vlan-field }}
no ip dhcp snooping information option remote-id
[ip-address encode] | [mac-address encode] | [string sub-option port-
description delimiter] | [tr101 no-vlan-field]
– 316 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
Default Setting
MAC address: hexadecimal
tr101 no-vlan-field: disabled
Command Mode
Global Configuration
Command Usage
The format for TR101 option 82 is: “<IP> eth <SID>/<PORT>[:<VLAN>]”. Note that
the SID (Switch ID) is always 0. By default the PVID is added to the end of the TR101
field for untagged packets. For tagged packets, the VLAN ID is always added. Use
the ip dhcp snooping information option remote-id tr101 no-vlan-field
command to remove the VLAN ID from the end of the TR101 field for untagged
packets. Use the no form of this command to add the PVID for untagged packets at
the end of the TR101 field.
Example
This example sets the remote ID to the switch’s IP address.
– 317 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
ip dhcp snooping This command sets the board identifier used in Option 82 information based on
information option TR-101 syntax. Use the no form to remove the board identifier.
tr101 board-id
Syntax
ip dhcp snooping information option tr101 board-id board-id
no ip dhcp snooping information option tr101 board-id
board-id – TR101 Board ID. (Range: 0-9)
Default Setting
not defined
Command Mode
Global Configuration
Example
This example sets the board ID to 0.
ip dhcp snooping This command sets the DHCP snooping information option policy for DHCP client
information policy packets that include Option 82 information. Use the no form to restore the default
setting.
Syntax
ip dhcp snooping information policy {drop | keep | replace}
no ip dhcp snooping information policy
drop - Drops the client’s request packet instead of relaying it.
keep - Retains the Option 82 information in the client request, and
forwards the packets to trusted ports.
replace - Replaces the Option 82 information circuit-id and remote-id fields
in the client’s request with information about the relay agent itself, inserts
the relay agent’s address (when DHCP snooping is enabled), and forwards
the packets to trusted ports.
Default Setting
replace
Command Mode
Global Configuration
– 318 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
Command Usage
When the switch receives DHCP packets from clients that already include DHCP
Option 82 information, the switch can be configured to set the action policy for
these packets. The switch can either drop the DHCP packets, keep the existing
information, or replace it with the switch’s relay information.
Example
Console(config)#ip dhcp snooping information policy drop
Console(config)#
ip dhcp snooping This command verifies the client’s hardware address stored in the DHCP packet
verify mac-address against the source MAC address in the Ethernet header. Use the no form to disable
this function.
Syntax
[no] ip dhcp snooping verify mac-address
Default Setting
Enabled
Command Mode
Global Configuration
Command Usage
If MAC address verification is enabled, and the source MAC address in the Ethernet
header of the packet is not same as the client’s hardware address in the DHCP
packet, the packet is dropped.
Example
This example enables MAC address verification.
Related Commands
ip dhcp snooping (312)
ip dhcp snooping vlan (320)
ip dhcp snooping trust (323)
– 319 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
ip dhcp snooping vlan This command enables DHCP snooping on the specified VLAN. Use the no form to
restore the default setting.
Syntax
[no] ip dhcp snooping vlan vlan-id
vlan-id - ID of a configured VLAN (Range: 1-4094)
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ When DHCP snooping is enabled globally using the ip dhcp snooping
command, and enabled on a VLAN with this command, DHCP packet filtering
will be performed on any untrusted ports within the VLAN as specified by the ip
dhcp snooping trust command.
◆ When the DHCP snooping is globally disabled, DHCP snooping can still be
configured for specific VLANs, but the changes will not take effect until DHCP
snooping is globally re-enabled.
◆ When DHCP snooping is globally enabled, and then disabled on a VLAN, all
dynamic bindings learned for this VLAN are removed from the binding table.
Example
This example enables DHCP snooping for VLAN 1.
Related Commands
ip dhcp snooping (312)
ip dhcp snooping trust (323)
– 320 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
ip dhcp snooping This command specifies DHCP Option 82 circuit-id suboption information. Use the
information option no form to use the default settings.
circuit-id
Syntax
ip dhcp snooping information option circuit-id string string |
{tr101 {node-identifier {ip | sysname} | no-vlan-field}
no dhcp snooping information option circuit-id [tr101 no-vlan-field]
string - An arbitrary string inserted into the circuit identifier field.
(Range: 1-32 characters)
tr101 node-identifier - The remote ID generated by the switch is based on
TR-101 syntax (R-124, Access_Node_ID).
ip - Specifies the switch’s IP address as the node identifier.
sysname - Specifies the system name as the node identifier.
tr101 no-vlan-field - Do not add “:VLAN” in TR101 field for untagged
packets.
Default Setting
VLAN-Unit-Port
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ DHCP provides a relay mechanism for sending information about the switch
and its DHCP clients to the DHCP server. DHCP Option 82 allows compatible
DHCP servers to use the information when assigning IP addresses, to set other
services or policies for clients. For more information of this process, refer to the
Command Usage section under the ip dhcp snooping information option
command.
The circuit identifier used by this switch starts at sub-option1 and goes to the
end of the R-124 string. The R-124 string includes the following information:
■ sub-type - Distinguishes different types of circuit IDs.
■ sub-length - Length of the circuit ID type
– 321 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
■ access node identifier - ASCII string. Default is the MAC address of the
switch’s CPU. This field is set by the ip dhcp snooping information option
command,
■ eth - The second field is the fixed string “eth”
■ slot - The slot represents the stack unit for this system.
■ port - The port which received the DHCP request. If the packet arrives over
a trunk, the value is the ifIndex of the trunk.
■ vlan - Tag of the VLAN which received the DHCP request.
Note that the sub-type and sub-length fields can be enabled or disabled
using the ip dhcp snooping information option command.
■ The ip dhcp snooping information option circuit-id command can be
used to modify the default settings described above.
◆ The format for TR101 option 82 is: “<IP> eth <SID>/<PORT>[:<VLAN>]”. Note
that the SID (Switch ID) is always 0. By default the PVID is added to the end of
the TR101 field for untagged packets. For tagged packets, the VLAN ID is always
added. Use the ip dhcp snooping information option remote-id tr101 no-
vlan-field command to remove the VLAN ID from the end of the TR101 field for
untagged packets. Use the no form of this command to add the PVID for
untagged packets at the end of the TR101 field.
Example
This example sets the DHCP Snooping Information circuit-id suboption string.
ip dhcp snooping This command configures the maximum number of DHCP clients which can be
max-number supported per interface. Use the no form to restore the default setting.
Syntax
ip dhcp snooping max-number max-number
no dhcp snooping max-number
max-number - Maximum number of DHCP clients. (Range: 1-16)
Default Setting
16
Command Mode
Interface Configuration (Ethernet, Port Channel)
– 322 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
Example
This example sets the maximum number of DHCP clients supported on port 1 to 2.
ip dhcp snooping trust This command configures the specified interface as trusted. Use the no form to
restore the default setting.
Syntax
[no] ip dhcp snooping trust
Default Setting
All interfaces are untrusted
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ A trusted interface is an interface that is configured to receive only messages
from within the network. An untrusted interface is an interface that is
configured to receive messages from outside the network or fire wall.
◆ Set all ports connected to DHCP servers within the local network or fire wall to
trusted, and all other ports outside the local network or fire wall to untrusted.
◆ When an untrusted port is changed to a trusted port, all the dynamic DHCP
snooping bindings associated with this port are removed.
◆ Additional considerations when the switch itself is a DHCP client – The port(s)
through which it submits a client request to the DHCP server must be
configured as trusted.
Example
This example sets port 5 to untrusted.
– 323 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
Related Commands
ip dhcp snooping (312)
ip dhcp snooping vlan (320)
clear ip dhcp This command clears DHCP snooping binding table entries from RAM. Use this
snooping binding command without any optional keywords to clear all entries from the binding
table.
Syntax
clear ip dhcp snooping binding [mac-address vlan vlan-id]
mac-address - Specifies a MAC address entry. (Format: xx-xx-xx-xx-xx-xx or
xxxxxxxxxxxx)
vlan-id - ID of a configured VLAN (Range: 1-4094)
Command Mode
Privileged Exec
Example
Console#clear ip dhcp snooping binding 11-22-33-44-55-66 192.168.1.234
Console#
clear ip dhcp This command removes all dynamically learned snooping entries from flash
snooping database memory.
flash
Command Mode
Privileged Exec
Example
Console#clear ip dhcp snooping database flash
Console#
ip dhcp snooping This command writes all dynamically learned snooping entries to flash memory.
database flash
Command Mode
Privileged Exec
Command Usage
This command can be used to store the currently learned dynamic DHCP snooping
entries to flash memory. These entries will be restored to the snooping table when
the switch is reset. However, note that the lease time shown for a dynamic entry
that has been restored from flash memory will no longer be valid.
– 324 –
Chapter 9 | General Security Measures
DHCPv4 Snooping
Example
Console#ip dhcp snooping database flash
Console#
show ip dhcp This command shows the DHCP snooping configuration settings.
snooping
Command Mode
Privileged Exec
Example
Console#show ip dhcp snooping
Global DHCP Snooping Status: disabled
DHCP Snooping Information Option Status: disabled
DHCP Snooping Information Option Sub-option Format: extra subtype included
DHCP Snooping Information Option Remote ID: MAC Address (hex encoded)
DHCP Snooping Information Option Remote ID TR101 VLAN Field: enabled
DHCP Snooping Information Option TR101 Board ID: none
DHCP Snooping Information Policy: replace
DHCP Snooping is configured on the following VLANs:
show ip dhcp This command shows the DHCP snooping binding table entries.
snooping binding
Command Mode
Privileged Exec
Example
Console#show ip dhcp snooping binding
MAC Address IP Address Lease(sec) Type VLAN Interface
----------------- --------------- ---------- -------------------- ---- ------
11-22-33-44-55-66 192.168.0.99 0 Dynamic-DHCPSNP 1 Eth 1/5
Console#
– 325 –
Chapter 9 | General Security Measures
DHCPv6 Snooping
DHCPv6 Snooping
DHCPv6 snooping allows a switch to protect a network from rogue DHCPv6 servers
or other devices which send port-related information to a DHCPv6 server. This
information can be useful in tracking an IP address back to a physical port. This
section describes commands used to configure DHCPv6 snooping.
ipv6 dhcp snooping option Enables insertion of DHCPv6 Option 37 relay agent GC
remote-id remote-id
ipv6 dhcp snooping option Sets the information option policy for DHCPv6 client GC
remote-id policy packets that include Option 37 information
ipv6 dhcp snooping vlan Enables DHCPv6 snooping on the specified VLAN GC
ipv6 dhcp snooping Sets the maximum number of entries which can be IC
max-binding stored in the binding database for an interface
clear ipv6 dhcp snooping Clears DHCPv6 snooping binding table entries from RAM PE
binding
clear ipv6 dhcp snooping Clears statistical counters for DHCPv6 snooping client, PE
statistics server and relay packets
show ipv6 dhcp snooping Shows the DHCPv6 snooping configuration settings PE
show ipv6 dhcp snooping Shows the DHCPv6 snooping binding table entries PE
binding
show ipv6 dhcp snooping Shows statistics for DHCPv6 snooping client, server and PE
statistics relay packets
ipv6 dhcp snooping This command enables DHCPv6 snooping globally. Use the no form to restore the
default setting.
Syntax
[no] ipv6 dhcp snooping
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ Network traffic may be disrupted when malicious DHCPv6 messages are
received from an outside source. DHCPv6 snooping is used to filter DHCPv6
messages received on an unsecure interface from outside the network or fire
– 326 –
Chapter 9 | General Security Measures
DHCPv6 Snooping
◆ Table entries are only learned for trusted interfaces. Each entry includes a MAC
address, IPv6 address, lease time, binding type, VLAN identifier, and port
identifier.
◆ When DHCPv6 snooping is enabled, the rate limit for the number of DHCPv6
messages that can be processed by the switch is 100 packets per second. Any
DHCPv6 packets in excess of this limit are dropped.
■ Solicit: Add new entry in binding cache, recording client’s DUID, IA type,
IA ID (2 message exchanges to get IPv6 address with rapid commit
option, otherwise 4 message exchanges), and forward to trusted port.
If a DHCPv6 packet from a client passes the filtering criteria above, it will
only be forwarded to trusted ports in the same VLAN.
– 327 –
Chapter 9 | General Security Measures
DHCPv6 Snooping
■ If not, continue to B.
◆ Additional considerations when the switch itself is a DHCPv6 client – The port(s)
through which the switch submits a client request to the DHCPv6 server must
be configured as trusted (using the ipv6 dhcp snooping trust command). Note
that the switch will not add a dynamic entry for itself to the binding table when
it receives an ACK message from a DHCPv6 server. Also, when the switch sends
out DHCPv6 client packets for itself, no filtering takes place. However, when the
switch receives any messages from a DHCPv6 server, any packets received from
untrusted ports are dropped.
– 328 –
Chapter 9 | General Security Measures
DHCPv6 Snooping
Example
This example enables DHCPv6 snooping globally for the switch.
Related Commands
ipv6 dhcp snooping vlan (331)
ipv6 dhcp snooping trust (332)
ipv6 dhcp snooping This command enables the insertion of remote-id option 37 information into
option remote-id DHCPv6 client messages. Remote-id option information such as the port attached
to the client, DUID, and VLAN ID is used by the DHCPv6 server to assign
preassigned configuration data specific to the DHCPv6 client. Use the no form of
the command to disable this function.
Syntax
[no] ipv6 dhcp snooping option remote-id
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ DHCPv6 provides a relay mechanism for sending information about the switch
and its DHCPv6 clients to the DHCPv6 server. Known as DHCPv6 Option 37, it
allows compatible DHCPv6 servers to use the information when assigning IP
addresses, or to set other services or policies for clients.
– 329 –
Chapter 9 | General Security Measures
DHCPv6 Snooping
Example
This example enables the DHCPv6 Snooping Remote-ID Option.
ipv6 dhcp snooping This command sets the remote-id option policy for DHCPv6 client packets that
option remote-id include Option 37 information. Use the no form to disable this function.
policy
Syntax
ipv6 dhcp snooping option remote-id policy {drop | keep | replace}
no ipv6 dhcp snooping option remote-id policy
drop - Drops the client’s request packet instead of relaying it.
keep - Retains the Option 37 information in the client request, and
forwards the packets to trusted ports.
replace - Replaces the Option 37 remote-ID in the client’s request with the
relay agent’s remote-ID (when DHCPv6 snooping is enabled), and forwards
the packets to trusted ports.
Default Setting
drop
Command Mode
Global Configuration
Command Usage
When the switch receives DHCPv6 packets from clients that already include DHCP
Option 37 information, the switch can be configured to set the action policy for
– 330 –
Chapter 9 | General Security Measures
DHCPv6 Snooping
these packets. The switch can either drop the DHCPv6 packets, keep the existing
information, or replace it with the switch’s relay agent information.
Example
This example configures the switch to keep existing remote-id option 37
information within DHCPv6 client packets and forward it.
ipv6 dhcp snooping This command enables DHCPv6 snooping on the specified VLAN. Use the no form
vlan to restore the default setting.
Syntax
[no] ipv6 dhcp snooping vlan {vlan-id | vlan-range}
vlan-id - ID of a configured VLAN (Range: 1-4094)
vlan-range - A consecutive range of VLANs indicated by the use a hyphen,
or a random group of VLANs with each entry separated by a comma.
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ When DHCPv6 snooping enabled globally using the ipv6 dhcp snooping
command, and enabled on a VLAN with this command, DHCPv6 packet
filtering will be performed on any untrusted ports within the VLAN as specified
by the ipv6 dhcp snooping trust command.
◆ When the DHCPv6 snooping is globally disabled, DHCPv6 snooping can still be
configured for specific VLANs, but the changes will not take effect until DHCPv6
snooping is globally re-enabled.
◆ When DHCPv6 snooping is enabled globally, and then disabled on a VLAN, all
dynamic bindings learned for this VLAN are removed from the binding table.
Example
This example enables DHCP6 snooping for VLAN 1.
– 331 –
Chapter 9 | General Security Measures
DHCPv6 Snooping
Related Commands
ipv6 dhcp snooping (326)
ipv6 dhcp snooping trust (332)
ipv6 dhcp snooping This command sets the maximum number of entries which can be stored in the
max-binding binding database for an interface. Use the no form to restore the default setting.
Syntax
ipv6 dhcp snooping max-binding count
no ipv6 dhcp snooping max-binding
count - Maximum number of entries. (Range: 1-5)
Default Setting
5
Command Mode
Interface Configuration (Ethernet, Port Channel)
Example
This example sets the maximum number of binding entries to 1.
ipv6 dhcp snooping This command configures the specified interface as trusted. Use the no form to
trust restore the default setting.
Syntax
[no] ipv6 dhcp snooping trust
Default Setting
All interfaces are untrusted
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ A trusted interface is an interface that is configured to receive only messages
from within the network. An untrusted interface is an interface that is
configured to receive messages from outside the network or fire wall.
◆ Set all ports connected to DHCv6 servers within the local network or fire wall to
trusted, and all other ports outside the local network or fire wall to untrusted.
– 332 –
Chapter 9 | General Security Measures
DHCPv6 Snooping
◆ When DHCPv6 snooping is enabled globally using the ipv6 dhcp snooping
command, and enabled on a VLAN with ipv6 dhcp snooping vlan command,
DHCPv6 packet filtering will be performed on any untrusted ports within the
VLAN according to the default status, or as specifically configured for an
interface with the no ipv6 dhcp snooping trust command.
◆ When an untrusted port is changed to a trusted port, all the dynamic DHCPv6
snooping bindings associated with this port are removed.
◆ Additional considerations when the switch itself is a DHCPv6 client – The port(s)
through which it submits a client request to the DHCPv6 server must be
configured as trusted.
Example
This example sets port 5 to untrusted.
Related Commands
ipv6 dhcp snooping (326)
ipv6 dhcp snooping vlan (331)
clear ipv6 dhcp This command clears DHCPv6 snooping binding table entries from RAM. Use this
snooping binding command without any optional keywords to clear all entries from the binding
table.
Syntax
clear ipv6 dhcp snooping binding [mac-address ipv6-address]
mac-address - Specifies a MAC address entry. (Format: xx-xx-xx-xx-xx-xx or
xxxxxxxxxxxx)
ipv6-address - Corresponding IPv6 address. This address must be entered
according to RFC 2373 “IPv6 Addressing Architecture,” using 8 colon-
separated 16-bit hexadecimal values. One double colon may be used in the
address to indicate the appropriate number of zeros required to fill the
undefined fields.
Command Mode
Privileged Exec
Example
Console(config)#clear ipv6 dhcp snooping binding 00-12-cf-01-02-03 2001::1
Console(config)#
– 333 –
Chapter 9 | General Security Measures
DHCPv6 Snooping
clear ipv6 dhcp This command clears statistical counters for DHCPv6 snooping client, server and
snooping statistics relay packets.
Command Mode
Privileged Exec
Example
Console(config)#clear ipv6 dhcp snooping statistics
Console(config)#
show ipv6 dhcp This command shows the DHCPv6 snooping configuration settings.
snooping
Command Mode
Privileged Exec
Example
Console#show ipv6 dhcp snooping
Global DHCPv6 Snooping status: disabled
DHCPv6 Snooping remote-id option status: disabled
DHCPv6 Snooping remote-id policy: drop
DHCPv6 Snooping interface-id option status: enabled
DHCPv6 Snooping interface-id policy: replace
DHCPv6 Snooping is configured on the following VLANs:
show ipv6 dhcp This command shows the DHCPv6 snooping binding table entries.
snooping binding
Command Mode
Privileged Exec
Example
Console#show ipv6 dhcp snooping binding
NA - Non-temporary address
TA - Temporary address
-------------------------------------- ----------- ---- ------- ----
Link-layer Address: 00-13-49-aa-39-26
IPv6 Address Lifetime VLAN Port Type
--------------------------------------- ---------- ---- ------- ----
2001:b021:1435:5612:ab3c:6792:a452:6712 2591998 1 Eth 1/5 NA
--------------------------------------- ---------- ---- ------- ----
Link-layer Address: 00-12-cf-01-02-03
– 334 –
Chapter 9 | General Security Measures
IPv4 Source Guard
show ipv6 dhcp This command shows statistics for DHCPv6 snooping client, server and relay
snooping statistics packets.
Command Mode
Privileged Exec
Example
Console#show ipv6 dhcp snooping statistics
DHCPv6 Snooping Statistics:
Client Packet: Solicit, Request, Confirm, Renew, Rebind,
Decline, Release, Information-request
Server Packet: Advertise, Reply, Reconfigure
Relay Packet: Relay-forward, Relay-reply
State Client Server Relay Total
-------- -------- -------- -------- --------
Received 10 9 0 19
Sent 9 9 0 18
Droped 1 0 0 1
Console#
ip source-guard max-binding Sets the maximum number of entries that can be bound IC
to an interface
– 335 –
Chapter 9 | General Security Measures
IPv4 Source Guard
ip source-guard This command adds a static address to the source-guard ACL or MAC address
binding binding table. Use the no form to remove a static entry.
Syntax
ip source-guard binding [mode {acl | mac}] mac-address
vlan vlan-id ip-address interface ethernet unit/port-list
no ip source-guard binding [mode {acl | mac}] mac-address ip-address
mode - Specifies the binding mode.
acl - Adds binding to ACL table.
mac - Adds binding to MAC address table.
mac-address - A valid unicast MAC address.
vlan-id - ID of a configured VLAN for an ACL filtering table or a range of
VLANs for a MAC address filtering table. To specify a list separate
nonconsecutive VLAN identifiers with a comma and no spaces; use a
hyphen to designate a range of IDs. (Range: 1-4094)
ip-address - A valid unicast IP address, including classful types A, B or C.
unit - Unit identifier. (Range: 1)
port-list - Physical port number or list of port numbers. Separate
nonconsecutive port numbers with a comma and no spaces; or use a
hyphen to designate a range of port numbers. (Range: 1-28)
Default Setting
No configured entries
Command Mode
Global Configuration
Command Usage
◆ If the binding mode is not specified in this command, the entry is bound to the
ACL table by default.
◆ Table entries include a MAC address, IP address, lease time, entry type (Static-IP-
SG-Binding, Dynamic-DHCP-Binding), VLAN identifier, and port identifier.
◆ All static entries are configured with an infinite lease time, which is indicated
with a value of zero by the show ip source-guard command.
– 336 –
Chapter 9 | General Security Measures
IPv4 Source Guard
◆ When source guard is enabled, traffic is filtered based upon dynamic entries
learned via DHCP snooping, or static addresses configured in the source guard
binding table with this command.
◆ An entry with same MAC address and a different VLAN ID cannot be added to
the binding table.
■ A valid static IP source guard entry will be added to the binding table in
ACL mode if one of the following conditions is true:
■ If there is no binding entry with the same VLAN ID and MAC address, a
new entry will be added to the binding table using the type of static IP
source guard binding.
■ If there is an entry with the same VLAN ID and MAC address, and the
type of entry is static IP source guard binding, then the new entry will
replace the old one.
■ If there is an entry with the same VLAN ID and MAC address, and the
type of the entry is dynamic DHCP snooping binding, then the new
entry will replace the old one and the entry type will be changed to
static IP source guard binding.
■ Note that a static IP source guard entry cannot be added for an non-
existent VLAN.
■ A valid static IP source guard entry will be added to the binding table in
MAC mode if one of the following conditions are true:
■ If there is no binding entry with the same IP address and MAC address,
a new entry will be added to the binding table using the type of static
IP source guard binding entry.
■ If there is a binding entry with same IP address and MAC address, then
the new entry shall replace the old one.
Example
This example configures a static source-guard binding on port 5. Since the binding
mode is not specified, the entry is bound to the ACL table by default.
Related Commands
ip source-guard (338)
ip dhcp snooping (312)
ip dhcp snooping vlan (320)
– 337 –
Chapter 9 | General Security Measures
IPv4 Source Guard
ip source-guard This command configures the switch to filter inbound traffic based on source IP
address, or source IP address and corresponding MAC address. Use the no form to
disable this function.
Syntax
ip source-guard {sip | sip-mac}
no ip source-guard
sip - Filters traffic based on IP addresses stored in the binding table.
sip-mac - Filters traffic based on IP addresses and corresponding MAC
addresses stored in the binding table.
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ Source guard is used to filter traffic on an insecure port which receives
messages from outside the network or fire wall, and therefore may be subject
to traffic attacks caused by a host trying to use the IP address of a neighbor.
◆ Setting source guard mode to “sip” or “sip-mac” enables this function on the
selected port. Use the “sip” option to check the VLAN ID, source IP address, and
port number against all entries in the binding table. Use the “sip-mac” option
to check these same parameters, plus the source MAC address. Use the no ip
source guard command to disable this function on the selected port.
◆ When enabled, traffic is filtered based upon dynamic entries learned via DHCP
snooping, or static addresses configured in the source guard binding table.
◆ Table entries include a MAC address, IP address, lease time, entry type (Static-IP-
SG-Binding, Dynamic-DHCP-Binding, VLAN identifier, and port identifier.
◆ Static addresses entered in the source guard binding table with the ip source-
guard binding command are automatically configured with an infinite lease
time. Dynamic entries learned via DHCP snooping are configured by the DHCP
server itself.
■ If DHCPv4 snooping is disabled (see page 312), IP source guard will check
the VLAN ID, source IP address, port number, and source MAC address (for
– 338 –
Chapter 9 | General Security Measures
IPv4 Source Guard
the sip-mac option). If a matching entry is found in the binding table and
the entry type is static IP source guard binding, the packet will be
forwarded.
■ If the DHCP snooping is enabled, IP source guard will check the VLAN ID,
source IP address, port number, and source MAC address (for the sip-mac
option). If a matching entry is found in the binding table and the entry type
is static IP source guard binding, or dynamic DHCP snooping binding, the
packet will be forwarded.
Example
This example enables IP source guard on port 5.
Related Commands
ip source-guard binding (336)
ip dhcp snooping (312)
ip dhcp snooping vlan (320)
ip source-guard This command sets the maximum number of entries that can be bound to an
max-binding interface. Use the no form to restore the default setting.
Syntax
ip source-guard [mode {acl | mac}] max-binding number
no ip source-guard [mode {acl | mac}] max-binding
mode - Specifies the learning mode.
acl - Searches for addresses in the ACL table.
mac - Searches for addresses in the MAC address table.
number - The maximum number of IP addresses that can be mapped to an
interface in the binding table. (Range: 1-10)
Default Setting
Mode: ACL, Maximum Binding: 5
Mode: MAC, Maximum Binding: 1024
– 339 –
Chapter 9 | General Security Measures
IPv4 Source Guard
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ This command sets the maximum number of address entries that can be
mapped to an interface in the binding table for the specified mode (ACL
binding table or MAC address table) including dynamic entries discovered by
DHCP snooping and static entries set by the ip source-guard command.
◆ The maximum binding for ACL mode restricts the number of “active” entries
per port. If binding entries exceed the maximum number in IP source guard,
only the maximum number of binding entries will be set. Dynamic binding
entries exceeding the maximum number will be created but will not be active.
◆ The maximum binding for MAC mode restricts the number of MAC addresses
learned per port. Authenticated IP traffic with different source MAC addresses
cannot be learned if it would exceed this maximum number.
Example
This example sets the maximum number of allowed entries for ACL mode in the
binding table for port 5 to one entry. The mode is not specified, and therefore
defaults to the ACL binding table.
ip source-guard mode This command sets the source-guard learning mode to search for addresses in the
ACL binding table or the MAC address binding table. Use the no form to restore the
default setting.
Syntax
ip source-guard mode {acl | mac}
no ip source-guard mode
mode - Specifies the learning mode.
acl - Searches for addresses in the ACL binding table.
mac - Searches for addresses in the MAC address binding table.
Default Setting
ACL
Command Mode
Interface Configuration (Ethernet)
– 340 –
Chapter 9 | General Security Measures
IPv4 Source Guard
Command Usage
There are two modes for the filtering table:
◆ ACL - IP traffic will be forwarded if it passes the checking process in the ACL
mode binding table.
◆ MAC - A MAC entry will be added in MAC address table if IP traffic passes the
checking process in MAC mode binding table.
Example
This command sets the binding table mode for the specified interface to MAC
mode:
clear ip source-guard This command clears source-guard binding table entries from RAM.
binding blocked
Syntax
clear ip source-guard binding blocked
Command Mode
Privileged Exec
Command Usage
When IP Source-Guard detects an invalid packet it creates a blocked record. These
records can be viewed using the show ip source-guard binding blocked command.
A maximum of 512 blocked records can be stored before the switch overwrites the
oldest record with new blocked records. Use the clear ip source-guard binding
blocked command to clear this table.
Example
This command clears the blocked record table.
show ip source-guard This command shows whether source guard is enabled or disabled on each
interface.
Command Mode
Privileged Exec
– 341 –
Chapter 9 | General Security Measures
IPv4 Source Guard
Example
Console#show ip source-guard
ACL Table MAC Table
Interface Filter-type Filter-table Max-binding Max-binding
--------- ----------- ------------ ----------- -----------
Eth 1/1 DISABLED ACL 5 1024
Eth 1/2 DISABLED ACL 5 1024
Eth 1/3 DISABLED ACL 5 1024
Eth 1/4 DISABLED ACL 5 1024
Eth 1/5
. DISABLED ACL 5 1024
.
.
show ip source-guard This command shows the source guard binding table.
binding
Syntax
show ip source-guard binding [dhcp-snooping | static [acl | mac] |
blocked [vlan vlan-id | interface interface]
dhcp-snooping - Shows dynamic entries configured with DHCP Snooping
commands (see page 311)
static - Shows static entries configured with the ip source-guard binding
command.
acl - Shows static entries in the ACL binding table.
mac - Shows static entries in the MAC address binding table.
blocked - Shows MAC addresses which have been blocked by IP Source
Guard.
vlan-id - ID of a configured VLAN (Range: 1-4094)
interface - Specifies a port interface.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show ip source-guard binding
MAC Address IP Address Type VLAN Interface
----------------- --------------- -------------- --------- ---------
00-10-b5-f4-d0-01 10.2.44.96 static-acl 1 Eth 1/1
Console#
– 342 –
Chapter 9 | General Security Measures
IPv6 Source Guard
ipv6 source-guard binding Adds a static address to the source-guard binding table GC
ipv6 source-guard max- Sets the maximum number of entries that can be bound IC
binding to an interface
ipv6 source-guard This command adds a static address to the source-guard binding table. Use the no
binding form to remove a static entry.
Syntax
ipv6 source-guard binding mac-address vlan vlan-id ipv6-address
interface interface
no ipv6 source-guard binding mac-address ipv6-address
mac-address - A valid unicast MAC address.
vlan-id - ID of a configured VLAN (Range: 1-4094)
ipv6-address - Corresponding IPv6 address. This address must be entered
according to RFC 2373 “IPv6 Addressing Architecture,” using 8 colon-
separated 16-bit hexadecimal values. One double colon may be used in the
address to indicate the appropriate number of zeros required to fill the
undefined fields.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
– 343 –
Chapter 9 | General Security Measures
IPv6 Source Guard
Default Setting
No configured entries
Command Mode
Global Configuration
Command Usage
◆ Table entries include an associated MAC address, IPv6 global unicast address,
entry type (Static-IPv6-SG-Binding, Dynamic-ND-Snooping, Dynamic-DHCPv6-
Snooping), VLAN identifier, and port identifier.
◆ Traffic filtering is based only on the source IPv6 address, VLAN ID, and port
number.
◆ All static entries are configured with an infinite lease time, which is indicated
with a value of zero by the show ipv6 source-guard command.
◆ When source guard is enabled, traffic is filtered based upon dynamic entries
learned via ND snooping, DHCPv6 snooping, or static addresses configured in
the source guard binding table with this command.
◆ An entry with same MAC address and a different VLAN ID cannot be added to
the binding table.
■ If there is no entry with same and MAC address and IPv6 address, a new
entry is added to binding table using static IPv6 source guard binding.
■ If there is an entry with same MAC address and IPv6 address, and the type
of entry is static IPv6 source guard binding, then the new entry will replace
the old one.
■ If there is an entry with same MAC address and IPv6 address, and the type
of the entry is either a dynamic ND snooping binding or DHCPv6 snooping
binding, then the new entry will replace the old one and the entry type will
be changed to static IPv6 source guard binding.
Example
This example configures a static source-guard binding on port 5.
Related Commands
ipv6 source-guard (345)
– 344 –
Chapter 9 | General Security Measures
IPv6 Source Guard
ipv6 source-guard This command configures the switch to filter inbound traffic based on the source IP
address stored in the binding table. Use the no form to disable this function.
Syntax
ipv6 source-guard sip
no ipv6 source-guard
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ Source guard is used to filter traffic on an insecure port which receives
messages from outside the network or fire wall, and therefore may be subject
to traffic attacks caused by a host trying to use the IP address of a neighbor.
◆ This command checks the VLAN ID, IPv6 global unicast source IP address, and
port number against all entries in the binding table. Use the no ipv6 source
guard command to disable this function on the selected port.
◆ After IPv6 source guard is enabled on an interface, the switch initially blocks all
IPv6 traffic received on that interface, except for ND packets allowed by ND
snooping and DHCPv6 packets allowed by DHCPv6 snooping. A port access
control list (ACL) is applied to the interface. Traffic is then filtered based upon
dynamic entries learned via ND snooping or DHCPv6 snooping, or static
addresses configured in the source guard binding table. The port allows only
IPv6 traffic with a matching entry in the binding table and denies all other IPv6
traffic.
◆ Table entries include a MAC address, IPv6 global unicast address, entry type
(Static-IPv6-SG-Binding, Dynamic-ND-Snooping, Dynamic-DHCPv6-Snooping),
VLAN identifier, and port identifier.
◆ Static addresses entered in the source guard binding table with the ipv6
source-guard binding command are automatically configured with an infinite
lease time. Dynamic entries learned via DHCPv6 snooping are configured by
the DHCPv6 server itself.
◆ If IPv6 source guard is enabled, an inbound packet’s source IPv6 address will be
checked against the binding table. If no matching entry is found, the packet
will be dropped.
– 345 –
Chapter 9 | General Security Measures
IPv6 Source Guard
■ If ND snooping and DHCPv6 snooping are disabled, IPv6 source guard will
check the VLAN ID, source IPv6 address, and port number. If a matching
entry is found in the binding table and the entry type is static IPv6 source
guard binding, the packet will be forwarded.
Example
This example enables IP source guard on port 5.
Related Commands
ipv6 source-guard binding (343)
ipv6 dhcp snooping (326)
ipv6 dhcp snooping vlan (331)
ipv6 source-guard This command sets the maximum number of entries that can be bound to an
max-binding interface. Use the no form to restore the default setting.
Syntax
ipv6 source-guard max-binding number
no ipv6 source-guard max-binding
number - The maximum number of IPv6 addresses that can be mapped to
an interface in the binding table. (Range: 1-5)
Default Setting
5
– 346 –
Chapter 9 | General Security Measures
IPv6 Source Guard
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ This command sets the maximum number of address entries that can be
mapped to an interface in the binding table, including both dynamic entries
discovered by ND snooping, DHCPv6 snooping, and static entries set by the
ipv6 source-guard command.
◆ IPv6 source guard maximum bindings must be set to a value higher than
DHCPv6 snooping maximum bindings and ND snooping maximum bindings.
◆ If IPv6 source guard is enabled on a port, and the maximum number of allowed
bindings is changed to a lower value, precedence is given to deleting entries
learned through DHCPv6 snooping, ND snooping, and then manually
configured IPv6 source guard static bindings, until the number of entries in the
binding table reaches the newly configured maximum number of allowed
bindings.
Example
This example sets the maximum number of allowed entries in the binding table for
port 5 to one entry.
show ipv6 source- This command shows whether IPv6 source guard is enabled or disabled on each
guard interface, and the maximum allowed bindings.
Command Mode
Privileged Exec
Example
Console#show ipv6 source-guard
ipv6 permit link-local status: disable
– 347 –
Chapter 9 | General Security Measures
ARP Inspection
show ipv6 source- This command shows the IPv6 source guard binding table.
guard binding
Syntax
show ipv6 source-guard binding [dynamic | static]
dynamic - Shows dynamic entries configured with ND Snooping or
DHCPv6 Snooping commands (see page 326)
static - Shows static entries configured with the ipv6 source-guard binding
command.
Command Mode
Privileged Exec
Example
Console#show ipv6 source-guard binding
DHCPV6SNP:
DHCP - Stateful address
NDSNP:
ND - Stateless address
STA - Static IPv6 source guard binding
ARP Inspection
ARP Inspection validates the MAC-to-IP address bindings in Address Resolution
Protocol (ARP) packets. It protects against ARP traffic with invalid address bindings,
which forms the basis for certain “man-in-the-middle” attacks. This is accomplished
by intercepting all ARP requests and responses and verifying each of these packets
before the local ARP cache is updated or the packet is forwarded to the appropriate
destination, dropping any invalid ARP packets.
ARP Inspection determines the validity of an ARP packet based on valid IP-to-MAC
address bindings stored in a trusted database – the DHCP snooping binding
database. ARP Inspection can also validate ARP packets against user-configured
ARP access control lists (ACLs) for hosts with statically configured IP addresses.
– 348 –
Chapter 9 | General Security Measures
ARP Inspection
ip arp inspection filter Specifies an ARP ACL to apply to one or more VLANs GC
ip arp inspection log-buffer Sets the maximum number of entries saved in a log GC
logs message, and the rate at these messages are sent
ip arp inspection vlan Enables ARP Inspection for a specified VLAN or range of GC
VLANs
ip arp inspection limit Sets a rate limit for the ARP packets received on a port IC
ip arp inspection trust Sets a port as trusted, and thus exempted from ARP IC
Inspection
show ip arp inspection Displays the global configuration settings for ARP PE
configuration Inspection
show ip arp inspection Shows the trust status and inspection rate limit for ports PE
interface
show ip arp inspection log Shows information about entries stored in the log, PE
including the associated VLAN, port, and address
components
show ip arp inspection Shows statistics about the number of ARP packets PE
statistics processed, or dropped for various reasons
show ip arp inspection vlan Shows configuration setting for VLANs, including ARP PE
Inspection status, the ARP ACL name, and if the DHCP
Snooping database is used after ACL validation is
completed
ip arp inspection This command enables ARP Inspection globally on the switch. Use the no form to
disable this function.
Syntax
[no] ip arp inspection
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ When ARP Inspection is enabled globally with this command, it becomes active
only on those VLANs where it has been enabled with the ip arp inspection vlan
command.
– 349 –
Chapter 9 | General Security Measures
ARP Inspection
◆ When ARP Inspection is enabled globally and enabled on selected VLANs, all
ARP request and reply packets on those VLANs are redirected to the CPU and
their switching is handled by the ARP Inspection engine.
◆ When ARP Inspection is disabled globally, it becomes inactive for all VLANs,
including those where ARP Inspection is enabled.
◆ When ARP Inspection is disabled, all ARP request and reply packets bypass the
ARP Inspection engine and their manner of switching matches that of all other
packets.
◆ Disabling and then re-enabling global ARP Inspection will not affect the ARP
Inspection configuration for any VLANs.
Example
Console(config)#ip arp inspection
Console(config)#
ip arp inspection filter This command specifies an ARP ACL to apply to one or more VLANs. Use the no
form to remove an ACL binding. Use the no form to remove an ACL binding.
Syntax
ip arp inspection filter arp-acl-name vlan {vlan-id | vlan-range} [static]
no ip arp inspection filter arp-acl-name vlan {vlan-id | vlan-range}
arp-acl-name - Name of an ARP ACL. (Maximum length: 16 characters)
vlan-id - VLAN ID. (Range: 1-4094)
vlan-range - A consecutive range of VLANs indicated by the use a hyphen,
or a random group of VLANs with each entry separated by a comma.
static - ARP packets are only validated against the specified ACL, address
bindings in the DHCP snooping database is not checked.
Default Setting
ARP ACLs are not bound to any VLAN
Static mode is not enabled
Command Mode
Global Configuration
– 350 –
Chapter 9 | General Security Measures
ARP Inspection
Command Usage
◆ ARP ACLs are configured with the commands described under “ARP ACLs” on
page 388.
◆ If static mode is enabled, the switch compares ARP packets to the specified ARP
ACLs. Packets matching an IP-to-MAC address binding in a permit or deny rule
are processed accordingly. Packets not matching any of the ACL rules are
dropped. Address bindings in the DHCP snooping database are not checked.
◆ If static mode is not enabled, packets are first validated against the specified
ARP ACL. Packets matching a deny rule are dropped. All remaining packets are
validated against the address bindings in the DHCP snooping database.
Example
Console(config)#ip arp inspection filter sales vlan 1
Console(config)#
ip arp inspection This command sets the maximum number of entries saved in a log message, and
log-buffer logs the rate at which these messages are sent. Use the no form to restore the default
settings.
Syntax
ip arp inspection log-buffer logs message-number interval seconds
no ip arp inspection log-buffer logs
message-number - The maximum number of entries saved in a log message.
(Range: 0-256, where 0 means no events are saved and no messages sent)
seconds - The interval at which log messages are sent. (Range: 0-86400)
Default Setting
Message Number: 20
Interval: 10 seconds
Command Mode
Global Configuration
Command Usage
◆ ARP Inspection must be enabled with the ip arp inspection command before
this command will be accepted by the switch.
◆ When the switch drops a packet, it places an entry in the log buffer. Each entry
contains flow information, such as the receiving VLAN, the port number, the
source and destination IP addresses, and the source and destination MAC
addresses.
– 351 –
Chapter 9 | General Security Measures
ARP Inspection
◆ The maximum number of entries that can be stored in the log buffer is
determined by the message-number parameter. If the log buffer fills up before a
message is sent, the oldest entry will be replaced with the newest one.
Example
Console(config)#ip arp inspection log-buffer logs 1 interval 10
Console(config)#
ip arp inspection This command specifies additional validation of address components in an ARP
validate packet. Use the no form to restore the default setting.
Syntax
ip arp inspection validate
{dst-mac [ip [allow-zeros] [src-mac]] |
ip [allow-zeros] [src-mac] | src-mac}
no ip arp inspection validate
dst-mac - Checks the destination MAC address in the Ethernet header
against the target MAC address in the ARP body. This check is performed
for ARP responses. When enabled, packets with different MAC addresses
are classified as invalid and are dropped.
ip - Checks 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 checked in all ARP requests and responses, while
target IP addresses are checked only in ARP responses.
allow-zeros - Allows sender IP address to be 0.0.0.0.
src-mac - Checks 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.
Default Setting
No additional validation is performed
Command Mode
Global Configuration
– 352 –
Chapter 9 | General Security Measures
ARP Inspection
Command Usage
By default, ARP Inspection only checks the IP-to-MAC address bindings specified in
an ARP ACL or in the DHCP Snooping database.
Example
Console(config)#ip arp inspection validate dst-mac
Console(config)#
ip arp inspection vlan This command enables ARP Inspection for a specified VLAN or range of VLANs. Use
the no form to disable this function.
Syntax
[no] ip arp inspection vlan {vlan-id | vlan-range}
vlan-id - VLAN ID. (Range: 1-4094)
vlan-range - A consecutive range of VLANs indicated by the use a hyphen,
or a random group of VLANs with each entry separated by a comma.
Default Setting
Disabled on all VLANs
Command Mode
Global Configuration
Command Usage
◆ When ARP Inspection is enabled globally with the ip arp inspection command,
it becomes active only on those VLANs where it has been enabled with this
command.
◆ When ARP Inspection is enabled globally and enabled on selected VLANs, all
ARP request and reply packets on those VLANs are redirected to the CPU and
their switching is handled by the ARP Inspection engine.
◆ When ARP Inspection is disabled globally, it becomes inactive for all VLANs,
including those where ARP Inspection is enabled.
◆ When ARP Inspection is disabled, all ARP request and reply packets bypass the
ARP Inspection engine and their manner of switching matches that of all other
packets.
◆ Disabling and then re-enabling global ARP Inspection will not affect the ARP
Inspection configuration for any VLANs.
– 353 –
Chapter 9 | General Security Measures
ARP Inspection
Example
Console(config)#ip arp inspection vlan 1,2
Console(config)#
ip arp inspection limit This command sets a rate limit for the ARP packets received on a port. Use the no
form to restore the default setting.
Syntax
ip arp inspection limit {rate pps | none}
no ip arp inspection limit
pps - The maximum number of ARP packets that can be processed by the
CPU per second on trusted or untrusted ports. (Range: 0-2048, where 0
means that no ARP packets can be forwarded)
none - There is no limit on the number of ARP packets that can be
processed by the CPU.
Default Setting
15
Command Mode
Interface Configuration (Port, Static Aggregation)
Command Usage
◆ This command applies to both trusted and untrusted ports.
◆ When the rate of incoming ARP packets exceeds the configured limit, the
switch drops all ARP packets in excess of the limit.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ip arp inspection limit rate 150
Console(config-if)#
ip arp inspection trust This command sets a port as trusted, and thus exempted from ARP Inspection. Use
the no form to restore the default setting.
Syntax
[no] ip arp inspection trust
Default Setting
Untrusted
– 354 –
Chapter 9 | General Security Measures
ARP Inspection
Command Mode
Interface Configuration (Port, Static Aggregation)
Command Usage
Packets arriving on untrusted ports are subject to any configured ARP Inspection
and additional validation checks. Packets arriving on trusted ports bypass all of
these checks, and are forwarded according to normal switching rules.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ip arp inspection trust
Console(config-if)#
show ip arp inspection This command displays the global configuration settings for ARP Inspection.
configuration
Command Mode
Privileged Exec
Example
Console#show ip arp inspection configuration
show ip arp inspection This command shows the trust status and ARP Inspection rate limit for ports.
interface
Syntax
show ip arp inspection interface [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
– 355 –
Chapter 9 | General Security Measures
ARP Inspection
Example
Console#show ip arp inspection interface ethernet 1/1
show ip arp inspection This command shows information about entries stored in the log, including the
log associated VLAN, port, and address components.
Command Mode
Privileged Exec
Example
Console#show ip arp inspection log
Total log entries number is 1
Num VLAN Port Src IP Address Dst IP Address Src MAC Address Dst MAC Address
--- ---- ---- -------------- -------------- --------------- --------------
1 1 11 192.168.2.2 192.168.2.1 00-04-E2-A0-E2-7C FF-FF-FF-FF-FF-FF
Console#
show ip arp inspection This command shows statistics about the number of ARP packets processed, or
statistics dropped for various reasons.
Command Mode
Privileged Exec
Example
Console#show ip arp inspection statistics
Console#
– 356 –
Chapter 9 | General Security Measures
Denial of Service Protection
show ip arp inspection This command shows the configuration settings for VLANs, including ARP
vlan Inspection status, the ARP ACL name, and if the DHCP Snooping database is used
after ARP ACL validation is completed.
Syntax
show ip arp inspection vlan [vlan-id | vlan-range]
vlan-id - VLAN ID. (Range: 1-4094)
vlan-range - A consecutive range of VLANs indicated by the use a hyphen,
or a random group of VLANs with each entry separated by a comma.
Command Mode
Privileged Exec
Command Usage
Enter this command to display the configuration settings for all VLANs, or display
the settings for a specific VLAN by entering the VLAN identifier.
Example
Console#show ip arp inspection vlan 1
– 357 –
Chapter 9 | General Security Measures
Denial of Service Protection
dos-protection tcp-udp-port-zero Protects against attacks which set the Layer 4 source GC
or destination port to zero
dos-protection This command protects against DoS echo/chargen attacks in which the echo
echo-chargen service repeats anything sent to it, and the chargen (character generator) service
generates a continuous stream of data. When used together, they create an infinite
loop and result in a denial-of-service. Use the no form without the bit rate
parameter to disable this feature, or with the bit rate parameter to restore the
defautl rate limit..
Syntax
dos-protection echo-chargen [bit-rate-in-kilo rate]
no dos-protection echo-chargen [bit-rate-in-kilo]
rate – Maximum allowed rate. (Range: 64-2000 kbits/second)
Default Setting
Disabled, 1000 kbits/second
Command Mode
Global Configuration
Example
Console(config)#dos-protection echo-chargen bit-rate-in-kilo 65
Console(config)#
dos-protection land This command protects against DoS LAND (Local Area Network Denial) attacks in
which hackers send spoofed-IP packets where the source and destination address
are the same, thereby causing the target to reply to itself continuously. Use the no
form to disable this feature.
Syntax
[no] dos-protection land
– 358 –
Chapter 9 | General Security Measures
Denial of Service Protection
Default Setting
Disabled
Command Mode
Global Configuration
Example
Console(config)#dos-protection land
Console(config)#
dos-protection smurf This command protects against DoS smurf attacks in which a perpetrator generates
a large amount of spoofed ICMP Echo Request traffic to the broadcast destination
IP address (255.255.255.255), all of which uses a spoofed source address of the
intended victim. The victim should crash due to the many interrupts required to
send ICMP Echo response packets. Use the no form to disable this feature.
Syntax
[no] dos-protection smurf
Default Setting
Disabled
Command Mode
Global Configuration
Example
Console(config)#dos-protection smurf
Console(config)#
dos-protection This command protects against DoS TCP-flooding attacks in which a perpetrator
tcp-flooding sends a succession of TCP SYN requests (with or without a spoofed-Source IP) to a
target and never returns ACK packets. These half-open connections will bind
resources on the target, and no new connections can be made, resulting in a denial
of service. Use the no form without the bit rate parameter to disable this feature, or
with the bit rate parameter to restore the default rate limit.
Syntax
– 359 –
Chapter 9 | General Security Measures
Denial of Service Protection
Default Setting
Disabled, 1000 kbits/second
Command Mode
Global Configuration
Example
Console(config)#dos-protection tcp-flooding bit-rate-in-kilo 65
Console(config)#
dos-protection This command protects against DoS TCP-null-scan attacks in which a TCP NULL
tcp-null-scan scan message is used to identify listening TCP ports. The scan uses a series of
strangely configured TCP packets which contain a sequence number of 0 and no
flags. If the target's TCP port is closed, the target replies with a TCP RST (reset)
packet. If the target TCP port is open, it simply discards the TCP NULL scan. Use the
no form to disable this feature.
Syntax
[no] dos-protection tcp-null-scan
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
In these packets, all TCP flags are 0.
Example
Console(config)#dos-protection tcp-null-scan
Console(config)#
dos-protection This command protects against DoS TCP-SYN/FIN-scan attacks in which a TCP SYN/
tcp-syn-fin-scan FIN scan message is used to identify listening TCP ports. The scan uses a series of
strangely configured TCP packets which contain SYN (synchronize) and FIN (finish)
flags. If the target's TCP port is closed, the target replies with a TCP RST (reset)
packet. If the target TCP port is open, it simply discards the TCP SYN FIN scan. Use
the no form to disable this feature.
Syntax
[no] dos-protection tcp-syn-fin-scan
– 360 –
Chapter 9 | General Security Measures
Denial of Service Protection
Default Setting
Disabled
Command Mode
Global Configuration
Example
Console(config)#dos-protection tcp-syn-fin-scan
Console(config)#
dos-protection This command protects against DoS attacks in which the TCP or UDP source port or
tcp-udp-port-zero destination port is set to zero. This technique may be used as a form of DoS attack,
or it may just indicate a problem with the source device. When this command is
enabled, the switch will drop these packets. Use the no form to restore the default
setting.
Syntax
[no] dos-protection tcp-udp-port-zero
Default Setting
Disabled
Command Mode
Global Configuration
Example
Console(config)#dos-protection tcp-udp-port-zero
Console(config)#
dos-protection This command protects against DoS TCP-xmas-scan in which a so-called TCP XMAS
tcp-xmas-scan scan message is used to identify listening TCP ports. This scan uses a series of
strangely configured TCP packets which contain a sequence number of 0 and the
URG, PSH and FIN flags. If the target's TCP port is closed, the target replies with a
TCP RST packet. If the target TCP port is open, it simply discards the TCP XMAS scan.
Use the no form to disable this feature.
Syntax
[no] dos-protection tcp-xmas-scan
Default Setting
Disabled
Command Mode
Global Configuration
– 361 –
Chapter 9 | General Security Measures
Denial of Service Protection
Example
Console(config)#dos-protection tcp-xmas-scan
Console(config)#
dos-protection This command protects against DoS UDP-flooding attacks in which a perpetrator
udp-flooding sends a large number of UDP packets (with or without a spoofed-Source IP) to
random ports on a remote host. The target will determine that application is
listening at that port, and reply with an ICMP Destination Unreachable packet. It
will be forced to send many ICMP packets, eventually leading it to be unreachable
by other clients. Use the no form without the bit rate parameter to disable this
feature, or with the bit rate parameter to restore the default rate limit.
Syntax
dos-protection udp-flooding [bit-rate-in-kilo rate]
no dos-protection udp-flooding [bit-rate-in-kilo]
rate – Maximum allowed rate. (Range: 64-2000 kbits/second)
Default Setting
Disabled, 1000 kbits/second
Command Mode
Global Configuration
Example
Console(config)#dos-protection udp-flooding bit-rate-in-kilo 65
Console(config)#
dos-protection This command protects against DoS WinNuke attacks in which affected the
win-nuke Microsoft Windows 3.1x/95/NT operating systems. In this type of attack, the
perpetrator sends the string of OOB out-of-band (OOB) packets contained a TCP
URG flag to the target computer on TCP port 139 (NetBIOS), casing it to lock up and
display a “Blue Screen of Death.” This did not cause any damage to, or change data
on, the computer’s hard disk, but any unsaved data would be lost. Microsoft made
patches to prevent the WinNuke attack, but the OOB packets still put the service in
a tight loop that consumed all available CPU time. Use the no form without the bit
rate parameter to disable this feature, or with the bit rate parameter to restore the
default rate limit.
Syntax
dos-protection win-nuke [bit-rate-in-kilo rate]
no dos-protection win-nuke [bit-rate-in-kilo]
– 362 –
Chapter 9 | General Security Measures
Port-based Traffic Segmentation
Default Setting
Disabled, 1000 kbits/second
Command Mode
Global Configuration
Example
Console(config)#dos-protection win-nuke bit-rate-in-kilo 65
Console(config)#
show dos-protection This command shows the configuration settings for the DoS protection commands.
Command Mode
Privileged Exec
Example
Console#show dos-protection
Global DoS Protection:
Traffic belonging to each client is isolated to the allocated downlink ports. But the
switch can be configured to either isolate traffic passing across a client’s allocated
uplink ports from the uplink ports assigned to other clients, or to forward traffic
through the uplink ports used by other clients, allowing different clients to share
access to their uplink ports where security is less likely to be compromised.
– 363 –
Chapter 9 | General Security Measures
Port-based Traffic Segmentation
traffic-segmentation This command enables traffic segmentation. Use the no form to disable traffic
segmentation.
Syntax
[no] traffic-segmentation
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ Traffic segmentation provides port-based security and isolation between ports
within the VLAN. Data traffic on the downlink ports can only be forwarded to,
and from, the designated uplink port(s). Data cannot pass between downlink
ports in the same segmented group, nor to ports which do not belong to the
same group.
◆ Traffic segmentation and normal VLANs can exist simultaneously within the
same switch. Traffic may pass freely between uplink ports in segmented groups
and ports in normal VLANs.
◆ When traffic segmentation is enabled, the forwarding state for the uplink and
downlink ports assigned to different client sessions is shown below.
Table 68: Traffic Segmentation Forwarding
Destination Session #1 Session #1 Session #2 Session #2 Normal
Source Downlinks Uplinks Downlinks Uplinks Ports
– 364 –
Chapter 9 | General Security Measures
Port-based Traffic Segmentation
Example
This example enables traffic segmentation globally on the switch.
Console(config)#traffic-segmentation
Console(config)#
traffic-segmentation This command creates a traffic-segmentation client session. Use the no form to
session remove a client session.
Syntax
[no] traffic-segmentation session session-id
session-id – Traffic segmentation session. (Range: 1-4)
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ Use this command to create a new traffic-segmentation client session.
– 365 –
Chapter 9 | General Security Measures
Port-based Traffic Segmentation
◆ Using the no form of this command will remove any assigned uplink or
downlink ports, restoring these interfaces to normal operating mode.
Example
Console(config)#traffic-segmentation session 1
Console(config)#
traffic-segmentation This command configures the uplink and down-link ports for a segmented group of
uplink/downlink ports. Use the no form to remove a port from the segmented group.
Syntax
[no] traffic-segmentation [session session-id] {uplink interface-list
[downlink interface-list] | downlink interface-list}
session-id – Traffic segmentation session. (Range: 1-4)
uplink – Specifies an uplink interface.
downlink – Specifies a downlink interface.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
Session 1 if not defined
No segmented port groups are defined.
Command Mode
Global Configuration
Command Usage
◆ A port cannot be configured in both an uplink and downlink list.
◆ A downlink port can only communicate with an uplink port in the same session.
Therefore, if an uplink port is not configured for a session, the assigned
downlink ports will not be able to communicate with any other ports.
– 366 –
Chapter 9 | General Security Measures
Port-based Traffic Segmentation
◆ If a downlink port is not configured for the session, the assigned uplink ports
will operate as normal ports.
Example
This example enables traffic segmentation, and then sets port 10 as the uplink and
ports 5-8 as downlinks.
Console(config)#traffic-segmentation
Console(config)#traffic-segmentation uplink ethernet 1/10
downlink ethernet 1/5-8
Console(config)#
traffic-segmentation This command specifies whether or not traffic can be forwarded between uplink
uplink-to-uplink ports assigned to different client sessions. Use the no form to restore the default.
Syntax
traffic-segmentation uplink-to-uplink {blocking | forwarding}
no traffic-segmentation uplink-to-uplink
blocking – Blocks traffic between uplink ports assigned to different
sessions.
forwarding – Forwards traffic between uplink ports assigned to different
sessions.
Default Setting
Blocking
Command Mode
Global Configuration
Example
This example enables forwarding of traffic between uplink ports assigned to
different client sessions.
– 367 –
Chapter 9 | General Security Measures
Port-based Traffic Segmentation
Command Mode
Privileged Exec
Example
Console#show traffic-segmentation session 1
– 368 –
10 Access Control Lists
Access Control Lists (ACL) provide packet filtering for IPv4 frames (based on
address, protocol, Layer 4 protocol port number or TCP control code), IPv6 frames
(based on address, DSCP traffic class, or next header type), or any frames (based on
MAC address or Ethernet type). To filter packets, first create an access list, add the
required rules, and then bind the list to a specific port. This section describes the
Access Control List commands.
IPv4 ACLs Configures ACLs based on IPv4 addresses, TCP/UDP port number,
protocol type, and TCP control code
IPv6 ACLs Configures ACLs based on IPv6 addresses, DSCP traffic class, or next
header type
MAC ACLs Configures ACLs based on hardware addresses, packet format, and
Ethernet type
ACL Information Displays ACLs and associated rules; shows ACLs assigned to each port
IPv4 ACLs
The commands in this section configure ACLs based on IPv4 addresses, TCP/UDP
port number, protocol type, and TCP control code. To configure IPv4 ACLs, first
create an access list containing the required permit or deny rules, and then bind the
access list to one or more ports.
permit, deny Filters packets matching a specified source IPv4 address IPv4-STD-ACL
permit, deny Filters packets meeting the specified criteria, including IPv4-EXT-ACL
source and destination IPv4 address, TCP/UDP port
number, protocol type, and TCP control code
– 369 –
Chapter 10 | Access Control Lists
IPv4 ACLs
access-list ip This command adds an IP access list and enters configuration mode for standard or
extended IPv4 ACLs. Use the no form to remove the specified ACL.
Syntax
[no] access-list ip {standard | extended} acl-name
standard – Specifies an ACL that filters packets based on the source IP
address.
extended – Specifies an ACL that filters packets based on the source or
destination IP address, and other more specific criteria.
acl-name – Name of the ACL. (Maximum length: 32 characters)
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ When you create a new ACL or enter configuration mode for an existing ACL,
use the permit or deny command to add new rules to the bottom of the list.
Example
Console(config)#access-list ip standard david
Console(config-std-acl)#
Related Commands
permit, deny (370)
show ip access-list (375)
permit, deny This command adds a rule to a Standard IPv4 ACL. The rule sets a filter condition for
(Standard IP ACL) packets emanating from the specified source. Use the no form to remove a rule.
Syntax
{permit | deny} {any | source bitmask | host source}
[time-range time-range-name]
no {permit | deny} {any | source bitmask | host source}
any – Any source IP address.
source – Source IP address.
– 370 –
Chapter 10 | Access Control Lists
IPv4 ACLs
Default Setting
None
Command Mode
Standard IPv4 ACL
Command Usage
◆ New rules are appended to the end of the list.
◆ Address bit masks are similar to a subnet mask, containing four integers from 0
to 255, each separated by a period. The binary mask uses 1 bits to indicate
“match” and 0 bits to indicate “ignore.” The bitmask is bitwise ANDed with the
specified source IP address, and then compared with the address for each IP
packet entering the port(s) to which this ACL has been assigned.
Example
This example configures one permit rule for the specific address 10.1.1.21 and
another rule for the address range 168.92.16.x – 168.92.31.x using a bitmask.
Related Commands
access-list ip (370)
Time Range (166)
permit, deny This command adds a rule to an Extended IPv4 ACL. The rule sets a filter condition
(Extended IPv4 ACL) for packets with specific source or destination IP addresses, protocol types, source
or destination protocol ports, or TCP control codes. Use the no form to remove a
rule.
Syntax
{permit | deny} [protocol-number]
{any | source address-bitmask | host source}
{any | destination address-bitmask | host destination}
[precedence precedence] [dscp dscp]
[time-range time-range-name]
no {permit | deny} [protocol-number]
{any | source address-bitmask | host source}
{any | destination address-bitmask | host destination}
– 371 –
Chapter 10 | Access Control Lists
IPv4 ACLs
Default Setting
None
– 372 –
Chapter 10 | Access Control Lists
IPv4 ACLs
Command Mode
Extended IPv4 ACL
Command Usage
◆ All new rules are appended to the end of the list.
◆ Address bit masks are similar to a subnet mask, containing four integers from 0
to 255, each separated by a period. The binary mask uses 1 bits to indicate
“match” and 0 bits to indicate “ignore.” The bit mask is bitwise ANDed with the
specified source IP address, and then compared with the address for each IP
packet entering the port(s) to which this ACL has been assigned.
For example, use the code value and mask below to catch packets with the
following flags set:
■ SYN flag valid, use “control-code 2 2”
■ Both SYN and ACK valid, use “control-code 18 18”
■ SYN valid and ACK invalid, use “control-code 2 18”
◆ If an Extended IPv4 rule and MAC rule match the same packet, and these rules
specify a “permit” entry and “deny” entry, the “deny” action takes precedence.
Example
This example accepts any incoming packets if the source address is within subnet
10.7.1.x. For example, if the rule is matched; i.e., the rule (10.7.1.0 & 255.255.255.0)
equals the masked address (10.7.1.2 & 255.255.255.0), the packet passes through.
This allows TCP packets from class C addresses 192.168.1.0 to any destination
address when set for destination TCP port 80 (i.e., HTTP).
– 373 –
Chapter 10 | Access Control Lists
IPv4 ACLs
This permits all TCP packets from class C addresses 192.168.1.0 with the TCP control
code set to “SYN.”
Related Commands
access-list ip (370)
Time Range (166)
ip access-group This command binds an IPv4 ACL to a port. Use the no form to remove the port.
Syntax
ip access-group acl-name {in | out}
[time-range time-range-name] [counter]
no ip access-group acl-name in
acl-name – Name of the ACL. (Maximum length: 32 characters)
in – Indicates that this list applies to ingress packets.
out – Indicates that this list applies to egress packets.
time-range-name - Name of the time range. (Range: 1-32 characters)
counter – Enables counter for ACL statistics.
Default Setting
None
Command Mode
Interface Configuration (Ethernet)
Command Usage
If an ACL is already bound to a port and you bind a different ACL to it, the switch
will replace the old binding with the new one.
Example
Console(config)#int eth 1/2
Console(config-if)#ip access-group david in
Console(config-if)#
Related Commands
show ip access-list (375)
Time Range (166)
– 374 –
Chapter 10 | Access Control Lists
IPv4 ACLs
Command Mode
Privileged Exec
Example
Console#show ip access-group
Interface ethernet 1/2
IP access-list david in
Console#
show ip access-list This command displays the rules for configured IPv4 ACLs.
Syntax
show ip access-list {standard | extended} [acl-name]
standard – Specifies a standard IP ACL.
extended – Specifies an extended IP ACL.
acl-name – Name of the ACL. (Maximum length: 32 characters)
Command Mode
Privileged Exec
Example
Console#show ip access-list standard
IP standard access-list david:
permit host 10.1.1.21
permit 168.92.0.0 255.255.15.0
Console#
Related Commands
permit, deny (370)
– 375 –
Chapter 10 | Access Control Lists
IPv6 ACLs
IPv6 ACLs
The commands in this section configure ACLs based on IPv6 addresses, DSCP traffic
class, or next header type. To configure IPv6 ACLs, first create an access list
containing the required permit or deny rules, and then bind the access list to one or
more ports.
access-list ipv6 Creates an IPv6 ACL and enters configuration mode for GC
standard or extended IPv6 ACLs
permit, deny Filters packets matching a specified source IPv6 address IPv6- STD-ACL
permit, deny Filters packets meeting the specified criteria, including IPv6- EXT-ACL
source or destination IPv6 address, DSCP traffic class, or
next header type
show ipv6 access-list Displays the rules for configured IPv6 ACLs PE
access-list ipv6 This command adds an IP access list and enters configuration mode for standard or
extended IPv6 ACLs. Use the no form to remove the specified ACL.
Syntax
[no] access-list ipv6 {standard | extended} acl-name
standard – Specifies an ACL that filters packets based on the source IP
address.
extended – Specifies an ACL that filters packets based on the destination IP
address, and other more specific criteria.
acl-name – Name of the ACL. (Maximum length: 32 characters)
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ When you create a new ACL or enter configuration mode for an existing ACL,
use the permit or deny command to add new rules to the bottom of the list. To
create an ACL, you must add at least one rule to the list.
– 376 –
Chapter 10 | Access Control Lists
IPv6 ACLs
Example
Console(config)#access-list ipv6 standard david
Console(config-std-ipv6-acl)#
Related Commands
permit, deny (Standard IPv6 ACL) (377)
permit, deny (Extended IPv6 ACL) (378)
ipv6 access-group (380)
show ipv6 access-list (381)
permit, deny This command adds a rule to a Standard IPv6 ACL. The rule sets a filter condition for
(Standard IPv6 ACL) packets emanating from the specified source. Use the no form to remove a rule.
Syntax
{permit | deny} {any | host source-ipv6-address |
source-ipv6-address[/prefix-length]}
[time-range time-range-name]
no {permit | deny} {any | host source-ipv6-address |
source-ipv6-address[/prefix-length]}
any – Any source IP address.
host – Keyword followed by a specific IP address.
source-ipv6-address - An IPv6 source address or network class. The address
must be formatted according to RFC 2373 “IPv6 Addressing Architecture,”
using 8 colon-separated 16-bit hexadecimal values. One double colon may
be used in the address to indicate the appropriate number of zeros
required to fill the undefined fields.
prefix-length - A decimal value indicating how many contiguous bits (from
the left) of the address comprise the prefix; i.e., the network portion of the
address. (Range: 0-128)
time-range-name - Name of the time range. (Range: 1-32 characters)
Default Setting
None
Command Mode
Standard IPv6 ACL
Command Usage
New rules are appended to the end of the list.
– 377 –
Chapter 10 | Access Control Lists
IPv6 ACLs
Example
This example configures one permit rule for the specific address 2009:DB9:2229::79
and another rule for the addresses with the network prefix 2009:DB9:2229:5::/64.
Related Commands
access-list ipv6 (376)
Time Range (166)
permit, deny This command adds a rule to an Extended IPv6 ACL. The rule sets a filter condition
(Extended IPv6 ACL) for packets with specific source or destination IP addresses, or next header type.
Use the no form to remove a rule.
Syntax
{permit | deny} [next-header | icmp | tcp | udp]
{any | host source-ipv6-address | source-ipv6-address[/prefix-length]}
{any | destination-ipv6-address[/prefix-length]}
[next-header next-header [[source-port sport [bitmask]] | [destination-port
dport [port-bitmask]] | [time-range time-range-name] | [dscp dscp]]
[icmp-type icmp-type}
[time-range time-range-name]
[dscp dscp]
no {permit | deny} [next-header | icmp | tcp | udp]
{any | host source-ipv6-address | source-ipv6-address[/prefix-length]}
{any | destination-ipv6-address[/prefix-length]}
[next-header next-header [[source-port sport [bitmask]] | [destination-port
dport [port-bitmask]] | [time-range time-range-name] | [dscp dscp]]
[icmp-type icmp-type}
[time-range time-range-name]
[dscp dscp]
next-header - The type of header immediately following the IPv6 header.
(Range: 0-255)
icmp – Specifies the next header as ICMP.
tcp – Specifies the next header as TCP.
udp – Specifies the next header as UDP.
any – Any IP address (an abbreviation for the IPv6 prefix ::/0).
host – Keyword followed by a specific source IP address.
source-ipv6-address - An IPv6 source address or network class. The address
must be formatted according to RFC 2373 “IPv6 Addressing Architecture,”
using 8 colon-separated 16-bit hexadecimal values. One double colon may
– 378 –
Chapter 10 | Access Control Lists
IPv6 ACLs
Default Setting
None
Command Mode
Extended IPv6 ACL
Command Usage
◆ All new rules are appended to the end of the list.
– 379 –
Chapter 10 | Access Control Lists
IPv6 ACLs
Example
This example accepts any incoming packets if the destination address is
2009:DB9:2229::79/8.
This allows packets to any destination address when the DSCP value is 5.
This allows any packets sent from any source to any destination when the next
header is 43.”
Related Commands
access-list ipv6 (376)
Time Range (166)
ipv6 access-group This command binds an IPv6 ACL to a port. Use the no form to remove the port.
Syntax
ipv6 access-group acl-name {in | out}
[time-range time-range-name] [counter]
no ipv6 access-group acl-name {in | out}
acl-name – Name of the ACL. (Maximum length: 32 characters)
in – Indicates that this list applies to ingress packets.
out – Indicates that this list applies to egress packets.
time-range-name - Name of the time range. (Range: 1-32 characters)
counter – Enables counter for ACL statistics.
Default Setting
None
Command Mode
Interface Configuration (Ethernet)
– 380 –
Chapter 10 | Access Control Lists
IPv6 ACLs
Command Usage
If a port is already bound to an ACL and you bind it to a different ACL, the switch
will replace the old binding with the new one.
Example
Console(config)#interface ethernet 1/2
Console(config-if)#ipv6 access-group standard david in
Console(config-if)#
Related Commands
show ipv6 access-list (381)
Time Range (166)
show ipv6 This command shows the ports assigned to IPv6 ACLs.
access-group
Command Mode
Privileged Exec
Example
Console#show ipv6 access-group
Interface ethernet 1/2
IPv6 standard access-list david in
Console#
Related Commands
ipv6 access-group (380)
show ipv6 access-list This command displays the rules for configured IPv6 ACLs.
Syntax
show ipv6 access-list {standard | extended} [acl-name]
standard – Specifies a standard IPv6 ACL.
extended – Specifies an extended IPv6 ACL.
acl-name – Name of the ACL. (Maximum length: 32 characters)
Command Mode
Privileged Exec
Example
Console#show ipv6 access-list standard
IPv6 standard access-list david:
permit host 2009:DB9:2229::79
– 381 –
Chapter 10 | Access Control Lists
MAC ACLs
permit 2009:DB9:2229:5::/64
Console#
Related Commands
permit, deny (Standard IPv6 ACL) (377)
permit, deny (Extended IPv6 ACL) (378)
ipv6 access-group (380)
MAC ACLs
The commands in this section configure ACLs based on hardware addresses, packet
format, and Ethernet type. The ACLs can further specify optional IP and IPv6
addresses including protocol type and upper layer ports. To configure MAC ACLs,
first create an access list containing the required permit or deny rules, and then
bind the access list to one or more ports.
permit, deny Filters packets matching a specified source and destination MAC-ACL
address, packet format, and Ethernet type. They can be
further specified using optional IP and IPv6 addresses
including protocol type and upper layer ports.
show mac access-list Displays the rules for configured MAC ACLs PE
access-list mac This command enters MAC ACL configuration mode. Rules can be added to filter
packets matching a specified MAC source or destination address (i.e., physical layer
address), or Ethernet protocol type. Rules can also be used to filter packets based
on IPv4/v6 addresses, including Layer 4 ports and protocol types. Use the no form
to remove the specified ACL.
Syntax
[no] access-list mac acl-name
acl-name – Name of the ACL. (Maximum length: 32 characters,)
Default Setting
None
Command Mode
Global Configuration
– 382 –
Chapter 10 | Access Control Lists
MAC ACLs
Command Usage
◆ When you create a new ACL or enter configuration mode for an existing ACL,
use the permit or deny command to add new rules to the bottom of the list.
Example
Console(config)#access-list mac jerry
Console(config-mac-acl)#
Related Commands
permit, deny (383)
mac access-group (387)
show mac access-list (388)
permit, deny (MAC ACL) This command adds a rule to a MAC ACL. The rule filters packets matching a
specified MAC source or destination address (i.e., physical layer address), or
Ethernet protocol type. Rules can also filter packets based on IPv4/v6 addresses,
including Layer 4 ports and protocol types. Use the no form to remove a rule.
Syntax
{permit | deny}
{any | host source | source addres}
{any | host destination | destination address}
[ip {any | host source-ip | source-ip network-mask}
{any | host destination-ip | destination-ip network-mask}]
[ipv6 {any | host source-ipv6 | source-ipv6/prefix-length}
{any | host destination-ipv6 | destination-ipv6/prefix-length}]
[cos cos cos-bitmask]
[vid vid vid-bitmask]
[ethertype ethertype [ethertype-bitmask]]
[protocol protocol]
[l4-source-port sport [port-bitmask]]
[l4-destination-port dport [port-bitmask]]
[time-range time-range-name]
no {permit | deny}
{any | host source | source address}
{any | host destination | destination address}
[ip {any | host source-ip | source-ip network-mask}
{any | host destination-ip | destination-ip network-mask}]
[ipv6 {any | host source-ipv6 | source-ipv6/prefix-length}
{any | host destination-ipv6 | destination-ipv6/prefix-length}]
[cos cos cos-bitmask]
[vid vid vid-bitmask]
– 383 –
Chapter 10 | Access Control Lists
MAC ACLs
– 384 –
Chapter 10 | Access Control Lists
MAC ACLs
– 385 –
Chapter 10 | Access Control Lists
MAC ACLs
Default Setting
None
Command Mode
MAC ACL
Command Usage
◆ New rules are added to the end of the list.
◆ The ethertype option can only be used to filter Ethernet II formatted packets.
◆ A detailed listing of Ethernet protocol types can be found in RFC 1060. A few of
the more common types include the following:
■ 0800 - IP
■ 0806 - ARP
■ 8137 - IPX
◆ If an Extended IPv4 rule and MAC rule match the same packet, and these rules
specify a “permit” entry and “deny” entry, the “deny” action takes precedence.
Example
This rule permits packets from any source MAC address to the destination address
00-e0-29-94-34-de where the Ethernet type is 0800.
Related Commands
access-list mac (382)
Time Range (166)
6. For all bitmasks, “1” means relevant and “0” means ignore.
7. Includes TCP, UDP or other protocol types.
– 386 –
Chapter 10 | Access Control Lists
MAC ACLs
mac access-group This command binds a MAC ACL to a port. Use the no form to remove the port.
Syntax
mac access-group acl-name {in | out}
[time-range time-range-name] [counter]
no mac access-group acl-name {in | out}
acl-name – Name of the ACL. (Maximum length: 32 characters)
in – Indicates that this list applies to ingress packets.
out – Indicates that this list applies to egress packets.
time-range-name - Name of the time range. (Range: 1-32 characters)
counter – Enables counter for ACL statistics.
Default Setting
None
Command Mode
Interface Configuration (Ethernet)
Command Usage
If an ACL is already bound to a port and you bind a different ACL to it, the switch
will replace the old binding with the new one.
Example
Console(config)#interface ethernet 1/2
Console(config-if)#mac access-group jerry in
Console(config-if)#
Related Commands
show mac access-list (388)
Time Range (166)
show mac This command shows the ports assigned to MAC ACLs.
access-group
Command Mode
Privileged Exec
Example
Console#show mac access-group
Interface ethernet 1/5
MAC access-list M5 in
Console#
– 387 –
Chapter 10 | Access Control Lists
ARP ACLs
Related Commands
mac access-group (387)
show mac access-list This command displays the rules for configured MAC ACLs.
Syntax
show mac access-list [acl-name]
acl-name – Name of the ACL. (Maximum length: 32 characters)
Command Mode
Privileged Exec
Example
Console#show mac access-list
MAC access-list jerry:
permit any 00-e0-29-94-34-de ethertype 0800
Console#
Related Commands
permit, deny (383)
mac access-group (387)
ARP ACLs
The commands in this section configure ACLs based on the IP or MAC address
contained in ARP request and reply messages. To configure ARP ACLs, first create an
access list containing the required permit or deny rules, and then bind the access
list to one or more VLANs using the ip arp inspection vlan command.
show access-list arp Displays the rules for configured ARP ACLs PE
access-list arp This command adds an ARP access list and enters ARP ACL configuration mode. Use
the no form to remove the specified ACL.
Syntax
[no] access-list arp acl-name
– 388 –
Chapter 10 | Access Control Lists
ARP ACLs
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ When you create a new ACL or enter configuration mode for an existing ACL,
use the permit or deny command to add new rules to the bottom of the list. To
create an ACL, you must add at least one rule to the list.
Example
Console(config)#access-list arp factory
Console(config-arp-acl)#
Related Commands
permit, deny (389)
show access-list arp (390)
permit, deny (ARP ACL) This command adds a rule to an ARP ACL. The rule filters packets matching a
specified source or destination address in ARP messages. Use the no form to
remove a rule.
Syntax
[no] {permit | deny}
ip {any | host source-ip | source-ip ip-address-bitmask}
{any | host destination-ip | destination-ip ip-address-bitmask}
mac {any | host source-mac | source-mac mac-address-bitmask}
[any | host destination-mac | destination-mac mac-address-bitmask] [log]
– 389 –
Chapter 10 | Access Control Lists
ARP ACLs
Default Setting
None
Command Mode
ARP ACL
Command Usage
New rules are added to the end of the list.
Example
This rule permits packets from any source IP and MAC address to the destination
subnet address 192.168.0.0.
Related Commands
access-list arp (388)
show access-list arp This command displays the rules for configured ARP ACLs.
Syntax
show access-list arp [acl-name]
acl-name – Name of the ACL. (Maximum length: 32 characters)
Command Mode
Privileged Exec
8. For all bitmasks, binary “1” means relevant and “0” means ignore.
– 390 –
Chapter 10 | Access Control Lists
ACL Information
Example
Console#show access-list arp
ARP access-list factory:
permit response ip any 192.168.0.0 255.255.0.0 mac any any
Console#
Related Commands
permit, deny (389)
ACL Information
This section describes commands used to display ACL information.
clear access-list Clears hit counter for rules in all ACLs, or in a specified ACL PE
hardware counters
clear access-list This command clears the hit counter for the rules in all ACLs, or for the rules in a
hardware counters specified ACL.
Syntax
clear access-list hardware counters
[direction in [interface interface]] |
[interface interface] | [name acl-name[direction in]]
in – Clears counter for ingress rules.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
acl-name – Name of the ACL. (Maximum length: 32 characters)
Command Mode
Privileged Exec
Example
Console#clear access-list hardware counters
Console#
– 391 –
Chapter 10 | Access Control Lists
ACL Information
Command Mode
Privileged Executive
Example
Console#show access-group
Interface ethernet 1/1
IP access-list ex1 in
IP access-list ex1 out
Interface ethernet 1/2
IPv6 access-list i6ex in
IPv6 access-list i6ex out
Console#
show access-list This command shows all ACLs and associated rules.
Syntax
show access-list
[[arp [acl-name]] |
[ip [extended [acl-name] | standard [acl-name]] |
[ipv6 [extended [acl-name] | standard [acl-name]] |
[mac [acl-name]] | [tcam-utilization] | [hardware counters]]
arp – Shows ingress or egress rules for ARP ACLs.
hardware counters – Shows statistics for all ACLs.9
ip extended – Shows ingress or egress rules for Extended IPv4 ACLs.
ip standard – Shows ingress or egress rules for Standard IPv4 ACLs.
ipv6 extended – Shows ingress or egress rules for Extended IPv6 ACLs.
ipv6 standard – Shows ingress or egress rules for Standard IPv6 ACLs.
mac – Shows ingress or egress rules for MAC ACLs.
tcam-utilization – Shows the percentage of user configured ACL rules as a
percentage of total ACL rules
acl-name – Name of the ACL. (Maximum length: 32 characters)
Command Mode
Privileged Exec
Example
Console#show access-list
IP standard access-list david:
permit host 10.1.1.21
permit 168.92.0.0 255.255.15.0
IP extended access-list bob:
9. Due to a hardware limitation, this option only displays statistics for permit rules.
– 392 –
Chapter 10 | Access Control Lists
ACL Information
– 393 –
Chapter 10 | Access Control Lists
ACL Information
– 394 –
11 Interface Commands
Interface Configuration
show discard Displays if CDP and PVST packets are being discarded PE
show interfaces counters Displays statistics for the specified interfaces NE, PE
show interfaces history Displays periodic sampling of statistics, including the NE, PE
sampling interval, number of samples, and counter values
show interfaces status Displays status for the specified interface NE, PE
show interfaces switchport Displays the administrative and operational status of an NE, PE
interface
– 395 –
Chapter 11 | Interface Commands
show interfaces transceiver Displays the temperature, voltage, bias current, transmit PE
power, and receive power
Cable Diagnostics
Power Savings
– 396 –
Chapter 11 | Interface Commands
Interface Configuration
interface This command configures an interface type and enters interface configuration
mode. Use the no form with a trunk to remove an inactive interface. Use the no
form with a Layer 3 VLAN (normal type) to change it back to a Layer 2 interface.
Syntax
interface interface
no interface interface [port-channel channel-id | vlan vlan-id]
interface
ethernet unit/port-list
unit - Unit identifier. (Range: 1)
port-list - Physical port number or list of port numbers. Separate
nonconsecutive port numbers with a comma and no spaces; or use
a hyphen to designate a range of port numbers. (Range: 1-28)
port-channel channel-id (Range: 1-28)
vlan vlan-id (Range: 1-4094)
Default Setting
None
Command Mode
Global Configuration
Example
To specify several different ports, enter the following command:
– 397 –
Chapter 11 | Interface Commands
capabilities This command advertises the port capabilities of a given interface during auto-
negotiation. Use the no form with parameters to remove an advertised capability,
or the no form without parameters to restore the default values.
Syntax
[no] capabilities {1000full | 100full | 100half | 10full | 10half | flowcontrol}
1000full - Supports 1 Gbps full-duplex operation
100full - Supports 100 Mbps full-duplex operation
100half - Supports 100 Mbps half-duplex operation
10full - Supports 10 Mbps full-duplex operation
10half - Supports 10 Mbps half-duplex operation
flowcontrol - Supports flow control
Default Setting
1000BASE-T: 10half, 10full, 100half, 100full, 1000full
1000BASE (SFP): 1000full
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ When auto-negotiation is enabled with the negotiation command, the switch
will negotiate the best settings for a link based on the capabilities command.
When auto-negotiation is disabled, you must manually specify the link
attributes with the speed-duplex and flowcontrol commands.
Example
The following example configures Ethernet port 5 capabilities to include 100half
and 100full.
Related Commands
negotiation (402)
speed-duplex (403)
flowcontrol (400)
– 398 –
Chapter 11 | Interface Commands
description This command adds a description to an interface. Use the no form to remove the
description.
Syntax
description string
no description
string - Comment or a description to help you remember what is attached
to this interface. (Range: 1-64 characters)
Default Setting
None
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
The description is displayed by the show interfaces status command and in the
running-configuration file. An example of the value which a network manager
might store in this object is the name of the manufacturer, and the product name.
Example
The following example adds a description to port 4.
discard This command discards CDP or PVST packets. Use the no form to forward the
specified packet type to other ports configured the same way.
Syntax
[no] discard {cdp | pvst}
cdp – Cisco Discovery Protocol
pvst – Per-VLAN Spanning Tree
Default Setting
Default - Forward CDP and PVST packets
Command Mode
Interface Configuration (Ethernet)
– 399 –
Chapter 11 | Interface Commands
Command Usage
Use the no discard command to allow CDP or PVST packets to be forwarded to
other ports in the same VLAN which are also configured to forward the specified
packet type.
Example
The following example forwards CDP packets entering port 5.
flowcontrol This command enables flow control. Use the no form to disable flow control.
Syntax
[no] flowcontrol
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
Flow control can eliminate frame loss by “blocking” traffic from end stations or
segments connected directly to the switch when its buffers fill. When enabled, back
pressure is used for half-duplex operation and IEEE 802.3-2002 (formally IEEE
802.3x) for full-duplex operation.
Example
The following example enables flow control on port 5.
– 400 –
Chapter 11 | Interface Commands
history This command configures a periodic sampling of statistics, specifying the sampling
interval and number of samples. Use the no form to remove a named entry from
the sampling table.
Syntax
history name interval buckets
no history [name]
name - A symbolic name for this entry in the sampling table. (Range: 1-31
characters)
interval - The interval for sampling statistics. (Range: 1-86400 seconds.
buckets - The number of samples to take. (Range: 1-96)
Default Setting
15min - 15 minute interval, 96 buckets
1day - 1 day interval, 7 buckets
Command Mode
Interface Configuration (Ethernet, Port Channel)
Example
This example sets a interval of 15 minutes for sampling standard statistical values
on port 1.
media-type This command forces the transceiver mode to use for SFP+ ports. Use the no form
to restore the default mode.
Syntax
media-type sfp-forced [mode]
no media-type
sfp-forced - Forces transceiver mode for the SFP/SFP+ port.
mode
1000sfp - Always uses 1000BASE SFP mode.
10gsfp - Always uses 10GBASE SFP mode.
Default Setting
SFP/SFP+ ports: None
– 401 –
Chapter 11 | Interface Commands
Command Mode
Interface Configuration (Ethernet)
Command Usage
Available sfp-forced modes include: 1000sfp, 10gsfp
Example
This forces the switch to use the 1000sfp mode for SFP port 8.
negotiation This command enables auto-negotiation for a given interface. Use the no form to
disable auto-negotiation.
Syntax
[no] negotiation
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ 1000BASE-T does not support forced mode. Auto-negotiation should always be
used to establish a connection over any 1000BASE-T port or trunk.
◆ When auto-negotiation is enabled the switch will negotiate the best settings
for a link based on the capabilities command. When auto-negotiation is
disabled, you must manually specify the link attributes with the speed-duplex
and flowcontrol commands.
Example
The following example configures port 10 to use auto-negotiation.
Related Commands
capabilities (398)
speed-duplex (403)
– 402 –
Chapter 11 | Interface Commands
shutdown This command disables an interface. To restart a disabled interface, use the no
form.
Syntax
[no] shutdown
Default Setting
All interfaces are enabled.
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
This command allows you to disable a port due to abnormal behavior
(e.g., excessive collisions), and then re-enable it after the problem has been
resolved. You may also want to disable a port for security reasons.
Example
The following example disables port 5.
speed-duplex This command configures the speed and duplex mode of a given interface when
auto-negotiation is disabled. Use the no form to restore the default.
Syntax
speed-duplex {100full | 100half | 10full | 10half }
no speed-duplex
100full - Forces 100 Mbps full-duplex operation
100half - Forces 100 Mbps half-duplex operation
10full - Forces 10 Mbps full-duplex operation
10half - Forces 10 Mbps half-duplex operation
Default Setting
◆ Auto-negotiation is enabled by default.
Command Mode
Interface Configuration (Ethernet, Port Channel)
– 403 –
Chapter 11 | Interface Commands
Command Usage
◆ The 1000BASE-T standard does not support forced mode. Auto-negotiation
should always be used to establish a connection over any 1000BASE-T port or
trunk. If not used, the success of the link process cannot be guaranteed when
connecting to other types of switches.
Example
The following example configures port 5 to 100 Mbps, half-duplex operation.
Syntax
clear counters interface
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
Command Usage
Statistics are only initialized for a power reset. This command sets the base value for
displayed statistics to zero for the current management session. However, if you log
out and back into the management interface, the statistics displayed will show the
absolute value accumulated since the last power reset.
Example
The following example clears statistics on port 5.
– 404 –
Chapter 11 | Interface Commands
show discard This command displays whether or not CDP and PVST packets are being discarded.
Command Mode
Privileged Exec
Example
In this example, “Default” means that the packets are not discarded.
Console#show discard
Port CDP PVST
-------- ------- -------
Eth 1/ 1 No No
Eth 1/ 2 No No
Eth 1/ 3 No No
Eth 1/ 4 No No
Eth 1/ 5 No No
Eth 1/ 6 No
. No
.
.
show interfaces brief This command displays a summary of key information, including operational
status, native VLAN ID, default priority, speed/duplex mode, and port type for all
ports.
Command Mode
Privileged Exec
Command Usage
◆ If an SFP transceiver is inserted in a port, the Type field will show the SFP type
as interpreted from Ethernet Compliance Codes (Data Byte 6 in Address A0h).
The Ethernet Compliance Code is a bitmap value, of which one bit is
supposedly turned on. However, if the read-out is not recognizable (e.g., 2 or
more bits on, or all 0s), the Type field just displays the raw data (hexadecimal
value).
Example
Console#show interfaces brief
Interface Name Status PVID Pri Speed/Duplex Type Trunk
--------- --------------- --------- ---- --- ------------- ------------ -----
Eth 1/ 1 Up 1 0 Auto-1000full 1000BASE-T None
Eth 1/ 2 License 1 0 Auto 1000BASE-T None
Eth 1/ 3 License 1 0 Auto 1000BASE-T None
Eth 1/ 4 License 1 0 Auto 1000BASE-T None
Eth 1/ 5 License 1 0 Auto 1000BASE-T None
Eth 1/ 6 License 1 0 Auto 1000BASE-T None
.
– 405 –
Chapter 11 | Interface Commands
.
.
Default Setting
Shows the counters for all interfaces.
Command Mode
Normal Exec, Privileged Exec
Command Usage
If no interface is specified, information on all interfaces is displayed.
Example
Console#show interfaces counters ethernet 1/1
Ethernet 1/ 1
===== IF table Stats =====
2166458 Octets Input
14734059 Octets Output
14707 Unicast Input
19806 Unicast Output
0 Discard Input
0 Discard Output
0 Error Input
0 Error Output
===== Extended Iftable Stats =====
23 Multi-cast Input
5525 Multi-cast Output
170 Broadcast Input
11 Broadcast Output
===== Ether-like Stats =====
0 FCS Errors
0 Single Collision Frames
0 Multiple Collision Frames
0 Deferred Transmissions
0 Late Collisions
0 Excessive Collisions
0 Internal Mac Transmit Errors
0 Frames Too Long
0 Symbol Errors
– 406 –
Chapter 11 | Interface Commands
IF Table Stats
Octets Input The total number of octets received on the interface, including framing
characters.
Octets Output The total number of octets transmitted out of the interface, including
framing characters.
Unicast Output The total number of packets that higher-level protocols requested be
transmitted to a subnetwork-unicast address, including those that
were discarded or not sent.
Discard Input The number of inbound packets which were chosen to be discarded
even though no errors had been detected to prevent their being
deliverable to a higher-layer protocol. One possible reason for
discarding such a packet could be to free up buffer space.
Discard Output The number of outbound packets which were chosen to be discarded
even though no errors had been detected to prevent their being
transmitted. One possible reason for discarding such a packet could be
to free up buffer space.
Error Input The number of inbound packets that contained errors preventing them
from being deliverable to a higher-layer protocol.
Error Output The number of outbound packets that could not be transmitted
because of errors.
– 407 –
Chapter 11 | Interface Commands
Multicast Input The number of packets, delivered by this sub-layer to a higher (sub-
)layer, which were addressed to a multicast address at this sub-layer.
Multicast Output The total number of packets that higher-level protocols requested be
transmitted, and which were addressed to a multicast address at this
sub-layer, including those that were discarded or not sent.
Broadcast Input The number of packets, delivered by this sub-layer to a higher (sub-
)layer, which were addressed to a broadcast address at this sub-layer.
Broadcast Output The total number of packets that higher-level protocols requested be
transmitted, and which were addressed to a broadcast address at this
sub-layer, including those that were discarded or not sent.
Etherlike Statistics
FCS Errors A count of frames received on a particular interface that are an integral
number of octets in length but do not pass the FCS check. This count
does not include frames received with frame-too-long or frame-too-
short error.
Single Collision Frames The number of successfully transmitted frames for which transmission
is inhibited by exactly one collision.
Multiple Collision Frames A count of successfully transmitted frames for which transmission is
inhibited by more than one collision.
Deferred Transmissions A count of frames for which the first transmission attempt on a
particular interface is delayed because the medium was busy.
Late Collisions The number of times that a collision is detected later than 512 bit-times
into the transmission of a packet.
Excessive Collisions A count of frames for which transmission on a particular interface fails
due to excessive collisions. This counter does not increment when the
interface is operating in full-duplex mode.
Internal MAC Transmit A count of frames for which transmission on a particular interface fails
Errors due to an internal MAC sublayer transmit error.
Frames Too Long A count of frames received on a particular interface that exceed the
maximum permitted frame size.
Symbol Errors For an interface operating at 100 Mb/s, the number of times there was
an invalid data symbol when a valid carrier was present.
For an interface operating in half-duplex mode at 1000 Mb/s, the
number of times the receiving media is non-idle (a carrier event) for a
period of time equal to or greater than slotTime, and during which
there was at least one occurrence of an event that causes the PHY to
indicate
'Data reception error' or 'carrier extend error' on the GMII.
For an interface operating in full-duplex mode at 1000 Mb/s, the
number of times the receiving media is non-idle (a carrier event) for a
period of time equal to or greater than minFrameSize, and during
which there was at least one occurrence of an event that causes the
PHY to indicate 'Data reception error' on the GMII
Pause Frames Output Count of pause frames transmitted from the interface.
RMON Statistics
Octets Total number of octets of data received on the network. This statistic
can be used as a reasonable indication of Ethernet utilization.
– 408 –
Chapter 11 | Interface Commands
Packets The total number of packets (bad, broadcast and multicast) received.
Broadcast Packets The total number of good packets received that were directed to the
broadcast address. Note that this does not include multicast packets.
Multicast Packets The total number of good packets received that were directed to this
multicast address.
Undersize Packets The total number of packets received that were less than 64 octets long
(excluding framing bits, but including FCS octets) and were otherwise
well formed.
Oversize Packets The total number of packets received that were longer than 1518 octets
(excluding framing bits, but including FCS octets) and were otherwise
well formed.
Fragments The total number of frames received that were less than 64 octets in
length (excluding framing bits, but including FCS octets) and had either
an FCS or alignment error.
Jabbers The total number of frames received that were longer than 1518 octets
(excluding framing bits, but including FCS octets), and had either an
FCS or alignment error.
Collisions The best estimate of the total number of collisions on this Ethernet
segment.
Packet Size <= 64 Octets The total number of packets (including bad packets) received and
transmitted that were less than 64 octets in length (excluding framing
bits but including FCS octets).
Packet Size 65 to 127 Octets The total number of packets (including bad packets) received and
Packet Size 128 to 255 transmitted where the number of octets fall within the specified range
Octets (excluding framing bits but including FCS octets).
Packet Size 256 to 511
Octets
Packet Size 512 to 1023
Octets
Packet Size 1024 to 1518
Octets
Utilization Statistics
Octets input in kbits per Number of octets entering this interface in kbits per second.
second
Packets input per second Number of packets entering this interface in packets per second.
Octets output in kbits per Number of octets leaving this interface in kbits per second.
second
Packets output per second Number of packets leaving this interface in packets per second.
– 409 –
Chapter 11 | Interface Commands
show interfaces This command displays periodic sampling of statistics, including the sampling
history interval, number of samples, and counter values.
Syntax
show interfaces history [interface [name [current | previous index count]
[input | output]]]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
vlan vlan-id (Range: 1-4094)
name - Name of sample as defined in the history command.
(Range: 1-31 characters)
current - Statistics recorded in current interval.
previous - Statistics recorded in previous intervals.
index - An index into the buckets containing previous samples.
(Range: 1-96)
count - The number of historical samples to display. (Range: 1-96)
input - Ingress traffic.
output - Egress traffic.
Default Setting
Shows the historical settings and status for all interfaces.
Command Mode
Normal Exec, Privileged Exec
Command Usage
If no interface is specified, information on all interfaces is displayed.
Example
Console#show interfaces history ethernet 1/1 15min
Interface : Eth 1/ 1
Name : 15min
Interval : 900 second(s)
Buckets Requested : 96
Buckets Granted : 17
Status : Active
Current Entries
– 410 –
Chapter 11 | Interface Commands
Errors
-------------
0
Discards Errors
------------- -------------
0 0
Previous Entries
Console#
– 411 –
Chapter 11 | Interface Commands
show interfaces status This command displays the status for an interface.
Syntax
show interfaces status [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
vlan vlan-id (Range: 1-4094)
Default Setting
Shows the status for all interfaces.
Command Mode
Normal Exec, Privileged Exec
Command Usage
If no interface is specified, information on all interfaces is displayed.
Example
Console#show interfaces status ethernet 1/1
Information of Eth 1/1
Basic Information:
Port Type : 1000BASE-T
MAC Address : 90-3C-B3-8C-44-B3
Configuration:
Name :
Port Admin : Up
Speed-duplex : Auto
Capabilities : 10half, 10full, 100half, 100full, 1000full
Broadcast Storm : Disabled
Broadcast Storm Limit : 500 packets/second
Multicast Storm : Disabled
Multicast Storm Limit : 500 packets/second
Unknown Unicast Storm : Disabled
Unknown Unicast Storm Limit : 500 packets/second
Flow Control : Disabled
VLAN Trunking : Disabled
LACP : Disabled
MAC Learning : Enabled
Media Type : None
Current Status:
Link Status : Up
Port Operation Status : Up
Operation Speed-duplex : 1000full
Up Time : 0w 0d 7h 27m 37s (26857 seconds)
Flow Control Type : None
Max Frame Size : 1518 bytes (1522 bytes for tagged frames)
MAC Learning Status : Enabled
Console#
– 412 –
Chapter 11 | Interface Commands
show interfaces This command displays the administrative and operational status of the specified
switchport interfaces.
Syntax
show interfaces switchport [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
Shows all interfaces.
Command Mode
Normal Exec, Privileged Exec
Command Usage
If no interface is specified, information on all interfaces is displayed.
Example
This example shows the configuration setting for port 1.
– 413 –
Chapter 11 | Interface Commands
Multicast Threshold Shows if multicast storm suppression is enabled or disabled; if enabled it also
shows the threshold level (page 453).
Unknown Unicast Shows if unknown unicast storm suppression is enabled or disabled; if enabled
Threshold it also shows the threshold level (page 453).
LACP Status Shows if Link Aggregation Control Protocol has been enabled or disabled
(page 430).
Ingress/Egress Rate Shows if rate limiting is enabled, and the current rate limit (page 451).
Limit
Acceptable Frame Shows if acceptable VLAN frames include all types or tagged frames only
Type (page 535).
Priority for Indicates the default priority for untagged frames (page 610).
Untagged Traffic
GVRP Status Shows if GARP VLAN Registration Protocol is enabled or disabled (page 529).
Allowed VLAN Shows the VLANs this interface has joined, where “(u)” indicates untagged and
“(t)” indicates tagged (page 535).
Allowed VLAN Shows the VLANs this interface has joined, where “(u)” indicates untagged and
“(t)” indicates tagged (page 535).
Forbidden VLAN Shows the VLANs this interface can not join (page 528).
802.1Q-tunnel Shows the tunnel mode as Normal, 802.1Q Tunnel or 802.1Q Tunnel Uplink
Mode (page 544).
802.1Q-tunnel TPID Shows the Tag Protocol Identifier used for learning and switching packets
(page 544).
– 414 –
Chapter 11 | Interface Commands
transceiver-monitor This command sends a trap when any of the transceiver’s operational values fall
outside of specified thresholds. Use the no form to disable trap messages.
Syntax
[no] transceiver-monitor
Default Setting
Disabled
Command Mode
Interface Configuration
Example
Console(config)interface ethernet 1/1
Console(config-if)#transceiver-monitor
Console#
transceiver-threshold- This command uses default threshold settings obtained from the transceiver to
auto determine when an alarm or warning message should be sent. Use the no form to
disable this feature.
Syntax
[no ] transceiver-threshold-auto
Default Setting
Enabled
Command Mode
Interface Configuration
Example
Console(config)interface ethernet 1/12
Console(config-if)#transceiver-threshold-auto
Console#
– 415 –
Chapter 11 | Interface Commands
transceiver-threshold This command sets thresholds for transceiver current which can be used to trigger
current an alarm or warning message. Use the no form to restore the default settings.
Syntax
transceiver-threshold current {high-alarm | high-warning | low-alarm |
low-warning} threshold-value
high-alarm – Sets the high current threshold for an alarm message.
high-warning – Sets the high current threshold for a warning message.
low-alarm – Sets the low current threshold for an alarm message.
low-warning – Sets the low current threshold for a warning message.
threshold-value – The threshold of the transceiver current.
(Range: 0-13100 in units of 0.01 mA)
Default Setting
Low Alarm: 6 mA
High Alarm: 100 mA
Low Warning: 7 mA
HIgh Warning: 90 mA
Command Mode
Interface Configuration
Command Usage
◆ If trap messages are enabled with the transceiver-monitor command, and a
high-threshold alarm or warning message is sent if the current value is greater
than or equal to the threshold, and the last sample value was less than the
threshold. After a rising event has been generated, another such event will not
be generated until the sampled value has fallen below the high threshold and
reaches the low threshold.
– 416 –
Chapter 11 | Interface Commands
Example
The following example sets alarm thresholds for the transceiver current at port 9.
transceiver-threshold This command sets thresholds for the transceiver power level of the received signal
rx-power which can be used to trigger an alarm or warning message. Use the no form to
restore the default settings.
Syntax
transceiver-threshold rx-power {high-alarm | high-warning | low-alarm |
low-warning} threshold-value
no transceiver-threshold rx-power
high-alarm – Sets the high power threshold for an alarm message.
high-warning – Sets the high power threshold for a warning message.
low-alarm – Sets the low power threshold for an alarm message.
low-warning – Sets the low power threshold for a warning message.
threshold-value – The power threshold of the received signal.
(Range: -4000 - 820 in units of 0.01 dBm)
Default Setting
Low Warning: -21.00 dBm
HIgh Warning: -3.50 dBm
Low Alarm: -21.50 dBm
High Alarm: -3.00 dBm
Command Mode
Interface Configuration
Command Usage
◆ The threshold value is the power ratio in decibels (dB) of the measured power
referenced to one milliwatt (mW).
– 417 –
Chapter 11 | Interface Commands
Example
The following example sets alarm thresholds for the signal power received at port
1.
transceiver-threshold This command sets thresholds for the transceiver temperature which can be used
temperature to trigger an alarm or warning message. Use the no form to restore the default
settings.
Syntax
transceiver-threshold temperature {high-alarm | high-warning | low-alarm
| low-warning} threshold-value
no transceiver-threshold temperature
high-alarm – Sets the high temperature threshold for an alarm message.
high-warning – Sets the high temperature threshold for a warning
message.
low-alarm – Sets the low temperature threshold for an alarm message.
low-warning – Sets the low temperature threshold for a warning message.
threshold-value – The threshold of the transceiver temperature.
(Range: -12800 - 12800 in units of 0.01 Celsius)
Default Setting
Low Warning: 0.00 C
HIgh Warning: 70.00 C
Low Alarm: -123.00 C
High Alarm: 75.00 C
Command Mode
Interface Configuration
Command Usage
◆ Refer to the Command Usage section under the transceiver-threshold current
command for more information on configuring transceiver thresholds.
– 418 –
Chapter 11 | Interface Commands
Example
The following example sets alarm thresholds for the transceiver temperature at
port 1.
transceiver-threshold This command sets thresholds for the transceiver power level of the transmitted
tx-power signal which can be used to trigger an alarm or warning message. Use the no form
to restore the default settings.
Syntax
transceiver-threshold tx-power {high-alarm | high-warning | low-alarm |
low-warning} threshold-value
no transceiver-threshold tx-power
high-alarm – Sets the high power threshold for an alarm message.
high-warning – Sets the high power threshold for a warning message.
low-alarm – Sets the low power threshold for an alarm message.
low-warning – Sets the low power threshold for a warning message.
threshold-value – The power threshold of the transmitted signal.
(Range: -4000 - 820 in units of 0.01 dBm)
Default Setting
Low Warning: -11.50 dBm
HIgh Warning: -9.50 dBm
Low Alarm: -12.00 dBm
High Alarm: -9.00 dBm
Command Mode
Interface Configuration
Command Usage
◆ The threshold value is the power ratio in decibels (dB) of the measured power
referenced to one milliwatt (mW).
– 419 –
Chapter 11 | Interface Commands
Example
The following example sets alarm thresholds for the signal power transmitted at
port 9.
transceiver-threshold This command sets thresholds for the transceiver voltage which can be used to
voltage trigger an alarm or warning message. Use the no form to restore the default
settings.
Syntax
transceiver-threshold voltage {high-alarm | high-warning | low-alarm |
low-warning} threshold-value
no transceiver-threshold voltage
high-alarm – Sets the high voltage threshold for an alarm message.
high-warning – Sets the high voltage threshold for a warning message.
low-alarm – Sets the low voltage threshold for an alarm message.
low-warning – Sets the low voltage threshold for a warning message.
threshold-value – The threshold of the transceiver voltage.
(Range: 0-655 in units of 0.01 Volt)
Default Setting
Low Warning: 3.15 Volts
HIgh Warning: 3.45 Volts
Low Alarm: 3.10 Volts
High Alarm: 3.50 Volts
Command Mode
Interface Configuration
Command Usage
◆ Refer to the Command Usage section under the transceiver-threshold current
command for more information on configuring transceiver thresholds.
– 420 –
Chapter 11 | Interface Commands
Example
The following example sets alarm thresholds for the transceiver voltage at port 9.
show interfaces This command displays identifying information for the specified transceiver,
transceiver including connector type and vendor-related parameters, as well as the
temperature, voltage, bias current, transmit power, and receive power.
Syntax
show interfaces transceiver [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Default Setting
Shows all interfaces.
Command Mode
Privileged Exec
Command Usage
The switch can display diagnostic information for SFP modules which support the
SFF-8472 Specification for Diagnostic Monitoring Interface for Optical Transceivers.
This information allows administrators to remotely diagnose problems with optical
devices. This feature, referred to as Digital Diagnostic Monitoring (DDM) in the
command display, provides information on transceiver parameters including
temperature, supply voltage, laser bias current, laser power, and received optical
power, and related alarm thresholds.
Example
Console#show interfaces transceiver ethernet 1/8
Information of Eth 1/8
Connector Type : LC
Fiber Type : [0x00]
Eth Compliance Codes : 1000BASE-ZX
Baud Rate : 1300 MBd
Vendor OUI : 00-00-5F
Vendor Name : SumitomoElectric
Vendor PN : SCP6G94-FN-BWH
Vendor Rev : Z
Vendor SN : SE08T712Z00006
Date Code : 10-09-14
– 421 –
Chapter 11 | Interface Commands
DDM Information
Temperature : 35.64 degree C
Vcc : 3.25 V
Bias Current : 12.13 mA
TX Power : 2.36 dBm
RX Power : -24.20 dBm
DDM Thresholds
Low Alarm Low Warning High Warning High Alarm
----------- ------------ ------------ ------------ ------------
Temperature(Celsius) -45.00 -40.00 85.00 90.00
Voltage(Volts) 2.90 3.00 3.60 3.70
Current(mA) 1.00 3.00 50.00 60.00
TxPower(dBm) -11.50 -10.50 -2.00 -1.00
RxPower(dBm) -23.98 -23.01 -1.00 0.00
Console#
show interfaces This command Displays the alarm/warning thresholds for temperature, voltage,
transceiver-threshold bias current, transmit power, and receive power.
Syntax
show interfaces transceiver-threshold [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Default Setting
Shows all interfaces.
Command Mode
Privileged Exec
Command Usage
◆ The switch can display diagnostic information for SFP modules which support
the SFF-8472 Specification for Diagnostic Monitoring Interface for Optical
Transceivers. This information allows administrators to remotely diagnose
problems with optical devices. This feature, referred to as Digital Diagnostic
Monitoring (DDM) in the command display, provides information on
transceiver parameters including temperature, supply voltage, laser bias
current, laser power, received optical power, and related alarm thresholds.
◆ The DDM thresholds displayed by this command only apply to ports which
have a DDM-compliant transceiver inserted.
Example
Console#show interfaces transceiver-threshold ethernet 1/5
Information of Eth 1/5
DDM Thresholds
Transceiver-monitor : Disabled
Transceiver-threshold-auto : Enabled
– 422 –
Chapter 11 | Interface Commands
Cable Diagnostics
test cable-diagnostics This command performs cable diagnostics on the specified port to diagnose any
cable faults (short, open, etc.) and report the cable length.
Syntax
test cable-diagnostics interface interface
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Command Usage
◆ Cable diagnostics are performed using an internal Digital Signal Processing test
process when the port link-up speed is 1 Gbps. The method analyses the cable
by sending a pulsed signal into the cable, and then examining the reflection of
that pulse. If the port link-up speed is not 1 Gbps, then Time Domain
Reflectometry (TDR) test method is used. TDR also detects a cable fault by
sending a signal through the cable and reading the signal that is reflected back.
However, note that TDR can only determine if a link is valid or faulty.
◆ This cable test is only accurate for Ethernet cables 7 - 100 meters long.
– 423 –
Chapter 11 | Interface Commands
Example
Console#test cable-diagnostics interface ethernet 1/24
Console#
Command Mode
Privileged Exec
Command Usage
◆ The results include common cable failures, as well as the status and
approximate distance to a fault, or the approximate cable length if no fault is
found.
◆ For link-down ports, the reported distance to a fault is accurate to within +/- 2
meters. For link-up ports, the accuracy is +/- 10 meters.
◆ Potential conditions which may be listed by the diagnostics are shown by the
legend in the following example. Additional information is provided for the
following test results.
■ OK: Correctly terminated pair
■ ON: Open pair, no link partner
■ IE (Impedance mismatch): Terminating impedance is not in the reference
range.
■ NS (Not Supported): This message is displayed for any Gigabit Ethernet
ports linked up at a speed lower than 1000 Mbps.
■ UN: Unknown Error
Example
Console#show cable-diagnostics interface ethernet 1/7
TF: Test failed
OK: OK
ON: Open
ST: Short
IE: Impedance error
NC: No cable
NT: Not tested
NS: Not supported
– 424 –
Chapter 11 | Interface Commands
UN: Unknown
Port Type Link Pair A Pair B Pair C Pair D Last
Status meters meters meters meters Updated
-------- ---- -------- -------- -------- -------- -------- -----------------
Eth 1/ 7 GE Up OK (8) OK (8) OK (8) OK (8) 2019-07-16 11:54:24
Console#
Power Savings
power-save This command enables power savings mode on the specified port. Use the no form
to disable this feature.
Syntax
[no] power-save
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet ports 1-28)
Command Usage
◆ Power saving mode only applies to the Ethernet ports using copper media.
– 425 –
Chapter 11 | Interface Commands
Note: Power savings can only be implemented on Ethernet ports using twisted-
pair cabling. Power-savings mode on a active link only works when connection
speed is 1/10 Gbps, and line length is less than 60 meters.
Example
Console(config)#interface ethernet 1/24
Console(config-if)#power-save
Console(config-if)#
show power-save This command shows the configuration settings for power savings.
Syntax
show power-save [interface interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show power-save interface ethernet 1/24
Power Saving Status:
Ethernet 1/24 : Enabled
Console#
10. The percentage reduction is for the switch hardware interface internal component only.
– 426 –
12 Link Aggregation Commands
Ports can be statically grouped into an aggregate link (i.e., trunk) to increase the
bandwidth of a network connection or to ensure fault recovery. Or you can use the
Link Aggregation Control Protocol (LACP) to automatically negotiate a trunk link
between this switch and another network device. For static trunks, the switches
have to comply with the Cisco EtherChannel standard. For dynamic trunks, the
switches have to comply with LACP. This switch supports up to 28 trunks. For
example, a trunk consisting of two 1000 Mbps ports can support an aggregate
bandwidth of 4 Gbps when operating at full duplex.
lacp actor/partner mode Configures the port’s LACP actor or partner IC (Ethernet)
(Ethernet Interface) negotiation activity mode
lacp timeout Configures the timeout to wait for next LACPDU IC (Port Channel)
– 427 –
Chapter 12 | Link Aggregation Commands
General Guidelines –
◆ Finish configuring trunks before you connect the corresponding network
cables between switches to avoid creating a loop.
◆ A trunk can have up to 8 ports.
◆ The ports at both ends of a connection must be configured as trunk ports.
◆ All ports in a trunk must be configured in an identical manner, including
communication mode (i.e., speed and duplex mode), VLAN assignments, and
CoS settings.
◆ Any of the Gigabit ports on the front panel can be trunked together, including
ports of different media types.
◆ All the ports in a trunk have to be treated as a whole when moved from/to,
added or deleted from a VLAN via the specified port-channel.
◆ STP, VLAN, and IGMP settings can only be made for the entire trunk via the
specified port-channel.
port-channel This command sets the load-distribution method among ports in aggregated links
load-balance (for both static and dynamic trunks). Use the no form to restore the default setting.
Syntax
port-channel load-balance {dst-ip | dst-mac | src-dst-ip | src-dst-mac | src-ip
| src-mac}
no port-channel load-balance
dst-ip - Load balancing based on destination IP address.
dst-mac - Load balancing based on destination MAC address.
src-dst-ip - Load balancing based on source and destination IP address.
– 428 –
Chapter 12 | Link Aggregation Commands
Default Setting
src-dst-mac
Command Mode
Global Configuration
Command Usage
◆ This command applies to all static and dynamic trunks on the switch.
◆ To ensure that the switch traffic load is distributed evenly across all links in a
trunk, select the source and destination addresses used in the load-balance
calculation to provide the best result for trunk connections:
■ dst-ip: All traffic with the same destination IP address is output on the
same link in a trunk. This mode works best for switch-to-router trunk links
where traffic through the switch is destined for many different hosts. Do
not use this mode for switch-to-server trunk links where the destination IP
address is the same for all traffic.
■ dst-mac: All traffic with the same destination MAC address is output on the
same link in a trunk. This mode works best for switch-to-switch trunk links
where traffic through the switch is destined for many different hosts. Do
not use this mode for switch-to-router trunk links where the destination
MAC address is the same for all traffic.
■ src-dst-ip: All traffic with the same source and destination IP address is
output on the same link in a trunk. This mode works best for switch-to-
router trunk links where traffic through the switch is received from and
destined for many different hosts.
■ src-dst-mac: All traffic with the same source and destination MAC address
is output on the same link in a trunk. This mode works best for switch-to-
switch trunk links where traffic through the switch is received from and
destined for many different hosts.
■ src-ip: All traffic with the same source IP address is output on the same link
in a trunk. This mode works best for switch-to-router or switch-to-server
trunk links where traffic through the switch is received from many different
hosts.
■ src-mac: All traffic with the same source MAC address is output on the
same link in a trunk. This mode works best for switch-to-switch trunk links
where traffic through the switch is received from many different hosts.
– 429 –
Chapter 12 | Link Aggregation Commands
Example
Console(config)#port-channel load-balance dst-ip
Console(config)#
channel-group This command adds a port to a trunk. Use the no form to remove a port from a
trunk.
Syntax
channel-group channel-id
no channel-group
channel-id - Trunk index (Range: 1-28)
Default Setting
The current port is not a member of any trunk.
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ When configuring static trunks, the switches must comply with the Cisco
EtherChannel standard.
Example
The following example creates trunk 1 and then adds port 10:
Console(config)#interface port-channel 1
Console(config-if)#exit
Console(config)#interface ethernet 1/10
Console(config-if)#channel-group 1
Console(config-if)#
lacp This command enables 802.3ad Link Aggregation Control Protocol (LACP) for the
current interface. Use the no form to disable it.
Syntax
[no] lacp
– 430 –
Chapter 12 | Link Aggregation Commands
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ The ports on both ends of an LACP trunk must be configured for full duplex.
◆ A trunk formed with another switch using LACP will automatically be assigned
the next available port-channel ID.
◆ If the target switch has also enabled LACP on the connected ports, the trunk
will be activated automatically.
◆ If more than eight ports attached to the same target switch have LACP enabled,
the additional ports will be placed in standby mode, and will only be enabled if
one of the active links fails.
Example
The following shows LACP enabled on ports 1-3. Because LACP has also been
enabled on the ports at the other end of the links, the show interfaces status port-
channel 1 command shows that Trunk1 has been established.
– 431 –
Chapter 12 | Link Aggregation Commands
Max Frame Size : 1518 bytes (1522 bytes for tagged frames)
MAC Learning Status : Enabled
Member Ports : Eth1/25, Eth1/26, Eth1/27,
Active Member Ports : Eth1/25, Eth1/26, Eth1/27,
Console#
lacp actor/partner This command configures a port's LACP actor or partner negotiation activity mode.
mode (Ethernet Interface) Use the no form to restore to the default setting.
Syntax
lacp {actor | partner} mode {active | passive}
no lacp {actor | partner} mode
actor - The local side an aggregate link.
partner - The remote side of an aggregate link.
mode - Configures the negotiation activity mode.
active - Specifies the port’s activity mode to initiate and transmit LACP
negotiation packets.
passive - Specifies the port’s activity mode to only respond to LACP
negotiation packets.
Default Setting
Actor: Active, Partner: Passive
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ An LACP trunk cannot be instantiated if both sides are set to passive.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#lacp actor mode passive
Console(config-if)#
– 432 –
Chapter 12 | Link Aggregation Commands
lacp admin-key This command configures a port's LACP administration key. Use the no form to
(Ethernet Interface) restore the default setting.
Syntax
lacp {actor | partner} admin-key key
no lacp {actor | partner} admin-key
actor - The local side an aggregate link.
partner - The remote side of an aggregate link.
key - The port admin key must be set to the same value for ports that
belong to the same link aggregation group (LAG). (Range: 0-65535)
Default Setting
Actor: 1, Partner: 0
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ Ports are only allowed to join the same LAG if (1) the LACP system priority
matches, (2) the LACP port admin key matches, and (3) the LACP port channel
key matches (if configured).
◆ If the port channel admin key (lacp admin key - Port Channel) is not set when a
channel group is formed (i.e., it has the null value of 0), this key is set to the
same value as the port admin key (lacp admin key - Ethernet Interface) used
by the interfaces that joined the group.
◆ Once the remote side of a link has been established, LACP operational settings
are already in use on that side. Configuring LACP settings for the partner only
applies to its administrative state, not its operational state.
Note: Configuring the partner admin-key does not affect remote or local switch
operation. The local switch just records the partner admin-key for user reference.
◆ If the admin key is not set, the actor’s operational key is determined by port's
link speed (10G - 5, 1000f - 4, 100f - 3, 10f - 2).
Example
Console(config)#interface ethernet 1/5
Console(config-if)#lacp actor admin-key 120
Console(config-if)#
– 433 –
Chapter 12 | Link Aggregation Commands
lacp port-priority This command configures LACP port priority. Use the no form to restore the default
setting.
Syntax
lacp {actor | partner} port-priority priority
no lacp {actor | partner} port-priority
actor - The local side an aggregate link.
partner - The remote side of an aggregate link.
priority - LACP port priority is used to select a backup link. (Range: 0-65535)
Default Setting
32768
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ Setting a lower value indicates a higher effective priority.
◆ If an active port link goes down, the backup port with the highest priority is
selected to replace the downed link. However, if two or more ports have the
same LACP port priority, the port with the lowest physical port number will be
selected as the backup port.
◆ If an LAG already exists with the maximum number of allowed port members,
and LACP is subsequently enabled on another port using a higher priority than
an existing member, the newly configured port will replace an existing port
member that has a lower priority.
◆ Once the remote side of a link has been established, LACP operational settings
are already in use on that side. Configuring LACP settings for the partner only
applies to its administrative state, not its operational state, and will only take
effect the next time an aggregate link is established with the partner.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#lacp actor port-priority 128
– 434 –
Chapter 12 | Link Aggregation Commands
lacp system-priority This command configures a port's LACP system priority. Use the no form to restore
the default setting.
Syntax
lacp {actor | partner} system-priority priority
no lacp {actor | partner} system-priority
actor - The local side an aggregate link.
partner - The remote side of an aggregate link.
priority - This priority is used to determine link aggregation group (LAG)
membership, and to identify this device to other switches during LAG
negotiations. (Range: 0-65535)
Default Setting
32768
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ Port must be configured with the same system priority to join the same LAG.
◆ System priority is combined with the switch’s MAC address to form the LAG
identifier. This identifier is used to indicate a specific LAG during LACP
negotiations with other systems.
◆ Once the remote side of a link has been established, LACP operational settings
are already in use on that side. Configuring LACP settings for the partner only
applies to its administrative state, not its operational state, and will only take
effect the next time an aggregate link is established with the partner.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#lacp actor system-priority 3
Console(config-if)#
lacp admin-key This command configures a port channel's LACP administration key. Use the no
(Port Channel) form to restore the default setting.
Syntax
lacp admin-key key
no lacp admin-key
key - The port channel admin key is used to identify a specific link
aggregation group (LAG) during local LACP setup on this switch.
(Range: 0-65535)
– 435 –
Chapter 12 | Link Aggregation Commands
Default Setting
None
Command Mode
Interface Configuration (Port Channel)
Command Usage
◆ Ports are only allowed to join the same LAG if (1) the LACP system priority
matches, (2) the LACP port admin key matches, and (3) the LACP port channel
key matches (if configured).
◆ If the port channel admin key (lacp admin key - Port Channel) is not set when a
channel group is formed (i.e., it has the null value of 0), the operational key is
set to the same value as the operational key of the first member port. Note that
when the LAG is no longer used, the port channel admin key is reset to 0.
Example
Console(config)#interface port-channel 1
Console(config-if)#lacp admin-key 3
Console(config-if)#
lacp timeout This command configures the timeout to wait for the next LACP data unit
(LACPDU).
Syntax
lacp timeout {long | short}
long - Specifies a slow timeout of 90 seconds.
short - Specifies a fast timeout of 3 seconds.
Default Setting
long
Command Mode
Interface Configuration (Port Channel)
Command Usage
◆ The timeout configured by this command is set in the LACP timeout bit of the
Actor State field in transmitted LACPDUs. When the partner switch receives an
LACPDU set with a short timeout from the actor switch, the partner adjusts the
transmit LACPDU interval to 1 second. When it receives an LACPDU set with a
long timeout from the actor, it adjusts the transmit LACPDU interval to 30
seconds.
◆ If the actor does not receive an LACPDU from its partner before the configured
timeout expires, the partner port information will be deleted from the LACP
group.
– 436 –
Chapter 12 | Link Aggregation Commands
◆ When a dynamic port-channel is torn down, the configured timeout value will
be retained. When the dynamic port-channel is constructed again, that timeout
value will be used.
Example
Console(config)#interface port-channel 1
Console(config-if)#lacp timeout short
Console(config-if)#
Syntax
show lacp [port-channel] {counters | internal | neighbors }
port-channel - Local identifier for a link aggregation group. (Range: 1-28)
counters - Statistics for LACP protocol messages.
internal - Configuration settings and operational state for local side.
neighbors - Configuration settings and operational state for remote side.
Default Setting
Port Channel: all
Command Mode
Privileged Exec
Example
Console#show lacp 1 counters
Port Channel: 1
Member Port : Eth 1/14
LACPDU Sent : 7
LACPDU Received : 6
MarkerPDU Sent : 0
MarkerPDU Received : 0
MarkerResponsePDU Sent : 0
MarkerResponsePDU Received : 0
Unknown Packet Received : 0
Illegal Packet Received : 0
.
.
.
– 437 –
Chapter 12 | Link Aggregation Commands
Member Port The Ethernet interface that is a member of the LACP port-channel trunk.
LACPDUs Sent Number of valid LACPDUs transmitted from this channel group.
MarkerPDU Sent Number of valid Marker PDUs transmitted from this channel group.
MarkerPDU Received Number of valid Marker PDUs received by this channel group.
MarkerResponsePDU Number of valid MarkerResponse PDUs transmitted from this channel group.
Sent
Unknown Packet Number of frames received that either (1) Carry the Slow Protocols Ethernet
Received Type value, but contain an unknown PDU, or (2) are addressed to the Slow
Protocols group MAC Address, but do not carry the Slow Protocols Ethernet
Type.
Illegal Packet Received Number of frames that carry the Slow Protocols Ethernet Type value, but
contain a badly formed PDU or an illegal value of Protocol Subtype.
Admin Key Current administrative value of the key for the aggregation port.
Oper Key Current operational value of the key for the aggregation port.
Timeout Time to wait for the next LACPDU before deleting partner port information.
Port Priority LACP port priority assigned to this interface within the channel group.
– 438 –
Chapter 12 | Link Aggregation Commands
Admin State, ◆ Aggregation – The system considers this link to be aggregatable; i.e., a
Oper State potential candidate for aggregation.
(continued) ◆ Long timeout – Periodic transmission of LACPDUs uses a slow transmission
rate.
◆ LACP-Activity – Activity control value with regard to this link.
(0: Passive; 1: Active)
Member Port The Ethernet interface that is a member of the LACP port-channel trunk.
Partner Admin Port Current administrative value of the port number for the protocol Partner.
ID
– 439 –
Chapter 12 | Link Aggregation Commands
Partner Oper Port Operational port number assigned to this aggregation port by the port’s
ID protocol partner.
Partner Admin Key Current administrative value of the Key for the protocol partner.
Partner Oper Key Current operational value of the Key for the protocol partner.
Partner Admin State Administrative values of the partner’s state parameters. (See preceding table.)
Partner Oper State Operational values of the partner’s state parameters. (See preceding table.)
* The LACP system priority and system MAC address are concatenated to form the LAG system ID.
show port-channel This command shows the load-distribution method used on aggregated links.
load-balance
Command Mode
Privileged Exec
Example
Console#show port-channel load-balance
Trunk Load Balance Mode: Destination IP address
Console
– 440 –
13 Port Mirroring Commands
Data can be mirrored from a local port on the same switch or from a remote port on
another switch for analysis at the target port using software monitoring tools or a
hardware probe. This switch supports the following mirroring modes.
Local Port Mirroring Mirrors data to another port for analysis without affecting the data passing
through or the performance of the monitored port
RSPAN Mirroring Mirrors data from remote switches over a dedicated VLAN
port monitor This command configures a mirror session. Use the no form to clear a mirror
session.
Syntax
port monitor interface [rx | tx | both]
no port monitor interface
interface
ethernet unit/port (source port)
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
rx - Mirror received packets.
tx - Mirror transmitted packets.
both - Mirror both received and transmitted packets.
– 441 –
Chapter 13 | Port Mirroring Commands
Local Port Mirroring Commands
Default Setting
◆ No mirror session is defined.
◆ When enabled for an interface, default mirroring is for both received and
transmitted packets.
Command Mode
Interface Configuration (Ethernet, destination port)
Command Usage
◆ You can mirror traffic from any source port to a destination port for real-time
analysis. You can then attach a logic analyzer or RMON probe to the destination
port and study the traffic crossing the source port in a completely unobtrusive
manner.
◆ Set the destination port by specifying an Ethernet interface with the interface
configuration command, and then use the port monitor command to specify
the source of the traffic to mirror. Note that the destination port cannot be a
trunk or trunk member port.
◆ When mirroring traffic from a port, the mirror port and monitor port speeds
should match, otherwise traffic may be dropped from the monitor port.
Example
The following example configures the switch to mirror all packets from port 6 to 5:
Syntax
show port monitor [interface]
interface - ethernet unit/port (source port)
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Default Setting
Shows all sessions.
Command Mode
Privileged Exec
– 442 –
Chapter 13 | Port Mirroring Commands
RSPAN Mirroring Commands
Command Usage
This command displays the currently configured source port, destination port, and
mirror mode (i.e., RX, TX, RX/TX).
Example
The following shows mirroring configured from port 6 to port 5:
rspan remote vlan Specifies the RSPAN VLAN, switch role (source, GC
intermediate or destination), and the uplink ports
Configuration Guidelines
1. Use the vlan rspan command to configure a VLAN to use for RSPAN. (Default
VLAN 1 and switch cluster VLAN 4093 are prohibited.)
2. Use the rspan source command to specify the interfaces and the traffic type
(RX, TX or both) to be monitored.
– 443 –
Chapter 13 | Port Mirroring Commands
RSPAN Mirroring Commands
3. Use the rspan destination command to specify the destination port for the
traffic mirrored by an RSPAN session.
4. Use the rspan remote vlan command to specify the VLAN to be used for an
RSPAN session, to specify the switch’s role as a source, intermediate relay, or
destination of the mirrored traffic, and to configure the uplink ports designated
to carry this traffic.
RSPAN Limitations
◆ Local/Remote Mirror – The destination of a local mirror session (created with the
port monitor command) cannot be used as the destination for RSPAN traffic.
◆ Spanning Tree – If the spanning tree is disabled, BPDUs will not be flooded onto
the RSPAN VLAN.
MAC address learning is not supported on RSPAN uplink ports when RSPAN is
enabled on the switch. Therefore, even if spanning tree is enabled after RSPAN
has been configured, MAC address learning will still not be re-started on the
RSPAN uplink ports.
◆ IEEE 802.1X – RSPAN and 802.1X are mutually exclusive functions. When 802.1X
is enabled globally, RSPAN uplink ports cannot be configured, even though
RSPAN source and destination ports can still be configured. When RSPAN uplink
ports are enabled on the switch, 802.1X cannot be enabled globally.
RSPAN uplink ports cannot be configured to use IEEE 802.1X Port
Authentication, but RSPAN source ports and destination ports can be
configured to use it
◆ Port Security – If port security is enabled on any port, that port cannot be set as
an RSPAN uplink port, even though it can still be configured as an RSPAN source
or destination port. Also, when a port is configured as an RSPAN uplink port,
port security cannot be enabled on that port.
– 444 –
Chapter 13 | Port Mirroring Commands
RSPAN Mirroring Commands
rspan source Use this command to specify the source port and traffic type to be mirrored
remotely. Use the no form to disable RSPAN on the specified port, or with a traffic
type keyword to disable mirroring for the specified type.
Syntax
[no] rspan session session-id source interface interface-list [rx | tx | both]
session-id – A number identifying this RSPAN session. (Range: 1)
Three sessions are allowed, including both local and remote mirroring,
using different VLANs for RSPAN sessions.
interface-list – One or more source ports. Use a hyphen to indicate a
consecutive list of ports or a comma between non-consecutive ports.
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
rx - Mirror received packets.
tx - Mirror transmitted packets.
both - Mirror both received and transmitted packets.
Default Setting
Both TX and RX traffic is mirrored
Command Mode
Global Configuration
Command Usage
◆ One or more source ports can be assigned to the same RSPAN session, either on
the same switch or on different switches.
◆ Only ports can be configured as an RSPAN source – static and dynamic trunks
are not allowed.
◆ Only 802.1Q trunk or hybrid (i.e., general use) ports can be configured as an
RSPAN source port – access ports are not allowed (see switchport mode).
◆ The source port and destination port cannot be configured on the same switch.
Example
The following example configures the switch to mirror received packets from port 2
and 3:
– 445 –
Chapter 13 | Port Mirroring Commands
RSPAN Mirroring Commands
rspan destination Use this command to specify the destination port to monitor the mirrored traffic.
Use the no form to disable RSPAN on the specified port.
Syntax
rspan session session-id destination interface interface [tagged | untagged]
no rspan session session-id destination interface interface
session-id – A number identifying this RSPAN session. (Range: 1)
Three sessions are allowed, including both local and remote mirroring,
using different VLANs for RSPAN sessions.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
tagged - Traffic exiting the destination port carries the RSPAN VLAN tag.
untagged - Traffic exiting the destination port is untagged.
Default Setting
Traffic exiting the destination port is untagged.
Command Mode
Global Configuration
Command Usage
◆ Only one destination port can be configured on the same switch per session,
but a destination port can be configured on more than one switch for the same
session.
◆ Only 802.1Q trunk or hybrid (i.e., general use) ports can be configured as an
RSPAN destination port – access ports are not allowed (see switchport mode).
◆ The source port and destination port cannot be configured on the same switch.
◆ A destination port can still send and receive switched traffic, and participate in
any Layer 2 protocols to which it has been assigned.
Example
The following example configures port 4 to receive mirrored RSPAN traffic:
– 446 –
Chapter 13 | Port Mirroring Commands
RSPAN Mirroring Commands
rspan remote vlan Use this command to specify the RSPAN VLAN, switch role (source, intermediate or
destination), and the uplink ports. Use the no form to disable the RSPAN on the
specified VLAN.
Syntax
[no] rspan session session-id remote vlan vlan-id
{source | intermediate | destination} uplink interface
session-id – A number identifying this RSPAN session. (Range: 1)
Three sessions are allowed, including both local and remote mirroring,
using different VLANs for RSPAN sessions.
vlan-id - ID of configured RSPAN VLAN. (Range: 1-4094)
Use the vlan rspan command to reserve a VLAN for RSPAN mirroring before
enabling RSPAN with this command.
source - Specifies this device as the source of remotely mirrored traffic.
intermediate - Specifies this device as an intermediate switch,
transparently passing mirrored traffic from one or more sources to one or
more destinations.
destination - Specifies this device as a switch configured with a destination
port which is to receive mirrored traffic for this session.
uplink - A port configured to receive or transmit remotely mirrored traffic.
interface - ethernet unit/port
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ Only 802.1Q trunk or hybrid (i.e., general use) ports can be configured as an
RSPAN uplink port – access ports are not allowed (see switchport mode).
◆ Only one uplink port can be configured on a source switch, but there is no
limitation on the number of uplink ports configured on an intermediate or
destination switch.
◆ Only destination and uplink ports will be assigned by the switch as members of
this VLAN. Ports cannot be manually assigned to an RSPAN VLAN with the
switchport allowed vlan command. Nor can GVRP dynamically add port
members to an RSPAN VLAN. Also, note that the show vlan command will not
– 447 –
Chapter 13 | Port Mirroring Commands
RSPAN Mirroring Commands
display any members for an RSPAN VLAN, but will only show configured RSPAN
VLAN identifiers.
Example
The following example enables RSPAN on VLAN 2, specifies this device as an RSPAN
destination switch, and the uplink interface as port 3:
Syntax
no rspan session session-id
session-id – A number identifying this RSPAN session. (Range: 1-3)
Three sessions are allowed, including both local and remote mirroring,
using different VLANs for RSPAN sessions.
Command Mode
Global Configuration
Command Usage
The no rspan session command must be used to disable an RSPAN VLAN before it
can be deleted from the VLAN database (see the vlan command).
Example
Console(config)#no rspan session 1
Console(config)#
show rspan Use this command to displays the configuration settings for an RSPAN session.
Syntax
show rspan session [session-id]
session-id – A number identifying this RSPAN session. (Range: 1-3)
Three sessions are allowed, including both local and remote mirroring,
using different VLANs for RSPAN sessions.
Command Mode
Privileged Exec
– 448 –
Chapter 13 | Port Mirroring Commands
RSPAN Mirroring Commands
Example
Console#show rspan session
RSPAN Session ID : 1
Source Ports (mirrored ports) : None
RX Only : None
TX Only : None
BOTH : None
Destination Port (monitor port) : Eth 1/2
Destination Tagged Mode : Untagged
Switch Role : Destination
RSPAN VLAN : 2
RSPAN Uplink Ports : Eth 1/3
Operation Status : Up
Console#
– 449 –
Chapter 13 | Port Mirroring Commands
RSPAN Mirroring Commands
– 450 –
14 Congestion Control Commands
The switch can set the maximum upload or download data transfer rate for any
port. It can control traffic storms by setting a maximum threshold for broadcast
traffic or multicast traffic. It can also set bounding thresholds for broadcast and
multicast storms which can be used to automatically trigger rate limits or to shut
down a port.
Rate Limiting Sets the input and output rate limits for a port.
Storm Control Sets the traffic storm threshold for each port.
Automatic Traffic Control Sets thresholds for broadcast and multicast storms which can be used
Commands to trigger configured rate limits or to shut down a port.
– 451 –
Chapter 14 | Congestion Control Commands
Rate Limit Commands
rate-limit This command defines the rate limit for a specific interface. Use this command
without specifying a rate to enable rate limiting. Use the no form to disable rate
limiting.
Syntax
rate-limit {input | output} [rate]
no rate-limit {input | output}
input – Input rate for specified interface
output – Output rate for specified interface
rate – Maximum value in kbps.
(Range: 64 - 100,000 kbits per second for 10/100 Mbps ports.
64 - 1,000,000 kbits per second for Gigabit Ethernet ports;
64 - 10,000,000 kbits per second for 10 Gigabit Ethernet ports)
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
Using both rate limiting and storm control on the same interface may lead to
unexpected results. It is therefore not advisable to use both of these commands on
the same interface.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#rate-limit input 64
Console(config-if)#
Related Command
show interfaces switchport (413)
– 452 –
Chapter 14 | Congestion Control Commands
Storm Control Commands
switchport This command configures broadcast, multicast and unknown unicast storm
packet-rate control. Use the no form to restore the default setting.
Syntax
switchport {broadcast | multicast | unknown-unicast} packet-rate rate
no switchport {broadcast | multicast | unknown-unicast}
broadcast - Specifies storm control for broadcast traffic.
multicast - Specifies storm control for multicast traffic.
unknown-unicast - Specifies storm control for unknown unicast traffic.
rate - Threshold level as a rate; i.e. (Range: 500–14881000 pps.
500-148500 pps for 10/100 Mbps ports;
500-1488000 pps for 1 Gbps ports:
500-14881000 pps for 10 Gbps ports)
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ When traffic exceeds the threshold specified for broadcast and multicast or
unknown unicast traffic, packets exceeding the threshold are dropped until the
rate falls back down beneath the threshold.
– 453 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
◆ Using both rate limiting and storm control on the same interface may lead to
unexpected results. It is therefore not advisable to use both of these commands
on the same interface.
Example
The following shows how to configure broadcast storm control at 600 packets per
second:
Related Commands
show interfaces switchport (413)
Threshold Commands
auto-traffic-control Sets the control action to limit ingress traffic or shut IC (Port)
action down the offending port
auto-traffic-control Sets the lower threshold for ingress traffic beneath IC (Port)
alarm-clear-threshold which a cleared storm control trap is sent
auto-traffic-control Sets the upper threshold for ingress traffic beyond IC (Port)
alarm-fire-threshold which a storm control response is triggered after the
apply timer expires
– 454 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
snmp-server enable Sends a trap when broadcast traffic falls beneath IC (Port)
port-traps atc broadcast- the lower threshold after a storm control response
alarm-clear has been triggered
snmp-server enable Sends a trap when broadcast traffic exceeds the IC (Port)
port-traps atc broadcast- upper threshold for automatic storm control
alarm-fire
snmp-server enable Sends a trap when broadcast traffic exceeds the IC (Port)
port-traps atc broadcast- upper threshold for automatic storm control and
control-apply the apply timer expires
snmp-server enable Sends a trap when broadcast traffic falls beneath IC (Port)
port-traps atc broadcast- the lower threshold after a storm control response
control-release has been triggered and the release timer expires
snmp-server enable Sends a trap when multicast traffic falls beneath the IC (Port)
port-traps atc multicast- lower threshold after a storm control response has
alarm-clear been triggered
snmp-server enable Sends a trap when multicast traffic exceeds the IC (Port)
port-traps atc multicast- upper threshold for automatic storm control
alarm-fire
snmp-server enable Sends a trap when multicast traffic exceeds the IC (Port)
port-traps atc multicast- upper threshold for automatic storm control and
control-apply the apply timer expires
snmp-server enable Sends a trap when multicast traffic falls beneath the IC (Port)
port-traps atc multicast- lower threshold after a storm control response has
control-release been triggered and the release timer expires
* Enabling automatic storm control on a port will disable hardware-level storm control on the
same port if configured by the switchport packet-rate command.
– 455 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
Usage Guidelines
ATC includes storm control for broadcast or multicast traffic. The control response
for either of these traffic types is the same, as shown in the following diagrams.
StromAlarm
StromAlarm ClearTRAP
Alarm Fire
Threshold ClearTRAP
(1~255kpps) Release Timer
expired
(0~300sec)
AlarmClear
Threshold
(1~255kpps)
Apply Timer
expired Auto Storm Control
(0 300 )
◆ Alarm Fire Threshold – The highest acceptable traffic rate. When ingress traffic
exceeds the threshold, ATC sends a Storm Alarm Fire Trap and logs it.
◆ When traffic exceeds the alarm fire threshold and the apply timer expires, a
traffic control response is applied, and a Traffic Control Apply Trap is sent and
logged.
◆ Alarm Clear Threshold – The lower threshold beneath which a control response
can be automatically terminated after the release timer expires. When ingress
traffic falls below this threshold, ATC sends a Storm Alarm Clear Trap and logs it.
◆ When traffic falls below the alarm clear threshold after the release timer
expires, traffic control (for rate limiting) will be stopped and a Traffic Control
Release Trap sent and logged. Note that if the control action has shut down a
port, it can only be manually re-enabled using the auto-traffic-control control-
release command).
– 456 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
The key elements of this diagram are the same as that described in the preceding
diagram, except that automatic release of the control response is not provided.
When traffic control is applied, you must manually re-enable the port.
Functional Limitations
Automatic storm control is a software level control function. Traffic storms can also
be controlled at the hardware level using the switchport packet-rate command.
However, only one of these control types can be applied to a port. Enabling
automatic storm control on a port will disable hardware-level storm control on that
port.
Threshold Commands
auto-traffic-control This command sets the time at which to apply the control response after ingress
apply-timer traffic has exceeded the upper threshold. Use the no form to restore the default
setting.
Syntax
auto-traffic-control {broadcast | multicast} apply-timer seconds
no auto-traffic-control {broadcast | multicast} apply-timer
broadcast - Specifies automatic storm control for broadcast traffic.
multicast - Specifies automatic storm control for multicast traffic.
seconds - The interval after the upper threshold has been exceeded at
which to apply the control response. (Range: 5-300 seconds)
Default Setting
300 seconds
Command Mode
Global Configuration
– 457 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
Command Usage
After the apply timer expires, a control action may be triggered as specified by the
auto-traffic-control action command and a trap message sent as specified by the
snmp-server enable port-traps atc broadcast-control-apply command or snmp-
server enable port-traps atc multicast-control-apply command.
Example
This example sets the apply timer to 200 seconds for all ports.
auto-traffic-control This command sets the time at which to release the control response after ingress
release-timer traffic has fallen beneath the lower threshold. Use the no form to restore the
default setting.
Syntax
auto-traffic-control {broadcast | multicast} release-timer seconds
no auto-traffic-control {broadcast | multicast} release-timer
broadcast - Specifies automatic storm control for broadcast traffic.
multicast - Specifies automatic storm control for multicast traffic.
seconds - The time at which to release the control response after ingress
traffic has fallen beneath the lower threshold. (Range: 5-900 seconds)
Default Setting
900 seconds
Command Mode
Global Configuration
Command Usage
This command sets the delay after which the control response can be terminated.
The auto-traffic-control auto-control-release command must be used to enable or
disable the automatic release of a control response of rate-limiting. To re-enable a
port which has been shut down by automatic traffic control, you must manually re-
enable the port using the auto-traffic-control control-release command.
Example
This example sets the release timer to 800 seconds for all ports.
– 458 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
auto-traffic-control This command enables automatic traffic control for broadcast or multicast storms.
Use the no form to disable this feature.
Syntax
[no] auto-traffic-control {broadcast | multicast}
broadcast - Specifies automatic storm control for broadcast traffic.
multicast - Specifies automatic storm control for multicast traffic.
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ Automatic storm control can be enabled for either broadcast or multicast
traffic. It cannot be enabled for both of these traffic types at the same time.
◆ Automatic storm control is a software level control function. Traffic storms can
also be controlled at the hardware level using the switchport packet-rate
command. However, only one of these control types can be applied to a port.
Enabling automatic storm control on a port will disable hardware-level storm
control on that port.
Example
This example enables automatic storm control for broadcast traffic on port 1.
auto-traffic-control This command sets the control action to limit ingress traffic or shut down the
action offending port. Use the no form to restore the default setting.
Syntax
auto-traffic-control {broadcast | multicast} action {rate-control | shutdown}
no auto-traffic-control {broadcast | multicast} action
broadcast - Specifies automatic storm control for broadcast traffic.
multicast - Specifies automatic storm control for multicast traffic.
rate-control - If a control response is triggered, the rate of ingress traffic is
limited based on the threshold configured by the auto-traffic-control
alarm-clear-threshold command.
– 459 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
Default Setting
rate-control
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ When the upper threshold is exceeded and the apply timer expires, a control
response will be triggered based on this command.
◆ When the control response is set to rate limiting by this command, the rate
limits are determined by the auto-traffic-control alarm-clear-threshold
command.
◆ If a port has been shut down by a control response, it will not be re-enabled by
automatic traffic control. It can only be manually re-enabled using the auto-
traffic-control control-release command.
Example
This example sets the control response for broadcast traffic on port 1.
auto-traffic-control This command sets the lower threshold for ingress traffic beneath which a control
alarm-clear-threshold response for rate limiting will be released after the Release Timer expires, if so
configured by the auto-traffic-control auto-control-release command. Use the no
form to restore the default setting.
Syntax
auto-traffic-control {broadcast | multicast} alarm-clear-threshold threshold
no auto-traffic-control {broadcast | multicast} alarm-clear-threshold
broadcast - Specifies automatic storm control for broadcast traffic.
multicast - Specifies automatic storm control for multicast traffic.
threshold - The lower threshold for ingress traffic beneath which a cleared
storm control trap is sent. (Range: 1-255 kilo-packets per second)
– 460 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
Default Setting
128 kilo-packets per second
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ Once the traffic rate falls beneath the lower threshold, a trap message may be
sent if configured by the snmp-server enable port-traps atc broadcast-alarm-
clear command or snmp-server enable port-traps atc multicast-alarm-clear
command.
Example
This example sets the clear threshold for automatic storm control for broadcast
traffic on port 1.
auto-traffic-control This command sets the upper threshold for ingress traffic beyond which a storm
alarm-fire-threshold control response is triggered after the apply timer expires. Use the no form to
restore the default setting.
Syntax
auto-traffic-control {broadcast | multicast} alarm-fire-threshold threshold
no auto-traffic-control {broadcast | multicast} alarm-fire-threshold
broadcast - Specifies automatic storm control for broadcast traffic.
multicast - Specifies automatic storm control for multicast traffic.
threshold - The upper threshold for ingress traffic beyond which a storm
control response is triggered after the apply timer expires. (Range: 1-255
kilo-packets per second)
Default Setting
128 kilo-packets per second
Command Mode
Interface Configuration (Ethernet)
– 461 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
Command Usage
◆ Once the upper threshold is exceeded, a trap message may be sent if
configured by the snmp-server enable port-traps atc broadcast-alarm-fire
command or snmp-server enable port-traps atc multicast-alarm-fire command.
◆ After the upper threshold is exceeded, the control timer must first expire as
configured by the auto-traffic-control apply-timer command before a control
response is triggered if configured by the auto-traffic-control action command.
Example
This example sets the trigger threshold for automatic storm control for broadcast
traffic on port 1.
auto-traffic-control This command automatically releases a control response of rate-limiting after the
auto-control-release time specified in the auto-traffic-control release-timer command has expired.
Syntax
auto-traffic-control {broadcast | multicast} auto-control-release
broadcast - Specifies automatic storm control for broadcast traffic.
multicast - Specifies automatic storm control for multicast traffic.
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ This command can be used to automatically stop a control response of rate-
limiting after the specified action has been triggered and the release timer has
expired.
◆ To release a control response which has shut down a port after the specified
action has been triggered and the release timer has expired, use the auto-
traffic-control control-release command.
Example
Console(config-if)#auto-traffic-control broadcast auto-control-release
Console(config-if)#
– 462 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
Command Mode
Privileged Exec
Command Usage
This command can be used to manually stop a control response of rate-limiting or
port shutdown any time after the specified action has been triggered.
Example
Console#auto-traffic-control broadcast control-release interface ethernet 1/1
Console#
snmp-server enable This command sends a trap when broadcast traffic falls beneath the lower
port-traps atc threshold after a storm control response has been triggered. Use the no form to
broadcast-alarm-clear disable this trap.
Syntax
[no] snmp-server enable port-traps atc broadcast-alarm-clear
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
– 463 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
Example
Console(config)#interface ethernet 1/1
Console(config-if)#snmp-server enable port-traps atc broadcast-alarm-clear
Console(config-if)#
Related Commands
auto-traffic-control action (459)
auto-traffic-control alarm-clear-threshold (460)
snmp-server enable This command sends a trap when broadcast traffic exceeds the upper threshold for
port-traps atc automatic storm control. Use the no form to disable this trap.
broadcast-alarm-fire
Syntax
[no] snmp-server enable port-traps atc broadcast-alarm-fire
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
Example
Console(config)#interface ethernet 1/1
Console(config-if)#snmp-server enable port-traps atc broadcast-alarm-fire
Console(config-if)#
Related Commands
auto-traffic-control alarm-fire-threshold (461)
snmp-server enable This command sends a trap when broadcast traffic exceeds the upper threshold for
port-traps atc automatic storm control and the apply timer expires. Use the no form to disable
broadcast-control- this trap.
apply
Syntax
[no] snmp-server enable port-traps atc broadcast-control-apply
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
– 464 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
Example
Console(config)#interface ethernet 1/1
Console(config-if)#snmp-server enable port-traps atc broadcast-control-apply
Console(config-if)#
Related Commands
auto-traffic-control alarm-fire-threshold (461)
auto-traffic-control apply-timer (457)
snmp-server enable This command sends a trap when broadcast traffic falls beneath the lower
port-traps atc threshold after a storm control response has been triggered and the release timer
broadcast-control- expires. Use the no form to disable this trap.
release
Syntax
[no] snmp-server enable port-traps atc
broadcast-control-release
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
Example
Console(config)#interface ethernet 1/1
Console(config-if)#snmp-server enable port-traps atc broadcast-control-
release
Console(config-if)#
Related Commands
auto-traffic-control alarm-clear-threshold (460)
auto-traffic-control action (459)
auto-traffic-control release-timer (458)
snmp-server enable This command sends a trap when multicast traffic falls beneath the lower threshold
port-traps atc after a storm control response has been triggered. Use the no form to disable this
multicast-alarm-clear trap.
Syntax
[no] snmp-server enable port-traps atc multicast-alarm-clear
Default Setting
Disabled
– 465 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
Command Mode
Interface Configuration (Ethernet)
Example
Console(config)#interface ethernet 1/1
Console(config-if)#snmp-server enable port-traps atc multicast-alarm-clear
Console(config-if)#
Related Commands
auto-traffic-control action (459)
auto-traffic-control alarm-clear-threshold (460)
snmp-server enable This command sends a trap when multicast traffic exceeds the upper threshold for
port-traps atc automatic storm control. Use the no form to disable this trap.
multicast-alarm-fire
Syntax
[no] snmp-server enable port-traps atc multicast-alarm-fire
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
Example
Console(config)#interface ethernet 1/1
Console(config-if)#snmp-server enable port-traps atc multicast-alarm-fire
Console(config-if)#
Related Commands
auto-traffic-control alarm-fire-threshold (461)
snmp-server enable This command sends a trap when multicast traffic exceeds the upper threshold for
port-traps atc automatic storm control and the apply timer expires. Use the no form to disable
multicast-control- this trap.
apply
Syntax
[no] snmp-server enable port-traps atc multicast-control-apply
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
– 466 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
Example
Console(config)#interface ethernet 1/1
Console(config-if)#snmp-server enable port-traps atc multicast-control-apply
Console(config-if)#
Related Commands
auto-traffic-control alarm-fire-threshold (461)
auto-traffic-control apply-timer (457)
snmp-server enable This command sends a trap when multicast traffic falls beneath the lower threshold
port-traps atc after a storm control response has been triggered and the release timer expires.
multicast-control- Use the no form to disable this trap.
release
Syntax
[no] snmp-server enable port-traps atc
multicast-control-release
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
Example
Console(config)#interface ethernet 1/1
Console(config-if)#snmp-server enable port-traps atc multicast-control-
release
Console(config-if)#
Related Commands
auto-traffic-control alarm-clear-threshold (460)
auto-traffic-control action (459)
auto-traffic-control release-timer (458)
show auto-traffic- This command shows global configuration settings for automatic storm control.
control
Command Mode
Privileged Exec
Example
Console#show auto-traffic-control
Storm-control: Broadcast
– 467 –
Chapter 14 | Congestion Control Commands
Automatic Traffic Control Commands
Storm-control: Multicast
Apply-timer(sec) : 300
release-timer(sec) : 900
Console#
show auto-traffic- This command shows interface configuration settings and storm control status for
control interface the specified port.
Syntax
show auto-traffic-control interface [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show auto-traffic-control interface ethernet 1/1
Eth 1/1 Information
------------------------------------------------------------------------
Storm Control: Broadcast Multicast
State: Disabled Disabled
Action: rate-control rate-control
Auto Release Control: Disabled Disabled
Alarm Fire Threshold(Kpps): 128 128
Alarm Clear Threshold(Kpps):128 128
Trap Storm Fire: Disabled Disabled
Trap Storm Clear: Disabled Disabled
Trap Traffic Apply: Disabled Disabled
Trap Traffic Release: Disabled Disabled
Console#
– 468 –
15 Loopback Detection Commands
Usage Guidelines
◆ The default settings for the control frame transmit interval and recover time
may be adjusted to improve performance for your specific environment. The
shutdown mode may also need to be changed once you determine what kind
of packets are being looped back.
– 469 –
Chapter 15 | Loopback Detection Commands
loopback-detection This command enables loopback detection globally on the switch or on a specified
interface. Use the no form to disable loopback detection.
Syntax
[no] loopback-detection
Default Setting
Enabled
Command Mode
Global Configuration
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ Loopback detection must be enabled globally for the switch by this command
and enabled for a specific interface for this function to take effect.
◆ When loopback detection is enabled globally and for a port, the ingress
filtering of the port is automatically enabled. The ingress filtering setting is
restored after loopback detection is disabled globally or for the port.
Example
This example enables general loopback detection on the switch, disables loopback
detection provided for the spanning tree protocol on port 1, and then enables
general loopback detection for that port.
Console(config)#loopback-detection
Console(config)#interface ethernet 1/1
Console(config-if)#loopback-detection
Console(config)#
loopback-detection This command specifies the protective action the switch takes when a loopback
action condition is detected. Use the no form to restore the default setting.
Syntax
loopback-detection action {none | shutdown}
no loopback-detection action
– 470 –
Chapter 15 | Loopback Detection Commands
Default Setting
Shut down
Command Mode
Global Configuration
Command Usage
◆ When a port receives a control frame sent by itself, this means that the port is in
a looped state, and the VLAN in the frame payload is also in looped state. The
looped port is therefore shut down.
Example
This example sets the loopback detection mode to shut down user traffic.
loopback-detection This command specifies the interval to wait before the switch automatically
recover-time releases an interface from shutdown state. Use the no form to restore the default
setting.
Syntax
loopback-detection recover-time seconds
no loopback-detection recover-time
seconds - Recovery time from shutdown state. (Range: 60-1,000,000
seconds, or 0 to disable automatic recovery)
Default Setting
60 seconds
Command Mode
Global Configuration
Command Usage
If the recovery time is set to zero, all ports placed in shutdown state can be restored
to operation using the loopback-detection release command. To restore a specific
port, use the no shutdown command.
– 471 –
Chapter 15 | Loopback Detection Commands
Example
Console(config)#loopback-detection recover-time 120
Console(config-if)#
loopback-detection This command specifies the interval at which to transmit loopback detection
transmit-interval control frames. Use the no form to restore the default setting.
Syntax
loopback-detection transmit-interval seconds
no loopback-detection transmit-interval
seconds - The transmission interval for loopback detection control frames.
(Range: 1-32767 seconds)
Default Setting
10 seconds
Command Mode
Global Configuration
Example
Console(config)#loopback-detection transmit-interval 60
Console(config)#
loopback detection This command sends a trap when a loopback condition is detected, or when the
trap switch recovers from a loopback condition. Use the no form to restore the default
state.
Syntax
loopback-detection trap [both | detect | none | recover]
no loopback-detection trap
both - Sends an SNMP trap message when a loopback condition is
detected, or when the switch recovers from a loopback condition.
detect - Sends an SNMP trap message when a loopback condition is
detected.
none - Does not send an SNMP trap for loopback detection or recovery.
recover - Sends an SNMP trap message when the switch recovers from a
loopback condition.
Default Setting
None
– 472 –
Chapter 15 | Loopback Detection Commands
Command Mode
Global Configuration
Command Usage
Refer to the loopback-detection recover-time command for information on
conditions which constitute loopback recovery.
Example
Console(config)#loopback-detection trap both
Console(config)#
loopback-detection This command releases all interfaces currently shut down by the loopback
release detection feature.
Syntax
loopback-detection release
Command Mode
Privileged Exec
Example
Console#loopback-detection release
Console#
show loopback- This command shows loopback detection configuration settings for the switch or
detection for a specified interface.
Syntax
show loopback-detection [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel
channel no. Port-channel interface number. (Range 1-28)
Command Mode
Privileged Exec
– 473 –
Chapter 15 | Loopback Detection Commands
Command Usage
Although global action may be set to None, this command will still display the
configured Detection Port Admin State and Information Oper State.
Example
Console#show loopback-detection
Loopback Detection Global Information
Global Status : Enabled
Transmit Interval : 10
Recover Time : 60
Action : Shutdown
Trap : None
Loopback Detection Port Information
Port Admin State Oper State
-------- ----------- ----------
Eth 1/ 1 Enabled Normal
Eth 1/ 2 Disabled Normal
. Eth 1/ 3 Disabled Normal
.
.
Console#show loopback-detection ethernet 1/1
Loopback Detection Information of Eth 1/1
Admin State : Enabled
Oper State : Normal
Looped VLAN : None
Console#
– 474 –
16 UniDirectional Link Detection
Commands
The switch can be configured to detect and disable unidirectional Ethernet fiber or
copper links. When enabled, the protocol advertises a port’s identity and learns
about its neighbors on a specific LAN segment; and stores information about its
neighbors in a cache. It can also send out a train of echo messages under
circumstances that require fast notifications or re-synchronization of the cached
information.
udld detection- This command sets the amount of time the switch remains in detection state after
interval discovering a neighbor. Use the no form to restore the default setting.
Syntax
udld detection-interval detection-interval
no detection-interval
detection-interval – The amount of time the switch remains in detection
state after discovering a neighbor through UDLD. (Range: 5-255 seconds)
Default Setting
5 seconds
Command Mode
Global Configuration
– 475 –
Chapter 16 | UniDirectional Link Detection Commands
Command Usage
When a neighbor device is discovered by UDLD, the switch enters “detection state”
and remains in this state for specified detection-interval. After the detection-
interval expires, the switch tries to decide whether or the link is unidirectional
based on the information collected during “detection state.”
Example
Console(config)#udld detection-interval 10
Console(config)#
udld message-interval This command configures the message interval between UDLD probe messages for
ports in the advertisement phase and determined to be bidirectional. Use the no
form to restore the default setting.
Syntax
udld message-interval message-interval
no message-interval
message-interval – The interval at which a port sends UDLD probe
messages after linkup or detection phases. (Range: 7-90 seconds)
Default Setting
15 seconds
Command Mode
Global Configuration
Command Usage
During the detection phase, messages are exchanged at the maximum rate of one
per second. After that, if the protocol reaches a stable state and determines that the
link is bidirectional, the message interval is increased to a configurable value based
on a curve known as M1(t), a time-based function described in RFC 5171.
If the link is deemed anything other than bidirectional at the end of the detection
phase, this curve becomes a flat line with a fixed value of Mfast (7 seconds).
If the link is instead deemed bidirectional, the curve will use Mfast for the first four
subsequent message transmissions and then transition to an Mslow value for all
other steady-state transmissions. Mslow is the value configured by this command.
Example
This example sets the message interval to 10 seconds.
Console(config)#udld message-interval 10
Console(config)#
– 476 –
Chapter 16 | UniDirectional Link Detection Commands
udld recovery This command configures the switch to automatically recover from UDLD disabled
port state after a period specified by the udld recovery-interval command. Use the
no form to disable this feature.
Syntax
[no] udld recovery
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
When automatic recovery state is changed by this command, any ports shut down
by UDLD will be reset.
Example
Console(config)#udld recovery
Console(config)#
udld recovery-interval This command specifies the period after which to automatically recover from UDLD
disabled port state. Use the no form to restore the default setting.
Default Setting
300 seconds
Command Mode
Global Configuration
Command Usage
◆ This command is only applicable when automatic recovery has been enabled
with the udld recovery command.
◆ When the recovery interval is changed by this command, any ports shut down
by UDLD will be reset.
– 477 –
Chapter 16 | UniDirectional Link Detection Commands
Example
Console(config)#udld recovery-interval 30
Console(config)#
udld aggressive This command sets UDLD to aggressive mode on an interface. Use the no form to
restore the default setting.
Syntax
[no] udld aggressive
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet Port)
Command Usage
UDLD can function in two modes: normal mode and aggressive mode.
◆ In aggressive mode, UDLD will also shut down a port if it loses bidirectional
connectivity with the neighbor for the same extended period of time (as that
mentioned above for normal mode) and subsequently fails repeated last-resort
attempts to re-establish communication with the other end of the link. This
mode of operation assumes that loss of communication with the neighbor is a
meaningful network event in itself, and a symptom of a serious connectivity
problem. Because this type of detection can be event-less, and lack of
information cannot always be associated to an actual malfunction of the link,
this mode is recommended only in certain scenarios (typically only on point-to-
point links where no communication failure between two neighbors is
admissible).
– 478 –
Chapter 16 | UniDirectional Link Detection Commands
Example
This example enables UDLD aggressive mode on port 1.
udld port This command enables UDLD on a port. Use the no form to disable UDLD on an
interface.
Syntax
[no] udld port
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet Port)
Command Usage
◆ UDLD requires that all the devices connected to the same LAN segment be
running the protocol in order for a potential mis-configuration to be detected
and for prompt corrective action to be taken.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#udld port
Console(config-if)#
– 479 –
Chapter 16 | UniDirectional Link Detection Commands
show udld This command shows UDLD configuration settings and operational status for the
switch or for a specified interface.
Syntax
show udld [interface interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show udld
Message Interval : 15
Detection Interval : 5 seconds
Recovery : Disabled
Recovery Interval : 300 seconds
Console#
Message Interval The interval between UDLD probe messages for ports in advertisement phase
Detection Interval The period the switch remains in detection state after discovering a neighbor
Recovery Shows if automatic recovery from UDLD disabled port state is enabled
– 480 –
Chapter 16 | UniDirectional Link Detection Commands
Recovery Interval Shows the period after which to recover from UDLD disabled port state if
automatic recovery is enabled
Oper State Shows the UDLD operational state (Disabled, Link down, Link up,
Advertisement, Detection, Disabled port, Advertisement - Single neighbor,
Advertisement - Multiple neighbors)
Port State Shows the UDLD port state (Unknown, Bidirectional, Unidirectional, Transmit-
to-receive loop, Mismatch with neighbor state reported, Neighbor's echo is
empty)
The state is Unknown if the link is down or not connected to a UDLD-capable
device. The state is Bidirectional if the link has a normal two-way connection to
a UDLD-capable device. All other states indicate mis-wiring.
Msg Invl The interval between UDLD probe messages used for the indicated operational
state
Det Invl The period the switch remains in detection state after discovering a neighbor
– 481 –
Chapter 16 | UniDirectional Link Detection Commands
– 482 –
17 Address Table Commands
These commands are used to configure the address table for filtering specified
addresses, displaying current entries, clearing the table, or setting the aging time.
show mac-address-table Shows the aging time for the address table PE
aging-time
show mac-address-table Shows the number of MAC addresses used and the PE
count number of available MAC addresses
show mac-address-table Shows the hash lookup depth of MAC address table PE
hash-lookup-depth
mac-address-table This command sets the aging time for entries in the address table. Use the no form
aging-time to restore the default aging time.
Syntax
mac-address-table aging-time seconds
no mac-address-table aging-time
seconds - Aging time. (Range: 6-7200 seconds; 0 to disable aging)
Default Setting
300 seconds
Command Mode
Global Configuration
Command Usage
The aging time is used to age out dynamically learned forwarding information.
– 483 –
Chapter 17 | Address Table Commands
Example
Console(config)#mac-address-table aging-time 100
Console(config)#
mac-address-table This command sets the hash lookup depth used when searching the MAC address
hash-lookup-depth table. Use the no form to restore the default setting.
Syntax
mac-address-table hash-lookup-depth depth
no mac-address-table hash-lookup-depth
depth - The depth used in the hash lookup process. (Range: 4-32, in
multiples of 4)
Default Setting
4
Command Mode
Global Configuration
Command Usage
Using the default depth of 4, MAC address collisions tend to increase once more
than 8K entries have been learned. Setting the depth to a larger value reduces the
occurrence of hash collisions, but can also decrease forwarding performance.
Example
Console(config)#mac-address-table hash-lookup-depth 5
Console(config)#
mac-address-table This command maps a static address to a destination port in a VLAN. Use the no
static form to remove an address.
Syntax
mac-address-table static mac-address interface interface vlan vlan-id [action]
no mac-address-table static mac-address vlan vlan-id
mac-address - MAC address.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
– 484 –
Chapter 17 | Address Table Commands
Default Setting
No static addresses are defined. The default lifetime is permanent.
Command Mode
Global Configuration
Command Usage
The static address for a host device can be assigned to a specific port within a
specific VLAN. Use this command to add static addresses to the MAC Address Table.
Static addresses have the following characteristics:
◆ Static addresses will not be removed from the address table when a given
interface link is down.
◆ Static addresses are bound to the assigned interface and will not be moved.
When a static address is seen on another interface, the address will be ignored
and will not be written to the address table.
◆ A static address cannot be learned on another port until the address is removed
with the no form of this command.
Example
Console(config)#mac-address-table static 00-e0-29-94-34-de interface ethernet
1/1 vlan 1 delete-on-reset
Console(config)#
– 485 –
Chapter 17 | Address Table Commands
clear mac-address- This command removes any learned entries from the forwarding database.
table dynamic
Syntax
clear mac-address-table dynamic [[all] | [address mac-address [mask]] |
[interface interface] | [vlan vlan-id]]
all - all learned entries
address mac-address - MAC address.
mask - Bits to match in the address.
interface interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
vlan vlan-id - VLAN ID (Range: 1-4094)
Default Setting
None
Command Mode
Privileged Exec
Example
Console#clear mac-address-table dynamic all
Console#
– 486 –
Chapter 17 | Address Table Commands
show mac-address- This command shows classes of entries in the bridge-forwarding database.
table
Syntax
show mac-address-table [address mac-address [mask]] [interface interface]
[vlan vlan-id] [sort {address | vlan | interface}]
mac-address - MAC address.
mask - Bits to match in the address.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
vlan-id - VLAN ID (Range: 1-4094)
sort - Sort by address, vlan or interface.
Default Setting
None
Command Mode
Privileged Exec
Command Usage
◆ The MAC Address Table contains the MAC addresses associated with each
interface. Note that the Type field may include the following types:
■ Learn - Dynamic address entries
■ Config - Static entry
■ Security - Port Security
Example
Console#show mac-address-table
Interface MAC Address VLAN Type Life Time
--------- ----------------- ---- -------- -----------------
CPU 00-E0-00-00-00-01 1 CPU Delete on Reset
Eth 1/ 1 00-E0-0C-10-90-09 1 Learn Delete on Timeout
Eth 1/ 1 00-E0-29-94-34-64 1 Learn Delete on Timeout
Console#
– 487 –
Chapter 17 | Address Table Commands
show mac-address- This command shows the aging time for entries in the address table.
table aging-time
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show mac-address-table aging-time
Aging Status : Enabled
Aging Time: 300 sec.
Console#
show mac-address- This command shows the hash table algorithm configured and activated by the
table hash-algorithm switch.
Note: The switch must be rebooted for the activated hash algorithm to become
the same as the configured hash algorithm.
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show mac-address-table hash-algorithm
Configured Hash Algorithm: 0
Activated Hash Algorithm: 1
Console#
– 488 –
Chapter 17 | Address Table Commands
show mac-address- This command shows the number of MAC addresses used and the number of
table count available MAC addresses for the overall system or for an interface.
Syntax
show mac-address-table count [interface interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show mac-address-table count interface ethernet 1/1
show mac-address- This command shows the hash lookup depth used when searching the MAC
table hash-lookup- address table.
depth
Syntax
show mac-address-table hash-lookup-depth
Command Mode
Privileged Exec
– 489 –
Chapter 17 | Address Table Commands
Example
Console#show mac-address-table hash-lookup-depth
Configured Hash Lookup Depth: 4
Activated Hash Lookup Depth: 4
Console#
– 490 –
18 TWAMP Commands
twamp reflector This command enables the TWAMP Session-Reflector globally on the switch. Use
the no form to disable the TWAMP reflector function.
Syntax
twamp reflector
no twamp reflector
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
The switch only supports the function of a Session-Reflector (RFC 5357). As a
Reflector, the switch can receive test packets from a Session Sender and send test
packet responses.
– 491 –
Chapter 18 | TWAMP Commands
Example
Console(config)#twamp reflector
Console(config)#
twamp reflector This command sets the TWAMP session timeout on the switch. Use the no form to
refwait restore the default.
Syntax
twamp reflector refwait seconds
no twamp reflector refwait
seconds - The timeout value in seconds. (Range: 30-3600)
Default Setting
900 seconds
Command Mode
Global Configuration
Command Usage
The Session-Reflector will discontinue any session that has been started when no
packet associated with that session has been received for the timeout period.
Example
Console(config)#twamp reflector refwait 300
Console(config)#
show twamp reflector This command shows the configured TWAMP Reflector settings and sessions on
the switch.
Command Mode
Privileged Exec
Example
Console#show twamp reflector
TWAMP Reflector Status: Enabled
TWAMP Reflector REFWAIT: 900 seconds
TWAMP Reflector Mode: Unauthenticated
Total number of sessions: 0
– 492 –
19 Spanning Tree Commands
This section includes commands that configure the Spanning Tree Algorithm (STA)
globally for the switch, and commands that configure STA for the selected
interface.
spanning-tree Floods BPDUs to all other ports or just to all other ports in GC
system-bpdu-flooding the same VLAN when global spanning tree is disabled
name Configures the name for the multiple spanning tree MST
revision Configures the revision number for the multiple spanning MST
tree
– 493 –
Chapter 19 | Spanning Tree Commands
spanning-tree mst cost Configures the path cost of an instance in the MST IC
spanning-tree This command enables the Spanning Tree Algorithm globally for the switch. Use
the no form to disable it.
Syntax
[no] spanning-tree
Default Setting
Spanning tree is disabled.
Command Mode
Global Configuration
– 494 –
Chapter 19 | Spanning Tree Commands
Command Usage
◆ The Spanning Tree Algorithm (STA) can be used to detect and disable network
loops, and to provide backup links between switches, bridges or routers. This
allows the switch to interact with other bridging devices (that is, an STA-
compliant switch, bridge or router) in your network to ensure that only one
route exists between any two stations on the network, and provide backup
links which automatically take over when a primary link goes down.
Example
This example shows how to enable the Spanning Tree Algorithm for the switch:
Console(config)#spanning-tree
Console(config)#
spanning-tree This command configures spanning tree operation to be compatible with Cisco
cisco-prestandard prestandard versions. Use the no form to restore the default setting.
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
Cisco prestandard versions prior to Cisco IOS Release 12.2(25)SEC do not fully
follow the IEEE standard, causing some state machine procedures to function
incorrectly. The command forces the spanning tree protocol to function in a
manner compatible with Cisco prestandard versions.
Example
Console(config)#spanning-tree cisco-prestandard
Console(config)#
spanning-tree This command configures the spanning tree bridge forward time globally for this
forward-time switch. Use the no form to restore the default setting.
Syntax
spanning-tree forward-time seconds
no spanning-tree forward-time
seconds - Time in seconds. (Range: 4 - 30 seconds)
The minimum value is the higher of 4 or [(max-age / 2) + 1].
– 495 –
Chapter 19 | Spanning Tree Commands
Default Setting
15 seconds
Command Mode
Global Configuration
Command Usage
This command sets the maximum time (in seconds) a port will wait before
changing states (i.e., discarding to learning to forwarding). This delay is required
because every device must receive information about topology changes before it
starts to forward frames. In addition, each port needs time to listen for conflicting
information that would make it return to the discarding state; otherwise, temporary
data loops might result.
Example
Console(config)#spanning-tree forward-time 20
Console(config)#
spanning-tree This command configures the spanning tree bridge hello time globally for this
hello-time switch. Use the no form to restore the default.
Syntax
spanning-tree hello-time time
no spanning-tree hello-time
time - Time in seconds. (Range: 1-10 seconds).
The maximum value is the lower of 10 or [(max-age / 2) - 1].
Default Setting
2 seconds
Command Mode
Global Configuration
Command Usage
This command sets the time interval (in seconds) at which the root device transmits
a configuration message.
Example
Console(config)#spanning-tree hello-time 5
Console(config)#
Related Commands
spanning-tree forward-time (495)
spanning-tree max-age (497)
– 496 –
Chapter 19 | Spanning Tree Commands
spanning-tree This command configures the spanning tree bridge maximum age globally for this
max-age switch. Use the no form to restore the default.
Syntax
spanning-tree max-age seconds
no spanning-tree max-age
seconds - Time in seconds. (Range: 6-40 seconds)
The minimum value is the higher of 6 or [2 x (hello-time + 1)].
The maximum value is the lower of 40 or [2 x (forward-time - 1)].
Default Setting
20 seconds
Command Mode
Global Configuration
Command Usage
This command sets the maximum time (in seconds) a device can wait without
receiving a configuration message before attempting to reconverge. All device
ports (except for designated ports) should receive configuration messages at
regular intervals. Any port that ages out STA information (provided in the last
configuration message) becomes the designated port for the attached LAN. If it is a
root port, a new root port is selected from among the device ports attached to the
network.
Example
Console(config)#spanning-tree max-age 40
Console(config)#
Related Commands
spanning-tree forward-time (495)
spanning-tree hello-time (496)
spanning-tree mode This command selects the spanning tree mode for this switch. Use the no form to
restore the default.
Syntax
spanning-tree mode {stp | rstp | mstp}
no spanning-tree mode
stp - Spanning Tree Protocol (IEEE 802.1D)
rstp - Rapid Spanning Tree Protocol (IEEE 802.1w)
mstp - Multiple Spanning Tree (IEEE 802.1s)
– 497 –
Chapter 19 | Spanning Tree Commands
Default Setting
rstp
Command Mode
Global Configuration
Command Usage
◆ Spanning Tree Protocol
This option uses RSTP set to STP forced compatibility mode. It uses RSTP for the
internal state machine, but sends only 802.1D BPDUs. This creates one
spanning tree instance for the entire network. If multiple VLANs are
implemented on a network, the path between specific VLAN members may be
inadvertently disabled to prevent network loops, thus isolating group
members. When operating multiple VLANs, we recommend selecting the MSTP
option.
■ STP Mode – If the switch receives an 802.1D BPDU after a port’s migration
delay timer expires, the switch assumes it is connected to an 802.1D bridge
and starts using only 802.1D BPDUs.
■ RSTP Mode – If RSTP is using 802.1D BPDUs on a port and receives an RSTP
BPDU after the migration delay expires, RSTP restarts the migration delay
timer and begins using RSTP BPDUs on that port.
■ To allow multiple spanning trees to operate over the network, you must
configure a related set of bridges with the same MSTP configuration,
allowing them to participate in a specific set of spanning tree instances.
■ A spanning tree instance can exist only on bridges that have compatible
VLAN instance assignments.
Example
The following example configures the switch to use Rapid Spanning Tree:
– 498 –
Chapter 19 | Spanning Tree Commands
spanning-tree This command changes to Multiple Spanning Tree (MST) configuration mode.
mst configuration
Syntax
spanning-tree mst configuration
Default Setting
No VLANs are mapped to any MST instance.
The region name is set the switch’s MAC address.
Command Mode
Global Configuration
Example
Console(config)#spanning-tree mst configuration
Console(config-mstp)#
Related Commands
mst vlan (504)
mst priority (503)
name (505)
revision (505)
max-hops (503)
spanning-tree This command configures the path cost method used for Rapid Spanning Tree and
pathcost method Multiple Spanning Tree. Use the no form to restore the default.
Syntax
spanning-tree pathcost method {long | short}
no spanning-tree pathcost method
long - Specifies 32-bit based values that range from 1-200,000,000.
This method is based on the IEEE 802.1w Rapid Spanning Tree Protocol.
short - Specifies 16-bit based values that range from 1-65535.
This method is based on the IEEE 802.1D Spanning Tree Protocol.
Default Setting
Long method
Command Mode
Global Configuration
Command Usage
◆ The path cost method is used to determine the best path between devices.
Therefore, lower values should be assigned to ports attached to faster media,
– 499 –
Chapter 19 | Spanning Tree Commands
and higher values assigned to ports with slower media. Note that path cost
(page 508) takes precedence over port priority (page 516).
◆ The path cost methods apply to all spanning tree modes (STP, RSTP and MSTP).
Specifically, the long method can be applied to STP since this mode is
supported by a backward compatible mode of RSTP.
Example
Console(config)#spanning-tree pathcost method long
Console(config)#
spanning-tree priority This command configures the spanning tree priority globally for this switch. Use
the no form to restore the default.
Syntax
spanning-tree priority priority
no spanning-tree priority
priority - Priority of the bridge. (Range – 0-61440, in steps of 4096; Options:
0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768, 36864, 40960,
45056, 49152, 53248, 57344, 61440)
Default Setting
32768
Command Mode
Global Configuration
Command Usage
Bridge priority is used in selecting the root device, root port, and designated port.
The device with the highest priority (i.e., lower numeric value) becomes the STA
root device. However, if all devices have the same priority, the device with the
lowest MAC address will then become the root device.
Example
Console(config)#spanning-tree priority 40960
Console(config)#
– 500 –
Chapter 19 | Spanning Tree Commands
spanning-tree This command configures how the system floods BPDUs to other ports when
system-bpdu-flooding spanning tree is disabled globally on the switch or disabled on specific ports. Use
the no form to restore the default.
Syntax
spanning-tree system-bpdu-flooding {to-all | to-vlan}
no spanning-tree system-bpdu-flooding
to-all - Floods BPDUs to all other spanning-tree disabled ports on the
switch.
to-vlan - Floods BPDUs to all other spanning-tree disabled ports within the
receiving port’s native VLAN (i.e., as determined by port’s PVID).
Default Setting
Floods to all other spanning-tree disabled ports in the same VLAN.
Command Mode
Global Configuration
Command Usage
The spanning-tree system-bpdu-flooding command has no effect if BPDU
flooding is disabled on a port (see the spanning-tree port-bpdu-flooding
command).
Example
Console(config)#spanning-tree system-bpdu-flooding to-all
Console(config)#
spanning-tree tc-prop This command configures a topology change propagation domain. Use the no
form to remove a propagation domain.
Syntax
spanning-tree tc-prop group group-id {ethernet interface |
port-channel trunk-id}
group-id - Group identifier. (Range: 1-255)
interface - unit/port
unit - Unit identifier. (Range: 1)
port - Port number or list of ports. To enter a list, separate
nonconsecutive port identifiers with a comma and no spaces; use a
hyphen to designate a range of ports. (Range: 1-28)
trunk-id - Trunk index (Range: 1-28)
– 501 –
Chapter 19 | Spanning Tree Commands
Default Setting
All ports and trunks belong to a common group.
Command Mode
Global Configuration
Command Usage
A port can only belong to one group. When an interface is added to a group, it is
removed from the default group. When a TCN BPDU or BPDU with the TC flag set is
received on an interface, that interface will only notify members in same group to
propagate this topology change.
Example
Console(config)#spanning-tree tc-prop group 1 ethernet 1/1-5
Console(config)#
Syntax
spanning-tree transmission-limit count
no spanning-tree transmission-limit
count - The transmission limit number. (Range: 1-10)
Default Setting
3
Command Mode
Global Configuration
Command Usage
This command limits the number of BPDUs transmitted within the configured Hello
Time interval.
Example
Console(config)#spanning-tree transmission-limit 4
Console(config)#
– 502 –
Chapter 19 | Spanning Tree Commands
max-hops This command configures the maximum number of hops in the region before a
BPDU is discarded. Use the no form of the command to set the number of hops to
the default value.
Syntax
max-hops hop-number
no max-hops
hop-number - Maximum hop number for multiple spanning tree.
(Range: 1-40)
Default Setting
20
Command Mode
MST Configuration
Command Usage
An MSTI region is treated as a single node by the STP and RSTP protocols. Therefore,
the message age for BPDUs inside an MSTI region is never changed. However, each
spanning tree instance within a region, and the internal spanning tree (IST) that
connects these instances use a hop count to specify the maximum number of
bridges that will propagate a BPDU. Each bridge decrements the hop count by one
before passing on the BPDU. When the hop count reaches zero, the message is
dropped.
Example
Console(config-mstp)#max-hops 30
Console(config-mstp)#
mst priority This command configures the priority of a spanning tree instance. Use the no form
to restore the default.
Syntax
mst instance-id priority priority
no mst instance-id priority
instance-id - Instance identifier of the spanning tree. (Range: 0-4094)
priority - Priority of the a spanning tree instance.
(Range: 0-61440 in steps of 4096; Options: 0, 4096, 8192, 12288, 16384,
20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344,
61440)
Default Setting
32768
– 503 –
Chapter 19 | Spanning Tree Commands
Command Mode
MST Configuration
Command Usage
◆ MST priority is used in selecting the root bridge and alternate bridge of the
specified instance. The device with the highest priority (i.e., lowest numerical
value) becomes the MSTI root device. However, if all devices have the same
priority, the device with the lowest MAC address will then become the root
device.
◆ You can set this switch to act as the MSTI root device by specifying a priority of
0, or as the MSTI alternate device by specifying a priority of 16384.
Example
Console(config-mstp)#mst 1 priority 4096
Console(config-mstp)#
mst vlan This command adds VLANs to a spanning tree instance. Use the no form to remove
the specified VLANs. Using the no form without any VLAN parameters to remove all
VLANs.
Syntax
[no] mst instance-id vlan vlan-range
instance-id - Instance identifier of the spanning tree. (Range: 0-4094)
vlan-range - Range of VLANs. (Range: 1-4094)
Default Setting
none
Command Mode
MST Configuration
Command Usage
◆ Use this command to group VLANs into spanning tree instances. MSTP
generates a unique spanning tree for each instance. This provides multiple
pathways across the network, thereby balancing the traffic load, preventing
wide-scale disruption when a bridge node in a single instance fails, and
allowing for faster convergence of a new topology for the failed instance.
◆ By default all VLANs are assigned to the Internal Spanning Tree (MSTI 0) that
connects all bridges and LANs within the MST region. This switch supports up
to 64 instances. You should try to group VLANs which cover the same general
area of your network. However, remember that you must configure all bridges
within the same MSTI Region (page 505) with the same set of instances, and the
same instance (on each bridge) with the same set of VLANs. Also, note that
– 504 –
Chapter 19 | Spanning Tree Commands
RSTP treats each MSTI region as a single node, connecting all regions to the
Common Spanning Tree.
Example
Console(config-mstp)#mst 1 vlan 2-5
Console(config-mstp)#
name This command configures the name for the multiple spanning tree region in which
this switch is located. Use the no form of the command to set the name to the
default name.
Syntax
name name
no name
name - Name of multiple spanning tree region. (Range: 1-32 alphanumeric
characters)
Default Setting
Switch’s MAC address
Command Mode
MST Configuration
Command Usage
The MST region name and revision number (page 505) are used to designate a
unique MST region. A bridge (i.e., spanning-tree compliant device such as this
switch) can only belong to one MST region. And all bridges in the same region must
be configured with the same MST instances.
Example
Console(config-mstp)#name R&D
Console(config-mstp)#
Related Commands
revision (505)
revision This command configures the revision number for this multiple spanning tree
configuration of this switch. Use the no form of the command to set the revision
number to the default value.
Syntax
revision number
– 505 –
Chapter 19 | Spanning Tree Commands
no revision
number - Revision number of the spanning tree. (Range: 0-65535)
Default Setting
0
Command Mode
MST Configuration
Command Usage
The MST region name (page 505) and revision number are used to designate a
unique MST region. A bridge (i.e., spanning-tree compliant device such as this
switch) can only belong to one MST region. And all bridges in the same region must
be configured with the same MST instances.
Example
Console(config-mstp)#revision 1
Console(config-mstp)#
Related Commands
name (505)
spanning-tree This command allows you to avoid transmitting BPDUs on configured edge ports
bpdu-filter that are connected to end nodes. Use the no form to disable this feature.
Syntax
[no] spanning-tree bpdu-filter
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ This command stops all Bridge Protocol Data Units (BPDUs) from being
transmitted on configured edge ports to save CPU processing time. This
function is designed to work in conjunction with edge ports which should only
connect end stations to the switch, and therefore do not need to process
BPDUs. However, note that if a trunking port connected to another switch or
bridging device is mistakenly configured as an edge port, and BPDU filtering is
enabled on this port, this might cause a loop in the spanning tree.
◆ BPDU filter can only be configured on an interface if the edge port attribute is
not disabled (that is, if edge port is set to enabled or auto with the spanning-
tree edge-port command).
– 506 –
Chapter 19 | Spanning Tree Commands
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree edge-port
Console(config-if)#spanning-tree bpdu-filter
Console(config-if)#
Related Commands
spanning-tree edge-port (509)
spanning-tree This command shuts down an edge port (i.e., an interface set for fast forwarding) if
bpdu-guard it receives a BPDU. Use the no form without any keywords to disable this feature, or
with a keyword to restore the default settings.
Syntax
spanning-tree bpdu-guard [auto-recovery [interval interval]]
no spanning-tree bpdu-guard [auto-recovery [interval]]
auto-recovery - Automatically re-enables an interface after the specified
interval.
interval - The time to wait before re-enabling an interface. (Range: 30-86400
seconds)
Default Setting
BPDU Guard: Disabled
Auto-Recovery: Disabled
Auto-Recovery Interval: 300 seconds
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ An edge port should only be connected to end nodes which do not generate
BPDUs. If a BPDU is received on an edge port, this indicates an invalid network
configuration, or that the switch may be under attack by a hacker. If an
interface is shut down by BPDU Guard, it must be manually re-enabled using
the no shutdown command if the auto-recovery interval is not specified.
◆ BPDU guard can only be configured on an interface if the edge port attribute is
not disabled (that is, if edge port is set to enabled or auto with the spanning-
tree edge-port command).
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree edge-port
Console(config-if)#spanning-tree bpdu-guard
Console(config-if)#
– 507 –
Chapter 19 | Spanning Tree Commands
Related Commands
spanning-tree edge-port (509)
spanning-tree spanning-disabled (518)
spanning-tree cost This command configures the spanning tree path cost for the specified interface.
Use the no form to restore the default auto-configuration mode.
Syntax
spanning-tree cost cost
no spanning-tree cost
cost - The path cost for the port. (Range: 0 for auto-configuration, 1-65535
for short path cost method, 1-200,000,000 for long path cost method)11
Table 96: Recommended STA Path Cost Range
Port Type Short Path Cost Long Path Cost
(IEEE 802.1D-1998) (IEEE 802.1D-2004)
Default Setting
By default, the system automatically detects the speed and duplex mode used on
each port, and configures the path cost according to the values shown below. Path
cost “0” is used to indicate auto-configuration mode. When the short path cost
method is selected and the default path cost recommended by the IEEE 8021w
standard exceeds 65,535, the default is set to 65,535.
Command Mode
Interface Configuration (Ethernet, Port Channel)
11. Use the spanning-tree pathcost method command to set the path cost method. The range
displayed in the CLI prompt message shows the maximum value for path cost. However,
note that the switch still enforces the rules for path cost based on the specified path cost
method (long or short).
– 508 –
Chapter 19 | Spanning Tree Commands
Command Usage
◆ This command is used by the Spanning Tree Algorithm to determine the best
path between devices. Therefore, lower values should be assigned to ports
attached to faster media, and higher values assigned to ports with slower
media.
◆ When the path cost method (page 499) is set to short, the maximum value for
path cost is 65,535.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree cost 50
Console(config-if)#
spanning-tree This command specifies an interface as an edge port. Use the no form to restore the
edge-port default.
Syntax
spanning-tree edge-port [auto]
no spanning-tree edge-port
auto - Automatically determines if an interface is an edge port.
Default Setting
Auto
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ You can enable this option if an interface is attached to a LAN segment that is at
the end of a bridged LAN or to an end node. Since end nodes cannot cause
forwarding loops, they can pass directly through to the spanning tree
forwarding state. Specifying Edge Ports provides quicker convergence for
devices such as workstations or servers, retains the current forwarding
database to reduce the amount of frame flooding required to rebuild address
tables during reconfiguration events, does not cause the spanning tree to
initiate reconfiguration when the interface changes state, and also overcomes
other STA-related time out problems. However, remember that Edge Port
should only be enabled for ports connected to an end-node device.
– 509 –
Chapter 19 | Spanning Tree Commands
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree edge-port
Console(config-if)#
spanning-tree This command configures the link type for Rapid Spanning Tree and Multiple
link-type Spanning Tree. Use the no form to restore the default.
Syntax
spanning-tree link-type {auto | point-to-point | shared}
no spanning-tree link-type
auto - Automatically derived from the duplex mode setting.
point-to-point - Point-to-point link.
shared - Shared medium.
Default Setting
auto
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ Specify a point-to-point link if the interface can only be connected to exactly
one other bridge, or a shared link if it can be connected to two or more bridges.
◆ When automatic detection is selected, the switch derives the link type from the
duplex mode. A full-duplex interface is considered a point-to-point link, while a
half-duplex interface is assumed to be on a shared link.
◆ RSTP only works on point-to-point links between two bridges. If you designate
a port as a shared link, RSTP is forbidden. Since MSTP is an extension of RSTP,
this same restriction applies.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree link-type point-to-point
– 510 –
Chapter 19 | Spanning Tree Commands
spanning-tree This command enables the detection and response to Spanning Tree loopback
loopback-detection BPDU packets on the port. Use the no form to disable this feature.
Syntax
[no] spanning-tree loopback-detection
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ If Port Loopback Detection is not enabled and a port receives it’s own BPDU,
then the port will drop the loopback BPDU according to IEEE Standard 802.1W-
2001 9.3.4.
◆ Port Loopback Detection will not be active if Spanning Tree is disabled on the
switch.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree loopback-detection
spanning-tree This command configures the response for loopback detection to shut down the
loopback-detection interface. Use the no form to restore the default.
action
Syntax
spanning-tree loopback-detection action {shutdown duration}
no spanning-tree loopback-detection action
shutdown - Shuts down the interface.
duration - The duration to shut down the interface.
(Range: 60-86400 seconds)
Default Setting
shutdown, 60 seconds
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ If an interface is shut down by this command, and the release mode is set to
“auto” with the spanning-tree loopback-detection release-mode command, the
– 511 –
Chapter 19 | Spanning Tree Commands
◆ If an interface is shut down by this command, and the release mode is set to
“manual,” the interface can be re-enabled using the spanning-tree
loopback-detection release command.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree loopback-detection action shutdown 600
Console(config-if)#
spanning-tree This command configures the release mode for a port that was placed in the
loopback-detection discarding state because a loopback BPDU was received. Use the no form to restore
release-mode the default.
Syntax
spanning-tree loopback-detection release-mode {auto | manual}
no spanning-tree loopback-detection release-mode
auto - Allows a port to automatically be released from the discarding state
when the loopback state ends.
manual - The port can only be released from the discarding state manually.
Default Setting
auto
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ If the port is configured for automatic loopback release, then the port will only
be returned to the forwarding state if one of the following conditions is
satisfied:
■ The port receives any other BPDU except for it’s own, or;
■ The port’s link status changes to link down and then link up again, or;
■ The port ceases to receive it’s own BPDUs in a forward delay interval.
◆ If Port Loopback Detection is not enabled and a port receives it’s own BPDU,
then the port will drop the loopback BPDU according to IEEE Standard 802.1W-
2001 9.3.4 (Note 1).
◆ Port Loopback Detection will not be active if Spanning Tree is disabled on the
switch.
– 512 –
Chapter 19 | Spanning Tree Commands
◆ When configured for manual release mode, then a link down / up event will not
release the port from the discarding state. It can only be released using the
spanning-tree loopback-detection release command.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree loopback-detection release-mode manual
Console(config-if)#
spanning-tree This command enables SNMP trap notification for Spanning Tree loopback BPDU
loopback-detection detections. Use the no form to restore the default.
trap
Syntax
[no] spanning-tree loopback-detection trap
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree loopback-detection trap
spanning-tree This command prevents a TCNs from being propagated from a switch port to other
restricted-tcn ports. Use the no form to restore the default setting.
Syntax
[no] spanning-tree restricted-tcn
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Commnad Usage
This command prevents a switch from propagating Topology Change Notifications
(TCNs) to other ports on the switch.
– 513 –
Chapter 19 | Spanning Tree Commands
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree restricted-tcn
spanning-tree This command configures the path cost on a spanning instance in the Multiple
mst cost Spanning Tree. Use the no form to restore the default auto-configuration mode.
Syntax
spanning-tree mst instance-id cost cost
no spanning-tree mst instance-id cost
instance-id - Instance identifier of the spanning tree. (Range: 0-4094)
cost - Path cost for an interface. (Range: 0 for auto-configuration, 1-65535
for short path cost method12, 1-200,000,000 for long path cost method)
The recommended path cost range is listed in Table 96 on page 508.
Default Setting
By default, the system automatically detects the speed and duplex mode used on
each port, and configures the path cost according to the values shown in Table 97.
Path cost “0” is used to indicate auto-configuration mode. When the short path cost
method is selected and the default path cost recommended by the IEEE 8021w
standard exceeds 65,535, the default is set to 65,535. The default path costs are
listed in Table 97 on page 508.
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ Each spanning-tree instance is associated with a unique set of VLAN IDs.
Example
Console(config)#interface Ethernet 1/5
Console(config-if)#spanning-tree mst 1 cost 50
Console(config-if)#
12. Use the spanning-tree pathcost method command to set the path cost method.
– 514 –
Chapter 19 | Spanning Tree Commands
Related Commands
spanning-tree mst port-priority (515)
spanning-tree This command configures the interface priority on a spanning instance in the
mst port-priority Multiple Spanning Tree. Use the no form to restore the default.
Syntax
spanning-tree mst instance-id port-priority priority
no spanning-tree mst instance-id port-priority
instance-id - Instance identifier of the spanning tree. (Range: 0-4094)
priority - Priority for an interface. (Range: 0-240 in steps of 16)
Default Setting
128
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ This command defines the priority for the use of an interface in the multiple
spanning-tree. If the path cost for all interfaces on a switch are the same, the
interface with the highest priority (that is, lowest value) will be configured as an
active link in the spanning tree.
◆ Where more than one interface is assigned the highest priority, the interface
with lowest numeric identifier will be enabled.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree mst 1 port-priority 0
Console(config-if)#
Related Commands
spanning-tree mst cost (514)
spanning-tree This command floods BPDUs to other ports when spanning tree is disabled globally
port-bpdu-flooding or disabled on a specific port. Use the no form to restore the default setting.
Syntax
[no] spanning-tree port-bpdu-flooding
Default Setting
Enabled
– 515 –
Chapter 19 | Spanning Tree Commands
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ When enabled, BPDUs are flooded to all other spanning-tree disabled ports on
the switch or within the receiving port's native VLAN as specified by the
spanning-tree system-bpdu-flooding command.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree port-bpdu-flooding
Console(config-if)#
spanning-tree This command configures the priority for the specified interface. Use the no form to
port-priority restore the default.
Syntax
spanning-tree port-priority priority
no spanning-tree port-priority
priority - The priority for a port. (Range: 0-240, in steps of 16)
Default Setting
128
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ This command defines the priority for the use of a port in the Spanning Tree
Algorithm. If the path cost for all ports on a switch are the same, the port with
the highest priority (that is, lowest value) will be configured as an active link in
the spanning tree.
◆ Where more than one port is assigned the highest priority, the port with lowest
numeric identifier will be enabled.
◆ The criteria used for determining the port role is based on root bridge ID, root
path cost, designated bridge, designated port, port priority, and port number,
in that order and as applicable to the role under question.
– 516 –
Chapter 19 | Spanning Tree Commands
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree port-priority 0
Related Commands
spanning-tree cost (508)
spanning-tree This command prevents a designated port13 from taking superior BPDUs into
root-guard account and allowing a new STP root port to be elected. Use the no form to disable
this feature.
Syntax
[no] spanning-tree root-guard
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ A bridge with a lower bridge identifier (or same identifier and lower MAC
address) can take over as the root bridge at any time.
◆ When Root Guard is enabled, and the switch receives a superior BPDU on this
port, it is set to the Discarding state until it stops receiving superior BPDUs for a
fixed recovery period. While in the discarding state, no traffic is forwarded
across the port.
◆ Root Guard can be used to ensure that the root bridge is not formed at a
suboptimal location. Root Guard should be enabled on any designated port
connected to low-speed bridges which could potentially overload a slower link
by taking over as the root port and forming a new spanning tree topology. It
could also be used to form a border around part of the network where the root
bridge is allowed.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#spanning-tree root-guard
Console(config-if)#
– 517 –
Chapter 19 | Spanning Tree Commands
spanning-tree This command disables the spanning tree algorithm for the specified interface. Use
spanning-disabled the no form to re-enable the spanning tree algorithm for the specified interface.
Syntax
[no] spanning-tree spanning-disabled
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
When spanning tree is enabled globally (spanning-tree command) or enabled on
an interface by this command, loopback detection is disabled.
Example
This example disables the spanning tree algorithm for port 5.
spanning-tree This command stops the propagation of topology change notifications (TCN for
tc-prop-stop STP) and topology change messages (TC for RSTP/MSTP). Use the no form to allow
propagation of TCN/TC messages.
Syntax
[no] spanning-tree tc-prop-stop
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
When this command is enabled on an interface, topology change information
originating from the interface will still be propagated.
– 518 –
Chapter 19 | Spanning Tree Commands
Example
Console(config)#interface ethernet 1/1
Console(config-if)#spanning-tree tc-prop-stop
Console(config-if)#
spanning-tree This command manually releases a port placed in discarding state by loopback-
loopback-detection detection.
release
Syntax
spanning-tree loopback-detection release interface
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
Command Usage
Use this command to release an interface from discarding state if loopback
detection release mode is set to “manual” by the spanning-tree loopback-detection
release-mode command and BPDU loopback occurs.
Example
Console#spanning-tree loopback-detection release ethernet 1/1
Console#
spanning-tree This command re-checks the appropriate BPDU format to send on the selected
protocol-migration interface.
Syntax
spanning-tree protocol-migration interface
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
– 519 –
Chapter 19 | Spanning Tree Commands
Command Mode
Privileged Exec
Command Usage
If at any time the switch detects STP BPDUs, including Configuration or Topology
Change Notification BPDUs, it will automatically set the selected interface to forced
STP-compatible mode. However, you can also use the spanning-tree protocol-
migration command at any time to manually re-check the appropriate BPDU
format to send on the selected interfaces (i.e., RSTP or STP-compatible).
Example
Console#spanning-tree protocol-migration ethernet 1/5
Console#
show spanning-tree This command shows the configuration for the common spanning tree (CST), for all
instances within the multiple spanning tree (MST), or for a specific instance within
the multiple spanning tree (MST).
Syntax
show spanning-tree [interface | mst instance-id [brief | interface] | brief |
stp-enabled-only]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
instance-id - Instance identifier of the multiple spanning tree.
(Range: 0-4094)
brief - Shows a summary of global and interface settings.
stp-enabled-only - Displays global settings, and settings for interfaces for
which STP is enabled.
Default Setting
None
Command Mode
Privileged Exec
Command Usage
◆ Use the show spanning-tree command with no parameters to display the
spanning tree configuration for the switch for the Common Spanning Tree
(CST) and for every interface in the tree.
– 520 –
Chapter 19 | Spanning Tree Commands
◆ Use the show spanning-tree interface command to display the spanning tree
configuration for an interface within the Common Spanning Tree (CST).
◆ Use the show spanning-tree mst command to display the spanning tree
configuration for all instances within the Multiple Spanning Tree (MST),
including global settings and settings for active interfaces.
Example
Console#show spanning-tree
Spanning Tree Information
---------------------------------------------------------------
Spanning Tree Mode : MSTP
Spanning Tree Enabled/Disabled : Enabled
Instance : 0
VLANs Configured : 1-4094
Priority : 32768
Bridge Hello Time (sec.) : 2
Bridge Max. Age (sec.) : 20
Bridge Forward Delay (sec.) : 15
Root Hello Time (sec.) : 2
Root Max. Age (sec.) : 20
Root Forward Delay (sec.) : 15
Max. Hops : 20
Remaining Hops : 20
Designated Root : 32768.0.0001ECF8D8C6
Current Root Port : 21
Current Root Cost : 100000
Number of Topology Changes : 5
Last Topology Change Time (sec.): 11409
Transmission Limit : 3
Path Cost Method : Long
Flooding Behavior : To VLAN
Cisco Prestandard : Disabled
---------------------------------------------------------------
Eth 1/ 1 Information
---------------------------------------------------------------
Admin Status : Enabled
Role : Disabled
State : Discarding
External Admin Path Cost : 0
Internal Admin Path Cost : 0
External Oper Path Cost : 100000
Internal Oper Path Cost : 100000
Priority : 128
Designated Cost : 100000
Designated Port : 128.1
Designated Root : 32768.0.0001ECF8D8C6
Designated Bridge : 32768.0.123412341234
Forward Transitions : 4
Admin Edge Port : Disabled
Oper Edge Port : Disabled
Admin Link Type : Auto
Oper Link Type : Point-to-point
Flooding Behavior : Enabled
Spanning-Tree Status : Enabled
Loopback Detection Status : Enabled
Loopback Detection Release Mode : Auto
– 521 –
Chapter 19 | Spanning Tree Commands
This example shows a brief summary of global and interface setting for the
spanning tree.
show spanning-tree This command shows the configuration of the multiple spanning tree.
mst configuration
Command Mode
Privileged Exec
Example
Console#show spanning-tree mst configuration
Mstp Configuration Information
--------------------------------------------------------------
Configuration Name : R&D
Revision Level :0
Instance VLANs
--------------------------------------------------------------
0 1-4094
Console#
– 522 –
Chapter 19 | Spanning Tree Commands
show spanning-tree This command shows the configuration of topology change propagation domains.
tc-prop
Syntax
show spanning-tree tc-prop [group group-id]
group-id - Group identifier. (Range: 1-255)
Command Mode
Privileged Exec
Example
Console#show spanning-tree tc-prop group 1
Group 1
Eth 1/ 1, Eth 1/ 2, Eth 1/ 3, Eth 1/ 4, Eth 1/ 5
Console#
– 523 –
Chapter 19 | Spanning Tree Commands
– 524 –
20 VLAN Commands
A VLAN is a group of ports that can be located anywhere in the network, but
communicate as though they belong to the same physical segment. This section
describes commands used to create VLAN groups, add port members, specify how
VLAN tagging is used, and enable automatic VLAN registration for the selected
interface.
GVRP and Bridge Extension Configures GVRP settings that permit automatic VLAN learning; shows
Commands the configuration for bridge extension MIB
Editing VLAN Groups Sets up VLAN groups, including name, VID and state
Configuring VLAN Configures VLAN interface parameters, including ingress and egress
Interfaces tagging mode, ingress filtering, and PVID
Displaying VLAN Displays VLAN groups, status, port members, and MAC addresses
Information
Configuring VLAN Maps VLAN ID between customer and service provider for networks
Translation2 that do not support IEEE 802.1Q tunneling
Configuring Protocol-based Configures protocol-based VLANs based on frame type and protocol
VLANs2
Configuring IP Subnet Configures IP Subnet-based VLANs
VLANs2
Configuring Voice VLANs Configures VoIP traffic detection and enables a Voice VLAN
– 525 –
Chapter 20 | VLAN Commands
GVRP and Bridge Extension Commands
garp timer Sets the GARP timer for the selected function IC
show garp timer Shows the GARP timer for the selected function NE, PE
show gvrp configuration Displays GVRP configuration for the selected interface NE, PE
bridge-ext gvrp This command enables GVRP globally for the switch. Use the no form to disable it.
Syntax
[no] bridge-ext gvrp
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
GVRP defines a way for switches to exchange VLAN information in order to register
VLAN members on ports across the network. This function should be enabled to
permit automatic VLAN registration, and to support VLANs which extend beyond
the local switch.
Example
Console(config)#bridge-ext gvrp
Console(config)#
– 526 –
Chapter 20 | VLAN Commands
GVRP and Bridge Extension Commands
garp timer This command sets the values for the join, leave and leaveall timers. Use the no
form to restore the timers’ default values.
Syntax
garp timer {join | leave | leaveall} timer-value
no garp timer {join | leave | leaveall}
{join | leave | leaveall} - Timer to set.
timer-value - Value of timer.
Ranges:
join: 20-1000 centiseconds
leave: 60-3000 centiseconds
leaveall: 500-18000 centiseconds
Default Setting
join: 20 centiseconds
leave: 60 centiseconds
leaveall: 1000 centiseconds
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ Group Address Registration Protocol is used by GVRP and GMRP to register or
deregister client attributes for client services within a bridged LAN. The default
values for the GARP timers are independent of the media access method or
data rate. These values should not be changed unless you are experiencing
difficulties with GMRP or GVRP registration/deregistration.
◆ Timer values are applied to GVRP for all the ports on all VLANs.
Note: Set GVRP timers on all Layer 2 devices connected in the same network to the
same values. Otherwise, GVRP may not operate successfully.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#garp timer join 100
Console(config-if)#
– 527 –
Chapter 20 | VLAN Commands
GVRP and Bridge Extension Commands
Related Commands
show garp timer (530)
switchport forbidden This command configures forbidden VLANs. Use the no form to remove the list of
vlan forbidden VLANs.
Syntax
switchport forbidden vlan {add vlan-list | remove vlan-list}
no switchport forbidden vlan
add vlan-list - List of VLAN identifiers to add.
remove vlan-list - List of VLAN identifiers to remove.
vlan-list - Separate nonconsecutive VLAN identifiers with a comma and no
spaces; use a hyphen to designate a range of IDs. (Range: 1-4094).
Default Setting
No VLANs are included in the forbidden list.
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ This command prevents a VLAN from being automatically added to the
specified interface via GVRP using the switchport gvrp command.
◆ If a VLAN has been added to the set of allowed VLANs for an interface, then you
cannot add it to the set of forbidden VLANs for that same interface.
◆ GVRP cannot be enabled for ports set to Access mode (see the switchport
mode command).
◆ This command will not be accepted if the specified VLAN does not exist on the
switch.
Example
The following example shows how to prevent port 1 from being added to VLAN 3:
– 528 –
Chapter 20 | VLAN Commands
GVRP and Bridge Extension Commands
switchport gvrp This command enables GVRP for a port. Use the no form to disable it.
Syntax
[no] switchport gvrp
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
GVRP cannot be enabled for ports set to Access mode using the switchport mode
command.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#switchport gvrp
Console(config-if)#
show bridge-ext This command shows the configuration for bridge extension commands.
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show bridge-ext
Maximum Supported VLAN Numbers : 4094
Maximum Supported VLAN ID : 4094
Extended Multicast Filtering Services : No
Static Entry Individual Port : Yes
VLAN Version Number : 2
VLAN Learning : IVL
Configurable PVID Tagging : Yes
Local VLAN Capable : No
Traffic Classes : Enabled
Global GVRP Status : Disabled
Console#
– 529 –
Chapter 20 | VLAN Commands
GVRP and Bridge Extension Commands
Extended Multicast This switch does not support the filtering of individual multicast addresses
Filtering Services based on GMRP (GARP Multicast Registration Protocol).
Static Entry This switch allows static filtering for unicast and multicast addresses. (Refer to
Individual Port the mac-address-table static command.)
VLAN Version Based on IEEE 802.1Q, “1” indicates Bridges that support only single spanning
Number tree (SST) operation, and “2” indicates Bridges that support multiple spanning
tree (MST) operation.
VLAN Learning This switch uses Independent VLAN Learning (IVL), where each port maintains
its own filtering database.
Configurable PVID This switch allows you to override the default Port VLAN ID (PVID used in frame
Tagging tags) and egress status (VLAN-Tagged or Untagged) on each port. (Refer to the
switchport allowed vlan command.)
Local VLAN Capable This switch does not support multiple local bridges outside of the scope of
802.1Q defined VLANs.
Traffic Classes This switch provides mapping of user priorities to multiple traffic classes. (Refer
to “Class of Service Commands” on page 607.)
Global GVRP Status GARP VLAN Registration Protocol defines a way for switches to exchange VLAN
information in order to automatically register VLAN members on interfaces
across the network. This field shows if GVRP is globally enabled or disabled.
(Refer to the bridge-ext gvrp command.)
show garp timer This command shows the GARP timers for the selected interface.
Syntax
show garp timer [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
Shows all GARP timers.
Command Mode
Normal Exec, Privileged Exec
– 530 –
Chapter 20 | VLAN Commands
Editing VLAN Groups
Example
Console#show garp timer ethernet 1/1
Eth 1/ 1 GARP Timer Status:
Join Timer : 20 centiseconds
Leave Timer : 60 centiseconds
Leave All Timer : 1000 centiseconds
Console#
Related Commands
garp timer (527)
Default Setting
Shows both global and interface-specific configuration.
Command Mode
Normal Exec, Privileged Exec
Example
Console#show gvrp configuration ethernet 1/7
Eth 1/ 7:
GVRP Configuration : Disabled
Console#
vlan database Enters VLAN database mode to add, change, and delete GC
VLANs
– 531 –
Chapter 20 | VLAN Commands
Editing VLAN Groups
vlan database This command enters VLAN database mode. All commands in this mode will take
effect immediately.
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ Use the VLAN database command mode to add, change, and delete VLANs.
After finishing configuration changes, you can display the VLAN settings by
entering the show vlan command.
◆ Use the interface vlan command mode to define the port membership mode
and add or remove ports from a VLAN. The results of these commands are
written to the running-configuration file, and you can display this file by
entering the show running-config command.
Example
Console(config)#vlan database
Console(config-vlan)#
Related Commands
show vlan (541)
vlan This command configures a VLAN. Use the no form to restore the default settings or
delete a VLAN.
Syntax
vlan vlan-id [name vlan-name] media ethernet [state {active | suspend}]
[rspan]
no vlan vlan-id [name | state]
vlan-id - VLAN ID, specified as a single number, a range of consecutive
numbers separated by a hyphen, or multiple numbers separated by
commas. (Range: 1-4094)
name - Keyword to be followed by the VLAN name.
vlan-name - ASCII string from 1 to 32 characters.
media ethernet - Ethernet media type.
state - Keyword to be followed by the VLAN state.
active - VLAN is operational.
suspend - VLAN is suspended. Suspended VLANs do not pass packets.
– 532 –
Chapter 20 | VLAN Commands
Configuring VLAN Interfaces
Note: Ports can only be added to an RSPAN VLAN using the commands described
under “RSPAN Mirroring Commands”.
Default Setting
By default only VLAN 1 exists and is active.
Command Mode
VLAN Database Configuration
Command Usage
◆ no vlan vlan-id deletes the VLAN.
◆ no vlan vlan-id name removes the VLAN name.
◆ no vlan vlan-id state returns the VLAN to the default state (i.e., active).
◆ You can configure up to 4094 VLANs on the switch.
Example
The following example adds a VLAN, using VLAN ID 105 and name RD5. The VLAN is
activated by default.
Console(config)#vlan database
Console(config-vlan)#vlan 105 name RD5 media ethernet
Console(config-vlan)#
Related Commands
show vlan (541)
– 533 –
Chapter 20 | VLAN Commands
Configuring VLAN Interfaces
switchport priority default Sets a port priority for incoming untagged frames IC
interface vlan This command enters interface configuration mode for VLANs, which is used to
configure VLAN parameters for a physical interface. Use the no form to change a
Layer 3 normal VLAN back to a Layer 2 interface.
Syntax
[no] interface vlan vlan-id
vlan-id - ID of the configured VLAN. (Range: 1-4094)
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ Creating a “normal” VLAN with the vlan command initializes it as a Layer 2
interface. To change it to a Layer 3 interface, use the interface command to
enter interface configuration for the desired VLAN, enter any Layer 3
configuration commands, and save the configuration settings.
◆ To change a Layer 3 normal VLAN back to a Layer 2 VLAN, use the no interface
command.
Example
The following example shows how to set the interface configuration mode to
VLAN 1, and then assign an IP address to the VLAN:
Console(config)#interface vlan 1
Console(config-if)#ip address 192.168.1.254 255.255.255.0
Console(config-if)#
– 534 –
Chapter 20 | VLAN Commands
Configuring VLAN Interfaces
Related Commands
shutdown (403)
interface (397)
vlan (532)
switchport This command configures the acceptable frame types for a port. Use the no form to
acceptable-frame- restore the default.
types
Syntax
switchport acceptable-frame-types {all | tagged}
no switchport acceptable-frame-types
all - The port accepts all frames, tagged or untagged.
tagged - The port only receives tagged frames.
Default Setting
All frame types
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
When set to receive all frame types, any received frames that are untagged are
assigned to the port default VLAN if not matched to a configured MAC VLAN, IP-
subnet VLAN, or protocol VLAN.
Example
The following example shows how to restrict the traffic received on port 1 to
tagged frames:
Related Commands
switchport mode (538)
switchport This command configures VLAN groups on the selected interface. Use the no form
allowed vlan to restore the default.
Syntax
switchport allowed vlan {vlan-list | add vlan-list [tagged | untagged] |
remove vlan-list}
no switchport allowed vlan
– 535 –
Chapter 20 | VLAN Commands
Configuring VLAN Interfaces
vlan-list - If a VLAN list is entered without using the add option, the
interface is assigned to the specified VLANs, and membership in all
previous VLANs is removed. The interface is added as an untagged member
if switchport mode is set to hybrid or access, or as an tagged member if
switchport mode is set to trunk.
Separate nonconsecutive VLAN identifiers with a comma and no spaces;
use a hyphen to designate a range of IDs. (Range: 1-4094).
add vlan-list - List of VLAN identifiers to add. When the add option is used,
the interface is assigned to the specified VLANs, and membership in all
previous VLANs is retained.
remove vlan-list - List of VLAN identifiers to remove.
Default Setting
All ports are assigned to VLAN 1 by default.
The default frame type is untagged.
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ If a port or trunk has switchport mode set to access, then only one VLAN can be
added with this command. If a VLAN list is specified, only the last VLAN in the
list will be added to the interface.
◆ If a port or trunk has switchport mode set to trunk (i.e., 1Q Trunk), then you can
only assign the interface to VLAN groups as a tagged member.
◆ Frames are always tagged within the switch. The tagged/untagged parameter
used when adding a VLAN to an interface tells the switch whether to keep or
remove the tag from a frame on egress.
◆ If none of the intermediate network devices nor the host at the other end of the
connection supports VLANs, the interface should be added to these VLANs as
an untagged member. Otherwise, it is only necessary to add at most one VLAN
as untagged, and this should correspond to the native VLAN for the interface.
◆ Ports can only be added to an RSPAN VLAN using the commands described
under “RSPAN Mirroring Commands”.
– 536 –
Chapter 20 | VLAN Commands
Configuring VLAN Interfaces
Example
The following example shows how to add VLANs 1, 2, 5 and 6 to the allowed list as
tagged VLANs for port 1:
switchport This command enables ingress filtering for an interface. Use the no form to restore
ingress-filtering the default.
Syntax
[no] switchport ingress-filtering
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ If ingress filtering is disabled and a port receives frames classified to VLANs for
which it is not a member, these frames will be flooded to all other ports that are
members of the VLANs.
◆ If ingress filtering is enabled and a port receives frames classified to VLANs for
which it is not a member, these frames will be discarded.
◆ Ingress filtering does not affect VLAN independent BPDU frames, such as GVRP
or STA. However, they do affect VLAN dependent BPDU frames, such as GMRP.
◆ Ingress filtering cannot be enabled for a port if the port does not join the PVID
VLAN.
◆ Ingress filtering cannot be disabled for a port if loopback detection on the port
is active. (Both global and per port are enabled.)
Example
The following example shows how to set the interface to port 1 and then enable
ingress filtering:
– 537 –
Chapter 20 | VLAN Commands
Configuring VLAN Interfaces
switchport mode This command configures the VLAN membership mode for a port. Use the no form
to restore the default.
Syntax
switchport mode {access | hybrid | trunk}
no switchport mode
access - Specifies an access VLAN interface. The port transmits and receives
untagged frames on a single VLAN only.
hybrid - Specifies a hybrid VLAN interface. The port may transmit tagged or
untagged frames.
trunk - Specifies a port as an end-point for a VLAN trunk. A trunk is a direct
link between two switches, so the port transmits tagged frames that
identify the source VLAN. Note that frames belonging to the port’s default
VLAN (i.e., associated with the PVID) are also transmitted as tagged frames.
Default Setting
All ports are in hybrid mode with the PVID set to VLAN 1.
Command Mode
Interface Configuration (Ethernet, Port Channel)
Example
The following shows how to set the configuration mode to port 1, and then set the
switchport mode to hybrid:
Related Commands
switchport acceptable-frame-types (535)
switchport native vlan This command configures the PVID (i.e., port VLAN ID) for a port. Use the no form to
restore the default.
Syntax
switchport native vlan vlan-id
no switchport native vlan
vlan-id - Default VLAN ID for a port. (Range: 1-4094)
Default Setting
VLAN 1
– 538 –
Chapter 20 | VLAN Commands
Configuring VLAN Interfaces
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ When changing the PVID for a port using access mode, the port will
automatically join the new PVID VLAN and leave the VLAN which it had joined
before.
◆ When using Access mode, and an interface is assigned to a new VLAN, its PVID
is automatically set to the identifier for that VLAN.
◆ The PVID can be set to any VLAN that the port does not join when using hybrid
or trunk mode, and ingress filtering is disabled.
◆ The PVID can only be set to a VLAN that the port joins when using hybrid or
trunk mode, and ingress filtering is enabled.
Example
The following example shows how to set the PVID for port 1 to VLAN 3:
vlan-trunking This command allows unknown VLAN groups to pass through the specified
interface. Use the no form to disable this feature.
Syntax
[no] vlan-trunking
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ Use this command to configure a tunnel across one or more intermediate
switches which pass traffic for VLAN groups to which they do not belong.
The following figure shows VLANs 1 and 2 configured on switches A and B, with
VLAN trunking being used to pass traffic for these VLAN groups across switches
C, D and E.
– 539 –
Chapter 20 | VLAN Commands
Configuring VLAN Interfaces
Without VLAN trunking, you would have to configure VLANs 1 and 2 on all
intermediate switches – C, D and E; otherwise these switches would drop any
frames with unknown VLAN group tags. However, by enabling VLAN trunking
on the intermediate switch ports along the path connecting VLANs 1 and 2,
you only need to create these VLAN groups in switches A and B. Switches C, D
and E automatically allow frames with VLAN group tags 1 and 2 (groups that
are unknown to those switches) to pass through their VLAN trunking ports.
◆ VLAN trunking is mutually exclusive with the “access” switchport mode (see the
switchport mode command). If VLAN trunking is enabled on an interface, then
that interface cannot be set to access mode, and vice versa.
◆ To prevent loops from forming in the spanning tree, all unknown VLANs will be
bound to a single instance (either STP/RSTP or an MSTP instance, depending on
the selected STA mode).
◆ If both VLAN trunking and ingress filtering are disabled on an interface, packets
with unknown VLAN tags will still be allowed to enter this interface and will be
flooded to all other ports where VLAN trunking is enabled. (In other words,
VLAN trunking will still be effectively enabled for the unknown VLAN).
Example
The following example enables VLAN trunking on ports 27 and 28 to establish a
path across the switch for unknown VLAN groups:
– 540 –
Chapter 20 | VLAN Commands
Displaying VLAN Information
show interfaces status vlan Displays status for the specified VLAN interface NE, PE
show interfaces switchport Displays the administrative and operational status of an NE, PE
interface
Syntax
show vlan [id vlan-id | name vlan-name]
id - Keyword to be followed by the VLAN ID.
vlan-id - ID of the configured VLAN. (Range: 1-4094)
name - Keyword to be followed by the VLAN name.
vlan-name - ASCII string from 1 to 32 characters.
Default Setting
Shows all VLANs.
Command Mode
Normal Exec, Privileged Exec
Example
The following example shows how to display information for VLAN 1:
Console#show vlan id 1
VLAN ID : 1
Type : Static
Name : DefaultVlan
Status : Active
Ports/Port Channels : Eth1/ 1(S) Eth1/ 2(S) Eth1/ 3(S) Eth1/ 4(S) Eth1/ 5(S)
Eth1/ 6(S) Eth1/ 7(S) Eth1/ 8(S) Eth1/ 9(S) Eth1/10(S)
Eth1/11(S) Eth1/12(S) Eth1/13(S) Eth1/14(S) Eth1/15(S)
Eth1/16(S) Eth1/17(S) Eth1/18(S)
Console#
– 541 –
Chapter 20 | VLAN Commands
Configuring IEEE 802.1Q Tunneling
dot1q-tunnel tpid Configures the other tag ethertype for QinQ tunneling GC
4. Set the Tag Protocol Identifier (TPID) value of the tunnel access port. This step is
required if the attached client is using a nonstandard 2-byte ethertype to
identify 802.1Q tagged frames. The standard ethertype value is 0x8100. (See
dot1q-tunnel tpid.)
5. Configure the QinQ tunnel access port to join the SPVLAN as an untagged
member (switchport allowed vlan).
6. Configure the SPVLAN ID as the native VID on the QinQ tunnel access port
(switchport native vlan).
– 542 –
Chapter 20 | VLAN Commands
Configuring IEEE 802.1Q Tunneling
8. Configure the QinQ tunnel uplink port to join the SPVLAN as a tagged member
(switchport allowed vlan).
◆ The native VLAN for the tunnel uplink ports and tunnel access ports cannot be
the same. However, the same service VLANs can be set on both tunnel port
types.
◆ If the spanning tree protocol is enabled, be aware that a tunnel access or tunnel
uplink port may be disabled if the spanning tree structure is automatically
reconfigured to overcome a break in the tree. It is therefore advisable to disable
spanning tree on these ports.
dot1q-tunnel This command sets the switch to operate in QinQ mode. Use the no form to disable
system-tunnel-control QinQ operating mode.
Syntax
[no] dot1q-tunnel system-tunnel-control
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
QinQ tunnel mode must be enabled on the switch for QinQ interface settings to be
functional.
Example
Console(config)#dot1q-tunnel system-tunnel-control
Console(config)#
Related Commands
show dot1q-tunnel (549)
show interfaces switchport (413)
– 543 –
Chapter 20 | VLAN Commands
Configuring IEEE 802.1Q Tunneling
dot1q-tunnel tpid Use this command to set the global setting for the QinQ outer tag ethertype field.
Use the no form of the command to set the ethertype field to the default value.
Syntax
[no] dot1q-tunnel tpid ethertype
ethertype – A specific Ethernet protocol number. (Range: 800-ffff hex)
Default Setting
The ethertype is set to 0x8100
Command Mode
Global Configuration
Command Usage
Use the dot1q-tunnel tpid command to set the global custom 802.1Q ethertype.
This feature allows the switch to interoperate with third-party switches that do not
use the standard 0x8100 ethertype to identify 802.1Q-tagged frames. For example,
if 0x1234 is set as the global 802.1Q ethertype, incoming frames on trunk ports
containing that ethertype are assigned to the VLAN contained in the tag following
the ethertype field. Frames arriving on trunk ports containing any other ethertype
are looked upon as untagged frames, and assigned to the native VLAN of the port.
The specified ethertype only applies to ports configured in Uplink mode using the
switchport dot1q-tunnel mode command. If the port is in normal mode (i.e,
unspecified), the TPID is always 0x8100. If the port is in Access mode, received
packets are processes as untagged packets.
Example
Console(config)#dot1q-tunnel tpid 0x88A8
Console(config)#
Related Commands
show dot1q-tunnel (549)
switchport dot1q-tunnel mode (545)
– 544 –
Chapter 20 | VLAN Commands
Configuring IEEE 802.1Q Tunneling
switchport This command configures an interface as a QinQ tunnel port. Use the no form to
dot1q-tunnel mode disable QinQ on the interface.
Syntax
switchport dot1q-tunnel mode {access | uplink}
no switchport dot1q-tunnel mode
access – Sets the port as an 802.1Q tunnel access port.
uplink – Sets the port as an 802.1Q tunnel uplink port.
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ QinQ tunneling must be enabled on the switch using the dot1q-tunnel
system-tunnel-control command before the switchport dot1q-tunnel mode
interface command can take effect.
◆ When a tunnel uplink port receives a packet from a customer, the customer tag
(regardless of whether there are one or more tag layers) is retained in the inner
tag, and the service provider’s tag added to the outer tag.
◆ When a tunnel uplink port receives a packet from the service provider, the
outer service provider’s tag is stripped off, and the packet passed on to the
VLAN indicated by the inner tag. If no inner tag is found, the packet is passed
onto the native VLAN defined for the uplink port.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#switchport dot1q-tunnel mode access
Console(config-if)#
Related Commands
show dot1q-tunnel (549)
show interfaces switchport (413)
switchport dot1q- This command copies the inner tag priority to the outer tag priority. Use the no
tunnel priority map form to disable this feature.
Syntax
[no] switchport dot1q-tunnel priority map
– 545 –
Chapter 20 | VLAN Commands
Configuring IEEE 802.1Q Tunneling
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
When priority bits are found in the inner tag, these are also copied to the outer tag.
This allows the service provider to differentiate service based on the indicated
priority and appropriate methods of queue management at intermediate nodes
across the tunnel.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#switchport dot1q-tunnel priority map
Console(config-if)#
switchport This command creates a CVLAN to SPVLAN mapping entry. Use the no form to
dot1q-tunnel service delete a VLAN mapping entry.
match cvid
Syntax
switchport dot1q-tunnel service svid match cvid cvid
no switchport dot1q-tunnel service [svid [match cvid cvid]]
svid - VLAN ID for the outer VLAN tag (Service Provider VID). (Range: 1-4094)
cvid - VLAN ID for the inner VLAN tag (Customer VID). (Range: 1-4094)
Default Setting
Default mapping uses the PVID of the ingress port on the edge router for the SPVID.
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ The inner VLAN tag of a customer packet entering the edge router of a service
provider’s network is mapped to an outer tag indicating the service provider
VLAN that will carry this traffic across the 802.1Q tunnel. This process is
performed in a transparent manner.
◆ When priority bits are found in the inner tag, these are also copied to the outer
tag. This allows the service provider to differentiate service based on the
indicated priority and appropriate methods of queue management at
intermediate nodes across the tunnel.
◆ Rather than relying on standard service paths and priority queuing, QinQ VLAN
mapping can be used to further enhance service by defining a set of
– 546 –
Chapter 20 | VLAN Commands
Configuring IEEE 802.1Q Tunneling
Example
This example sets the SVID to 99 in the outer tag for egress packets exiting port 1
when the packet’s CVID is 2.
The following example maps C-VLAN 10 to S-VLAN 100, C-VLAN 20 to S-VLAN 200
and C-VLAN 30 to S-VLAN 300 for ingress traffic on port 1 of Switches A and B.
Switch C
Port 1 Port 2
[SVID 100, CVID 10] [SVID 100, CVID 10]
[SVID 200, CVID 20] [SVID 200, CVID 20]
[SVID 300, CVID 30] [SVID 300, CVID 30]
Port 2 Port 2
Port 1 Port 1
[VID 10]
Switch A Switch B [VID 10]
[VID 20] [VID 20]
[VID 30] [VID 30]
2. Enable QinQ.
Console(config)#dot1q-tunnel system-tunnel-control
3. Configure port 2 as a tagged member of VLANs 100, 200 and 300 using uplink
mode.
Console(config)#interface ethernet 1/2
Console(config-if)#switchport allowed vlan add 100,200,300 tagged
Console(config-if)#switchport dot1q-tunnel mode uplink
4. Configures port 1 as an untagged member of VLANs 100, 200 and 300 using
access mode.
Console(config)#interface ethernet 1/1
Console(config-if)#switchport allowed vlan add 100,200,300 untagged
Console(config-if)#switchport dot1q-tunnel mode access
– 547 –
Chapter 20 | VLAN Commands
Configuring IEEE 802.1Q Tunneling
Eth 1/ 3 10 100
Eth 1/ 3 20 200
Eth 1/ 3 30 300
2. Configure port 1 and port 2 as tagged members of VLAN 100, 200 and 300.
Console(config)#interface ethernet 1/1,2
Console(config-if)#switchport allowed vlan add 100,200,300 tagged
show dot1q-tunnel This command shows tunnel service subscriptions, default discard service, and
service discarded untagged traffic configuration.
Syntax
show dot1q-tunnel service [svid]
svid - VLAN ID for the outer VLAN tag (SPVID). (Range: 1-4094)
Command Mode
Privileged Exec
Example
Console#show dot1q service
802.1Q Tunnel Service Subscriptions
– 548 –
Chapter 20 | VLAN Commands
Configuring IEEE 802.1Q Tunneling
Console#
show dot1q-tunnel This command displays information about QinQ tunnel ports.
Syntax
show dot1q-tunnel [interface interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Example
Console(config)#dot1q-tunnel system-tunnel-control
Console(config)#interface ethernet 1/1
Console(config-if)#switchport dot1q-tunnel mode access
Console(config-if)#interface ethernet 1/2
Console(config-if)#switchport dot1q-tunnel mode uplink
Console(config-if)#end
Console#show dot1q-tunnel
802.1Q Tunnel Status : Enabled
802.1Q Tunnel TPID : 8100 (Hex)
– 549 –
Chapter 20 | VLAN Commands
Configuring L2PT Tunneling
Eth 1/ 6 1 100
Console#
Related Commands
dot1q-tunnel tpid (544)
l2protocol-tunnel This command configures the destination address for Layer 2 Protocol Tunneling
tunnel-dmac (L2PT). Use the no form to restore the default setting.
Syntax
l2protocol-tunnel tunnel-dmac mac-address
no l2protocol-tunnel tunnel-dmac
mac-address – The switch rewrites the destination MAC address in all
upstream L2PT protocol packets (i.e, STP BPDUs) to this value, and forwards
them on to uplink ports. The MAC address must be specified in the format
xx-xx-xx-xx-xx-xx or xxxxxxxxxxxx.
The tunnel address can be any multicast address, except for the following:
■ IPv4 multicast addresses (with prefix 01-00-5E)
■ IPv6 multicast addresses (with prefix 33-33-33)
■ Addresses used by the spanning tree protocol.
Default Setting
01-12-CF-.00-00-02, proprietary tunnel address
Command Mode
Global Configuration
– 550 –
Chapter 20 | VLAN Commands
Configuring L2PT Tunneling
Command Usage
◆ When L2PT is not used, protocol packets (such as STP) are flooded to 802.1Q
access ports on the same edge switch, but filtered from 802.1Q tunnel ports.
This creates disconnected protocol domains in the customer’s network.
◆ L2PT can be used to pass various types of protocol packets belonging to the
same customer transparently across a service provider’s network. In this way,
normally segregated network segments can be configured to function inside a
common protocol domain.
◆ The way in which L2PT processes packets is based on the following criteria – (1)
packet is received on a QinQ uplink port, (2) packet is received on a QinQ access
port, or (3) received packet is Cisco-compatible L2PT (i.e., as indicated by a
proprietary MAC address).
◆ When a protocol packet is received on an access port (i.e., an 802.1Q trunk port
connecting the edge switch to the local customer network)
■ L2PT is enabled on the port, the frame is forwarded to all QinQ uplink
ports and QinQ access ports on which L2PT is enabled for that protocol
in the same S-VLAN.
– 551 –
Chapter 20 | VLAN Commands
Configuring L2PT Tunneling
■ other access ports for which L2PT is enabled after decapsulating the
packet and restoring the proper protocol and MAC address
information.
■ all uplink ports.
◆ When a Cisco-compatible L2PT packet is received on an access port, and
– 552 –
Chapter 20 | VLAN Commands
Configuring L2PT Tunneling
Example
Console(config)#dot1q-tunnel system-tunnel-control
Console(config)#l2protocol-tunnel tunnel-dmac 01-80-C2-00-00-01
Console(config-)#
switchport This command enables Layer 2 Protocol Tunneling (L2PT) for the specified protocol.
l2protocol-tunnel Use the no form to disable L2PT for the specified protocol.
Syntax
[no] switchport l2protocol-tunnel {cdp | lacp | lldp | pvst+ | spanning-tree |
vtp}
cdp - Cisco Discovery Protocol
lacp - Link Aggregation Control Protocol
lldp - Link Layer Discovery Protocol
pvst+ - Cisco Per VLAN Spanning Tree Plus
spanning-tree - Spanning Tree (STP, RSTP, MSTP)
vtp - Cisco VLAN Trunking Protocol
Default Setting
Disabled for all protocols
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ Refer to the Command Usage section for the l2protocol-tunnel tunnel-dmac
command.
◆ For L2PT to function properly, QinQ must be enabled on the switch using the
dot1q-tunnel system-tunnel-control command, and the interface configured to
802.1Q tunnel mode using the dot1q-tunnel tpid command.
Example
Console(config)#dot1q-tunnel system-tunnel-control
Console(config)#interface ethernet 1/1
Console(config-if)#switchport dot1q-tunnel mode access
Console(config-if)#switchport l2protocol-tunnel spanning-tree
Console(config-if)#
– 553 –
Chapter 20 | VLAN Commands
Configuring VLAN Translation
show This command shows settings for Layer 2 Protocol Tunneling (L2PT).
l2protocol-tunnel
Command Mode
Privileged Exec
Example
Console#show l2protocol-tunnel
Layer 2 Protocol Tunnel
Interface Protocol
----------------------------------------------------------
Eth 1/ 1 Spanning Tree
Console#
switchport vlan-translation Maps VLAN IDs between the customer and service provider IC
show vlan-translation Displays the configuration settings for VLAN translation PE
switchport This command maps VLAN IDs between the customer and service provider.
vlan-translation
Syntax
switchport vlan-translation [ingress | egress] original-vlan new-vlan
no switchport vlan-translation [ingress | egress] original-vlan
– 554 –
Chapter 20 | VLAN Commands
Configuring VLAN Translation
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ If the next switch upstream does not support QinQ tunneling, then use this
command to map the customer’s VLAN ID to the service provider’s VLAN ID for
the upstream port. Similarly, if the next switch downstream does not support
QinQ tunneling, then use this command to map the service provider’s VLAN ID
to the customer’s VLAN ID for the downstream port. Note that one command
maps both the original-vlan to new-vlan for ingress traffic and the new-vlan to
original-vlan for egress traffic on the specified port.
For example, assume that the upstream switch does not support QinQ
tunneling. If the command switchport vlan-translation 10 100 is used to map
VLAN 10 to VLAN 100 for upstream traffic entering port 1, and VLAN 100 to
VLAN 10 for downstream traffic leaving port 1, then the VLAN IDs will be
swapped as shown below.
Figure 5: Configuring VLAN Translation
(VLAN 10) (VLAN 100)
upstream
1 2
(VLAN 100) (VLAN 10)
downstream
◆ The maximum number of VLAN translation entries is 8 per port, and up to 96 for
the system. However, note that configuring a large number of entries may
degrade the performance of other processes that also use the TCAM, such as IP
Source Guard filter rules, Quality of Service (QoS) processes, QinQ, MAC-based
VLANs, VLAN translation, or traps.
◆ If VLAN translation is set on an interface with this command, and the same
interface is also configured as a QinQ access port with the dot1q-tunnel tpid
command, VLAN tag assignments will be determined by the QinQ process, not
by VLAN translation.
Example
This example configures VLAN translation for Port 1 as described in the Command
Usage section above.
Console(config)#vlan database
Console(config-vlan)#vlan 10 media ethernet state active
– 555 –
Chapter 20 | VLAN Commands
Configuring VLAN Translation
Console#
show vlan-translation This command displays the configuration settings for VLAN translation.
Syntax
show vlan-translation [egress [interface interface] | ingress
[interface interface]| interface interface]
egress - Show configuration settings for egress ports.
ingress - Show configuration settings for ingress ports.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show vlan-translation
– 556 –
Chapter 20 | VLAN Commands
Configuring Protocol-based VLANs
Eth 1/ 2 200 10
Console#
To avoid these problems, you can configure this switch with protocol-based VLANs
that divide the physical network into logical VLAN groups for each required
protocol. When a frame is received at a port, its VLAN membership can then be
determined based on the protocol type in use by the inbound packets.
show interfaces Shows the interfaces mapped to a protocol group and the PE
protocol-vlan corresponding VLAN
protocol-group
1. First configure VLAN groups for the protocols you want to use (page 532).
Although not mandatory, we suggest configuring a separate VLAN for each
major protocol running on your network. Do not add port members at this
time.
2. Create a protocol group for each of the protocols you want to assign to a VLAN
using the protocol-vlan protocol-group command (Global Configuration
mode).
3. Then map the protocol for each interface to the appropriate VLAN using the
protocol-vlan protocol-group command (Interface Configuration mode).
Note: Traffic which matches IP Protocol Ethernet Frames is mapped to the VLAN
that has been configured with the switch’s administrative IP interface (default VLAN
1). IP Protocol Ethernet traffic must not be mapped to another VLAN or you will lose
administrative network connectivity to the switch. If lost in this manner, network
– 557 –
Chapter 20 | VLAN Commands
Configuring Protocol-based VLANs
access can be regained by removing the offending Protocol VLAN rule via the
console. Alternately, the switch can be power-cycled, however all unsaved
configuration changes will be lost.
protocol-vlan This command creates a protocol group, or adds specific protocols to a group. Use
protocol-group the no form to remove a protocol group.
(Configuring Groups)
Syntax
protocol-vlan protocol-group group-id [{add | remove}
frame-type frame protocol-type protocol]
no protocol-vlan protocol-group group-id
group-id - Group identifier of this protocol group. (Range: 1-2147483647)
frame15 - Frame type used by this protocol. (Options: ethernet, rfc_1042,
llc_other)
protocol - Protocol type. The only option for the llc_other frame type is
ipx_raw. The options for all other frames types include: arp, ip, ipv6, pppoe-
dis, pppoe-ses, rarp.
Default Setting
No protocol groups are configured.
Command Mode
Global Configuration
Example
The following creates protocol group 1, and specifies Ethernet frames with IP and
ARP protocol types:
protocol-vlan This command maps a protocol group to a VLAN for the current interface. Use the
protocol-group no form to remove the protocol mapping for this interface.
(Configuring Interfaces)
Syntax
protocol-vlan protocol-group group-id vlan vlan-id [priority priority]
no protocol-vlan protocol-group group-id
group-id - Group identifier of this protocol group. (Range: 1-2147483647)
15. SNAP frame types are not supported by this switch due to hardware limitations.
– 558 –
Chapter 20 | VLAN Commands
Configuring Protocol-based VLANs
Default Setting
No protocol groups are mapped for any interface.
Priority: 0
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ When creating a protocol-based VLAN, only assign interfaces via this
command. If you assign interfaces using any of the other VLAN commands
(such as the vlan command), these interfaces will admit traffic of any protocol
type into the associated VLAN.
◆ When a frame enters a port that has been assigned to a protocol VLAN, it is
processed in the following manner:
■ If the frame is untagged and the protocol type matches, the frame is
forwarded to the appropriate VLAN.
■ If the frame is untagged but the protocol type does not match, the frame is
forwarded to the default VLAN for this interface.
Example
The following example maps the traffic entering Port 1 which matches the protocol
type specified in protocol group 1 to VLAN 2.
show protocol-vlan This command shows the frame and protocol type associated with protocol groups.
protocol-group
Syntax
show protocol-vlan protocol-group [group-id] [sort-by-type]
– 559 –
Chapter 20 | VLAN Commands
Configuring Protocol-based VLANs
Default Setting
All protocol groups are displayed.
Command Mode
Privileged Exec
Example
This shows protocol group 1 configured for IP over Ethernet:
show interfaces This command shows the mapping from protocol groups to VLANs for the selected
protocol-vlan interfaces.
protocol-group
Syntax
show interfaces protocol-vlan protocol-group [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
The mapping for all interfaces is displayed.
Command Mode
Privileged Exec
Example
This shows that traffic entering Port 1 that matches the specifications for protocol
group 1 will be mapped to VLAN 2:
– 560 –
Chapter 20 | VLAN Commands
Configuring IP Subnet VLANs
subnet-vlan This command configures IP Subnet VLAN assignments. Use the no form to remove
an IP subnet-to-VLAN assignment.
Syntax
subnet-vlan subnet ip-address mask vlan vlan-id [priority priority]
no subnet-vlan subnet {ip-address mask | all}
ip-address – The IP address that defines the subnet. Valid IP addresses
consist of four decimal numbers, 0 to 255, separated by periods.
mask – This mask identifies the host address bits of the IP subnet.
vlan-id – VLAN to which matching IP subnet traffic is forwarded.
(Range: 1-4094)
priority – The priority assigned to untagged ingress traffic. (Range: 0-7,
where 7 is the highest priority)
Default Setting
Priority: 0
Command Mode
Global Configuration
Command Usage
◆ Each IP subnet can be mapped to only one VLAN ID. An IP subnet consists of an
IP address and a subnet mask. The specified VLAN need not be an existing
VLAN.
– 561 –
Chapter 20 | VLAN Commands
Configuring IP Subnet VLANs
Example
The following example assigns traffic for the subnet 192.168.12.192, mask
255.255.255.224, to VLAN 4.
Command Mode
Privileged Exec
Command Usage
◆ Use this command to display subnet-to-VLAN mappings.
◆ The last matched entry is used if more than one entry can be matched.
Example
The following example displays all configured IP subnet-based VLANs.
Console#show subnet-vlan
IP Address Mask VLAN ID Priority
--------------- --------------- ------- --------
192.168.12.0 255.255.255.128 1 0
192.168.12.128 255.255.255.192 3 0
192.168.12.192 255.255.255.224 4 0
192.168.12.224 255.255.255.240 5 0
192.168.12.240 255.255.255.248 6 0
192.168.12.248 255.255.255.252 7 0
192.168.12.252 255.255.255.254 8 0
192.168.12.254 255.255.255.255 9 0
192.168.12.255 255.255.255.255 10 0
Console#
– 562 –
Chapter 20 | VLAN Commands
Configuring MAC Based VLANs
mac-vlan This command configures MAC address-to-VLAN mapping. Use the no form to
remove an assignment.
Syntax
mac-vlan mac-address mac-address [mask mask-address] vlan vlan-id
[priority priority]
no mac-vlan mac-address {mac-address [mask mask-address] | all}
mac-address – The source MAC address to be matched. Configured MAC
addresses can only be unicast addresses. The MAC address must be
specified in the format xx-xx-xx-xx-xx-xx or xxxxxxxxxxxx.
mask-address - Identifies a range of MAC addresses. The mask can be
specified in the format xx-xx-xx-xx-xx-xx or xxxxxxxxxxxx, where an
equivalent binary value “1” means relevant and “0” means ignore.
vlan-id – VLAN to which the matching source MAC address traffic is
forwarded. (Range: 1-4094)
priority – The priority assigned to untagged ingress traffic. (Range: 0-7,
where 7 is the highest priority)
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ The MAC-to-VLAN mapping applies to all ports on the switch.
– 563 –
Chapter 20 | VLAN Commands
Configuring MAC Based VLANs
◆ The binary equivalent mask matching the characters in the front of the first
non-zero character must all be 1s (e.g., 111, i.e., it cannot be 101 or 001...). A
mask for the MAC address: 00-50-6e-00-5f-b1 translated into binary:
MAC: 00000000-01010000-01101110-00000000-01011111-10110001
could be: 11111111-11xxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx
So the mask in hexadecimal for this example could be:
ff-fx-xx-xx-xx-xx/ff-c0-00-00-00-00/ff-e0-00-00-00-00
Example
The following example assigns traffic from source MAC address 00-00-00-11-22-33
to VLAN 10.
Command Mode
Privileged Exec
Command Usage
Use this command to display MAC address-to-VLAN mappings.
Example
The following example displays all configured MAC address-based VLANs.
Console#show mac-vlan
MAC Address Mask VLAN ID Priority
------------------ ------------------ -------- --------
00-E0-4C-68-14-79 FF-FF-FF-FF-FF-FF 100 0
Console#
– 564 –
Chapter 20 | VLAN Commands
Configuring Voice VLANs
voice vlan aging Configures the aging time for Voice VLAN ports GC
switchport voice vlan Sets the VoIP traffic priority for ports IC
priority
switchport voice vlan rule Sets the automatic VoIP traffic detection method for ports IC
voice vlan This command enables VoIP traffic detection and defines the Voice VLAN ID. Use
the no form to disable the Voice VLAN.
Syntax
voice vlan voice-vlan-id
no voice vlan
voice-vlan-id - Specifies the voice VLAN ID. (Range: 1-4094)
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ When IP telephony is deployed in an enterprise network, it is recommended to
isolate the Voice over IP (VoIP) network traffic from other data traffic. Traffic
isolation helps prevent excessive packet delays, packet loss, and jitter, which
results in higher voice quality. This is best achieved by assigning all VoIP traffic
to a single VLAN.
– 565 –
Chapter 20 | VLAN Commands
Configuring Voice VLANs
◆ VoIP traffic can be detected on switch ports by using the source MAC address of
packets, or by using LLDP (IEEE 802.1AB) to discover connected VoIP devices.
When VoIP traffic is detected on a configured port, the switch automatically
assigns the port as a tagged member of the Voice VLAN.
◆ Only one Voice VLAN is supported and it must already be created on the switch
before it can be specified as the Voice VLAN.
◆ The Voice VLAN ID cannot be modified when the global auto-detection status
is enabled (see the switchport voice vlan command).
Example
The following example enables VoIP traffic detection and specifies the Voice VLAN
ID as 1234.
voice vlan aging This command sets the Voice VLAN ID time out. Use the no form to restore the
default.
Syntax
voice vlan aging minutes
no voice vlan
minutes - Specifies the port Voice VLAN membership time out.
(Range: 5-43200 minutes)
Default Setting
1440 minutes
Command Mode
Global Configuration
Command Usage
The Voice VLAN aging time is the time after which a port is removed from the Voice
VLAN when VoIP traffic is no longer received on the port.
The VoIP aging time starts to count down when the OUI’s MAC address expires from
the MAC address table. Therefore, the MAC address aging time should be added to
the overall aging time. For example, if you configure the MAC address table aging
time to 30 seconds, and voice VLAN aging time to 5 minutes, then after 5.5 minutes,
a port will be removed from the voice VLAN when VoIP traffic is no longer received
on the port. Alternatively, if you clear the MAC address table manually, then the
switch will also start counting down the voice VLAN aging time.
– 566 –
Chapter 20 | VLAN Commands
Configuring Voice VLANs
Note that when the switchport voice vlan command is set to auto mode, the
remaining aging time displayed by the show voice vlan command will be
displayed. Otherwise, if the switchport voice vlan command is disabled or set to
manual mode, the remaining aging time will display “NA.”
Example
The following example configures the Voice VLAN aging time as 3000 minutes.
voice vlan This command specifies MAC address ranges to add to the OUI Telephony list. Use
mac-address the no form to remove an entry from the list.
Syntax
voice vlan mac-address mac-address mask mask-address
[description description]
no voice vlan mac-address mac-address mask mask-address
mac-address - Defines a MAC address OUI that identifies VoIP devices in the
network. (Format: xx-xx-xx-xx-xx-xx or xxxxxxxxxxxx; for example,
01-23-45-00-00-00)
mask-address - Identifies a range of MAC addresses. (Range: 80-00-00-00-
00-00 to FF-FF-FF-FF-FF-FF)
description - User-defined text that identifies the VoIP devices. (Range: 1-30
characters)
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ VoIP devices attached to the switch can be identified by the manufacturer’s
Organizational Unique Identifier (OUI) in the source MAC address of received
packets. OUI numbers are assigned to manufacturers and form the first three
octets of device MAC addresses. The MAC OUI numbers for VoIP equipment can
be configured on the switch so that traffic from these devices is recognized as
VoIP.
◆ Setting a mask of FF-FF-FF-00-00-00 identifies all devices with the same OUI
(the first three octets). Other masks restrict the MAC address range. Setting a
mask of FF-FF-FF-FF-FF-FF specifies a single MAC address.
– 567 –
Chapter 20 | VLAN Commands
Configuring Voice VLANs
Example
The following example adds a MAC OUI to the OUI Telephony list.
switchport voice vlan This command specifies the Voice VLAN mode for ports. Use the no form to disable
the Voice VLAN feature on the port.
Syntax
switchport voice vlan {manual | auto}
no switchport voice vlan
manual - The Voice VLAN feature is enabled on the port, but the port must
be manually added to the Voice VLAN.
auto - The port will be added as a tagged member to the Voice VLAN when
VoIP traffic is detected on the port.
Default Setting
Disabled
Command Mode
Interface Configuration
Command Usage
◆ When auto is selected, you must select the method to use for detecting VoIP
traffic, either OUI or 802.1AB (LLDP) using the switchport voice vlan rule
command. When OUI is selected, be sure to configure the MAC address ranges
in the Telephony OUI list using the voice vlan mac-address command.
◆ All ports are set to VLAN hybrid mode by default. Prior to enabling VoIP for a
port (by setting the VoIP mode to Auto or Manual as described below), ensure
that VLAN membership is not set to access mode using the switchport mode
command.
Example
The following example sets port 1 to Voice VLAN auto mode.
– 568 –
Chapter 20 | VLAN Commands
Configuring Voice VLANs
switchport voice vlan This command specifies a CoS priority for VoIP traffic on a port. Use the no form to
priority restore the default priority on a port.
Syntax
switchport voice vlan priority priority-value
no switchport voice vlan priority
priority-value - The CoS priority value. (Range: 0-6)
Default Setting
6
Command Mode
Interface Configuration
Command Usage
Specifies a CoS priority to apply to the port VoIP traffic on the Voice VLAN. The
priority of any received VoIP packet is overwritten with the new priority when the
Voice VLAN feature is active for the port.
Example
The following example sets the CoS priority to 5 on port 1.
switchport voice vlan This command selects a method for detecting VoIP traffic on a port. Use the no
rule form to disable the detection method on the port.
Syntax
[no] switchport voice vlan rule {oui | lldp}
oui - Traffic from VoIP devices is detected by the Organizationally Unique
Identifier (OUI) of the source MAC address.
lldp - Uses LLDP to discover VoIP devices attached to the port.
Default Setting
OUI: Enabled
LLDP: Disabled
Command Mode
Interface Configuration
– 569 –
Chapter 20 | VLAN Commands
Configuring Voice VLANs
Command Usage
◆ When OUI is selected, be sure to configure the MAC address ranges in the
Telephony OUI list (see the voice vlan mac-address command). MAC address
OUI numbers must be configured in the Telephony OUI list so that the switch
recognizes the traffic as being from a VoIP device.
◆ LLDP checks that the “telephone bit” in the system capability TLV is turned on.
See “LLDP Commands” on page 733 for more information on LLDP.
Example
The following example enables the OUI method on port 1 for detecting VoIP traffic.
switchport voice vlan This command enables security filtering for VoIP traffic on a port. Use the no form
security to disable filtering on a port.
Syntax
[no] switchport voice vlan security
Default Setting
Disabled
Command Mode
Interface Configuration
Command Usage
◆ Security filtering discards any non-VoIP packets received on the port that are
tagged with the voice VLAN ID. VoIP traffic is identified by source MAC
addresses configured in the Telephony OUI list, or through LLDP that discovers
VoIP devices attached to the switch. Packets received from non-VoIP sources
are dropped.
◆ When enabled, be sure the MAC address ranges for VoIP devices are configured
in the Telephony OUI list (voice vlan mac-address).
Example
The following example enables security filtering on port 1.
– 570 –
Chapter 20 | VLAN Commands
Configuring Voice VLANs
show voice vlan This command displays the Voice VLAN settings on the switch and the OUI
Telephony list.
Syntax
show voice vlan {oui | status}
oui - Displays the OUI Telephony list.
status - Displays the global and port Voice VLAN settings.
Default Setting
None
Command Mode
Privileged Exec
Command Usage
When the switchport voice vlan command is set to auto mode, the remaining aging
time displayed by the show voice vlan command will be displayed (or “Not Start”
will be displayed). Otherwise, if the switchport voice vlan command is disabled or
set to manual mode, the remaining aging time will display “NA.”
Example
Console#show voice vlan status
Global Voice VLAN Status
Voice VLAN Status : Enabled
Voice VLAN ID : 1234
Voice VLAN aging time : 1440 minutes
Console#
– 571 –
Chapter 20 | VLAN Commands
Configuring Voice VLANs
– 572 –
21 ERPS Commands
erps ring Creates a physical ERPS ring and enters ERPS Ring Configuration GC
mode
ring-port Configures a node’s connection to the ring through the east or ERPS Ring
west interface
exclusion-vlan Specifies the VLANS to be excluded from the ERPS protection ERPS Ring
ring.
meg-level Sets the Maintenance Entity Group level for a ring ERPS Inst
control-vlan Adds a Control VLAN to an ERPS ring ERPS Inst
rpl owner Configures a ring node to be the RPL owner ERPS Inst
rpl neighbor Configures a ring node to be the RPL neighbor ERPS Inst
wtr-timer Sets timer to verify that the ring has stabilized before blocking ERPS Inst
the RPL after recovery from a signal failure
guard-timer Sets the timer to prevent ring nodes from receiving outdated ERPS Inst
R-APS messages
holdoff-timer Sets the timer to filter out intermittent link faults ERPS Inst
major-ring Specifies the ERPS ring used for sending control packets ERPS Inst
bpdu-tcn-notify Enables the transmission of TCN BPDUs on an EPRS instance ERPS Inst
non-revertive Enables non-revertive mode, which requires the protection ERPS Inst
state on the RPL to manually cleared
– 573 –
Chapter 21 | ERPS Commands
raps-def-mac Sets the switch’s MAC address to be used as the node identifier ERPS Inst
in R-APS messages
raps-without-vc Terminates the R-APS channel at the primary ring to sub-ring ERPS Inst
interconnection nodes
inclusion-vlan Specifies the VLAN groups to be included in the ERPS protection ERPS Inst
ring.
physical-ring Associates an ERPS instance with an existing physical ring ERPS Inst
erps manual-switch Blocks the specified ring port, in the absence of a failure or an PE
erps forced-switch command
erps clear Manually clears protection state which has been invoked by a PE
Forced Switch or Manual Switch command, and the node is
operating under non-revertive mode; or before the WTR or WTB
timer expires when the node is operating in revertive mode
clear erps statistics Clears statistics for all ERPS instances or a specific instance PE
show erps statistics Displays statistics for all configured instances, or for a specified PE
instance
show erps Displays status information for all configured VLAN groups, PE
rings, or instances.
1. Create an ERPS ring: Create a ring using the erps ring command. The ring name
is used as an index in the G.8032 database.
2. Configure the east and west interfaces: Each node on the ring connects to it
through two ring ports. Use the ring-port command to configure one port
connected to the next node in the ring to the east (or clockwise direction); and
then use the ring-port command again to configure another port facing west in
the ring.
3. Configure VLAN groups to assign to specific ERPS instances using the erps vlan-
group command.
4. Configure ERPS instances using the erps instance command and then associate
the instances to a configured ring using the physical-ring command.
5. Configure the RPL owner: Configure one node in the ring as the Ring Protection
Link (RPL) owner using the rpl owner command. When this switch is configured
as the RPL owner, the west ring port is set as being connected to the RPL. Under
normal operations (Idle state), the RPL is blocked to ensure that a loop cannot
form in the ring. If a signal failure brings down any other link in the ring, the RPL
will be unblocked (Protection state) to ensure proper connectivity among all
ring nodes until the failure is recovered.
– 574 –
Chapter 21 | ERPS Commands
6. Configure ERPS timers: Use the guard-timer command to set the timer is used
to prevent ring nodes from receiving outdated R-APS messages, the holdoff-
timer command to filter out intermittent link faults, and the wtr-timer
command to verify that the ring has stabilized before blocking the RPL after
recovery from a signal failure.
7. Configure the ERPS Control VLAN (CVLAN): Use the control-vlan command to
create the VLAN used to pass R-APS ring maintenance commands. The CVLAN
must NOT be configured with an IP address. In addition, only ring ports may be
added to the CVLAN (prior to configuring the VLAN as a CVLAN). No other ports
can be members of this VLAN (once set as a CVLAN). Also, the ring ports of the
CVLAN must be tagged. Failure to observe these restrictions can result in a loop
in the network.
8. Enable ERPS: Before enabling a ring as described in the next step, first use the
erps command to globally enable ERPS on the switch. If ERPS has not yet been
enabled or has been disabled with the no erps command, no ERPS rings will
work.
9. Enable ERPS rings and instances: Before an ERPS ring can work, it must be
enabled using the enable (ring) command and specific instances enabled using
the enable (instance) command. When configuration is completed and the ring
enabled, R-APS messages will start flowing in the control VLAN, and normal
traffic will begin to flow in the data VLANs. To stop a ring, it can be disabled on
any node using the no enable (ring) command.
10. Display ERPS status information: Use the show erps statistics command to
display general ERPS status information or detailed ERPS status information for
a specific ring.
erps This command enables ERPS on the switch. Use the no form to disable this feature.
Syntax
[no] erps
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
ERPS must be enabled globally on the switch before it can enabled on an ERPS ring
using the enable (ring) command.
– 575 –
Chapter 21 | ERPS Commands
Example
Console(config)#erps
Console(config)#
Related Commands
enable (ring) (580)
erps node-id This command sets the MAC address for a ring node. Use the no form to restore the
default setting.
Syntax
erps node-id mac-address
no erps node-id
mac-address – A MAC address unique to the ring node. The MAC address
must be specified in the format xx-xx-xx-xx-xx-xx or xxxxxxxxxxxx.
Default Setting
CPU MAC address
Command Mode
Global Configuration
Command Usage
◆ The ring node identifier is used to identify a node in R-APS messages for both
automatic and manual switching recovery operations.
For example, a node that has one ring port in SF condition and detects that the
condition has been cleared, will continuously transmit R-APS (NR) messages
with its own Node ID as priority information over both ring ports, informing its
neighbors that no request is present at this node. When another recovered
node holding the link blocked receives this message, it compares the Node ID
information with its own. If the received R-APS (NR) message has a higher
priority, this unblocks its ring ports. Otherwise, the block remains unchanged.
◆ The node identifier may also be used for debugging, such as to distinguish
messages when a node is connected to more than one ring.
Example
Console(config-erps)#node-id 00-12-CF-61-24-2D
Console(config-erps)#
– 576 –
Chapter 21 | ERPS Commands
erps vlan-group This command creates or modifies an ERPS VLAN group. Use the no form of this
command to remove VLANs from a VLAN group or to delete a VLAN group.
Syntax
erps vlan-group vlan-group-name {add|remove} vlan-list
no erps vlan-group vlan-group-name
vlan-group-name – Name of the VLAN group. (Range: 1-12 characters).
add – Adds VLANs to a group.
remove – Deletes VLANs from a group.
vlan-list – A single VLAN ID, a list of VLAN IDs separated by commas, or a
range of VLANs defined by two VLAN IDs separated by a hyphen.
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ A set of VLANs in an Ethernet ring can be grouped into several subsets and
applied to an ERPS instance.
◆ A VLAN group configuration is allowed to be deleted only if all associations are
removed
Example
Console(config)#erps vlan-group alpha add 2
Console(config)#
erps ring This command creates a physical ERPS ring and enters ERPS configuration mode for
the specified ring. Use the no form to delete a physical ring.
Syntax
[no] erps ring ring-name
ring-name - Name of a specific ERPS ring. (Range: 1-12 characters)
Default Setting
None
Command Mode
Global Configuration
– 577 –
Chapter 21 | ERPS Commands
Command Usage
◆ The switch can support ERPS rings up to half the number of physical ports on
the switch.
Example
Console(config)#erps ring campus1
Console(config-erps-ring)#
erps instance This command creates an ERPS instance and enters ERPS instance configuration
mode. Use the no form to delete an ERPS instance.
Syntax
erps instance instance-name [id ring-id]
no erps instance instance-name
instance-name - Name of a specific ERPS instance. (Range: 1-12 characters)
ring-id - ERPS ring identifier used in R-APS messages. (Range: 1-255)
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ Service Instances within each ring are based on a unique maintenance
association for the specific users, distinguished by the ring name, maintenance
level, maintenance association’s name, and assigned VLAN. The maximum
number of ERPS instances that can be configured on the switch is equal to the
total number of physical ports.
◆ R-APS information is carried in an R-APS PDUs. The last octet of the MAC
address is designated as the Ring ID (01-19-A7-00-00-[Ring ID]). If use of the
default MAC address is disabled with the no raps-def-mac command, then the
Ring ID configured by the erps instance command will be used in R-APS PDUs.
Example
Console(config)#erps instance r&d id 1
Console(config-erps-inst)#
– 578 –
Chapter 21 | ERPS Commands
ring-port This command configures a node’s connection to the ring through the east or west
interface. Use the no form to disassociate a node from the ring.
Syntax
ring-port {east | west} interface interface
no ring-port {east | west}
east - Connects to next ring node to the east.
west - Connects to next ring node to the west.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
Not associated
Command Mode
ERPS Ring Configuration
Command Usage
◆ Each node must be connected to two neighbors on the ring. For convenience,
the ports connected are referred to as east and west ports. Alternatively, the
closest neighbor to the east should be the next node in the ring in a clockwise
direction, and the closest neighbor to the west should be the next node in the
ring in a counter-clockwise direction.
◆ If a port channel (static trunk) is specified as a ring port, it can not be destroyed
before it is removed from the domain configuration.
◆ If a static trunk is configured as a ring port prior to assigning any member ports,
spanning tree will be disabled for the first member port assigned to the static
trunk.
Example
Console(config-erps-ring)#ring-port east interface ethernet 1/12
Console(config-erps-ring)#
– 579 –
Chapter 21 | ERPS Commands
exclusion-vlan Use this command to specify VLAN groups that are to be on the exclusion list of a
physical ERPS ring. Use the no form of the command to remove VLAN groups from
the list.
Syntax
[no] inclusion-vlan vlan-group-name
vlan-group-name - Name of the VLAN group. (Range: 1-12 characters)
Default Setting
None
Command Mode
ERPS Ring Configuration
Command Usage
◆ VLANs that are on the exclusion list are not protected by the ERPS ring.
◆ Any VLAN not listed on either the inclusion or exclusion list will be blocked on
ring ports.
◆ Use the show erps statistics command to view the exclusion-vlan list of VLAN
IDs.
◆ Traffic from control VLANs, inclusion VLANs, and exclusion VLANs of an ERPS
ring will be forwarded by non-ERPS ring ports.
Example
Console(config-erps)#exclusion-vlan vlgroup3
Console(config-erps)#
enable (ring) This command activates the current ERPS ring. Use the no form to disable the
current ring.
Syntax
[no] enable
Default Setting
Disabled
Command Mode
ERPS Ring Configuration
Command Usage
◆ Before enabling a ring, the global ERPS function should be enabled with the
erps command, the east and west ring ports configured on each node with the
ring-port command, the RPL owner specified with the rpl owner command,
and the control VLAN configured with the control-vlan command.
– 580 –
Chapter 21 | ERPS Commands
◆ Once enabled, the RPL owner node and non-owner node state machines will
start, and the ring will enter idle state if no signal failures are detected.
Example
Console(config-erps-ring)#enable
Console(config-erps-ring)#
Related Commands
erps (575)
enable (instance) This command activates the current ERPS instance. Use the no form to disable the
current instance.
Syntax
[no] enable
Default Setting
Disabled
Command Mode
ERPS Instance Configuration
Command Usage
◆ Before enabling an instance, the global ERPS function should be enabled with
the erps command, the ring enabled with the enable (ring) command, the east
and west ring ports configured on each node with the ring-port command, the
RPL owner specified with the rpl owner command, and the control VLAN
configured with the control-vlan command.
◆ Once enabled, the RPL owner node and non-owner node state machines will
start, and the instance will enter idle state if no signal failures are detected.
Example
Console(config-erps-inst)#enable
Console(config-erps-inst)#
Related Commands
erps (575)
meg-level This command sets the Maintenance Entity Group level for an instance. Use the no
form to restore the default setting.
Syntax
meg-level level
– 581 –
Chapter 21 | ERPS Commands
no meg-level
level - The maintenance entity group (MEG) level which provides a
communication channel for ring automatic protection switching (R-APS)
information. (Range: 0-7)
Default Setting
1
Command Mode
ERPS Instance Configuration
Command Usage
◆ This parameter is used to ensure that received R-APS PDUs are directed for this
instance. A unique level should be configured for each local instance if there
are many R-APS PDUs passing through this switch.
Example
Console(config-erps)#meg-level 0
Console(config-erps)#
control-vlan This command specifies a dedicated VLAN used for sending and receiving ERPS
protocol messages. Use the no form to remove the Control VLAN.
Syntax
control-vlan vlan-id
no control-vlan
vlan-id - VLAN ID (Range: 1-4094)
Default Setting
None
Command Mode
ERPS Instance Configuration
Command Usage
◆ The Control VID must be included in one of inclusion VLAN groups.
◆ Configure one control VLAN for each ERPS instance. First create the VLAN to be
used as the control VLAN (vlan, page 532), add the VLAN to an ERPS VLAN
group (erps vlan-group), add the ring ports for the east and west interface as
tagged members to this VLAN (switchport allowed vlan, page 535), and then
use the control-vlan command to add it to the ERPS instance.
– 582 –
Chapter 21 | ERPS Commands
◆ Once the instance has been activated with the enable (instance) command, the
configuration of the control VLAN cannot be modified. Use the no enable (ring)
command to stop the ERPS instance before making any configuration changes
to the control VLAN.
Example
Console(config)#vlan database
Console(config-vlan)#vlan 2 name rdc media ethernet state active
Console(config-vlan)#exit
Console(config)#interface ethernet 1/12
Console(config-if)#switchport allowed vlan add 2 tagged
Console(config-if)#interface ethernet 1/11
Console(config-if)#switchport allowed vlan add 2 tagged
Console(config-if)#exit
Console(config)#erps vlan-group alpha add 2
Console(config)#erps instance rd1
Console(config-erps-inst)#control-vlan 2
Console(config-erps-inst)#
rpl owner This command configures a ring node to be the Ring Protection Link (RPL) owner.
Use the no form to restore the default setting.
Syntax
rpl owner
no rpl
Default Setting
None (that is, neither owner nor neighbor)
Command Mode
ERPS Instance Configuration
Command Usage
◆ Only one RPL owner can be configured on an instance. The owner blocks traffic
on the RPL during Idle state, and unblocks it during Protection state (that is,
when a signal fault is detected on the instance or the protection state is
enabled with the erps forced-switch or erps manual-switch command).
◆ The east and west connections to the instance must be specified for all ring
nodes using the ring-port command. When this switch is configured as the RPL
owner, the west ring port is automatically set as being connected to the RPL.
– 583 –
Chapter 21 | ERPS Commands
Example
Console(config-erps-inst)#rpl owner
Console(config-erps-inst)#
rpl neighbor This command configures a ring node to be the Ring Protection Link (RPL)
neighbor. Use the no form to restore the default setting.
Syntax
rpl neighbor
no rpl
Default Setting
None (that is, neither owner nor neighbor)
Command Mode
ERPS Instance Configuration
Command Usage
◆ The RPL neighbor node, when configured, is a ring node adjacent to the RPL
that is responsible for blocking its end of the RPL under normal conditions (i.e.,
the instance is established and no requests are present in the instance) in
addition to the block at the other end by the RPL Owner Node. The RPL
neighbor node may participate in blocking or unblocking its end of the RPL,
but is not responsible for activating the reversion behavior.
◆ Only one RPL owner can be configured on an instance. If the switch is set as the
RPL owner for an ERPS ring, the west ring port is set as one end of the RPL. If the
switch is set as the RPL neighbor for an ERPS ring, the east ring port is set as the
other end of the RPL.
◆ The east and west connections to the ring must be specified for all ring nodes
using the ring-port command. When this switch is configured as the RPL
neighbor, the east ring port is set as being connected to the RPL.
Example
Console(config-erps-inst)#rpl neighbor
Console(config-erps-inst)#
– 584 –
Chapter 21 | ERPS Commands
wtr-timer This command sets the wait-to-restore timer which is used to verify that the ring
has stabilized before blocking the RPL after recovery from a signal failure. Use the
no form to restore the default setting.
Syntax
wtr-timer minutes
no wtr-timer
minutes - The wait-to-restore timer is used to verify that the ring has
stabilized before blocking the RPL after recovery from a signal failure.
(Range: 1-12 minutes)
Default Setting
5 minutes
Command Mode
ERPS Instance Configuration
Command Usage
If the switch goes into ring protection state due to a signal failure, after the failure
condition is cleared, the RPL owner will start the wait-to-restore timer and wait until
it expires to verify that the ring has stabilized before blocking the RPL and returning
to the Idle (normal operating) state.
Example
Console(config-erps-inst)#wtr-timer 10
Console(config-erps-inst)#
guard-timer This command sets the guard timer to prevent ring nodes from receiving outdated
R-APS messages. Use the no form to restore the default setting.
Syntax
guard-timer milliseconds
no guard-timer
milliseconds - The guard timer is used to prevent ring nodes from receiving
outdated R-APS messages. During the duration of the guard timer, all
received R-APS messages are ignored by the ring protection control
process, giving time for old messages still circulating on the ring to expire.
(Range: 10-2000 milliseconds, in steps of 10 milliseconds)
Default Setting
500 milliseconds
Command Mode
ERPS Instance Configuration
– 585 –
Chapter 21 | ERPS Commands
Command Usage
The guard timer duration should be greater than the maximum expected
forwarding delay for an R-APS message to pass around the ring. A side-effect of the
guard timer is that during its duration, a node will be unaware of new or existing
ring requests transmitted from other nodes.
Example
Console(config-erps-inst)#guard-timer 300
Console(config-erps-inst)#
holdoff-timer This command sets the timer to filter out intermittent link faults. Use the no form to
restore the default setting.
Syntax
holdoff-timer milliseconds
no holdoff-timer
milliseconds - The hold-off timer is used to filter out intermittent link faults.
Faults will only be reported to the ring protection mechanism if this timer
expires. (Range: 0-10000 milliseconds, in steps of 100 milliseconds)
Default Setting
0 milliseconds
Command Mode
ERPS Instance Configuration
Command Usage
In order to coordinate timing of protection switches at multiple layers, a hold-off
timer may be required. Its purpose is to allow, for example, a server layer protection
switch to have a chance to fix the problem before switching at a client layer.
When a new defect or more severe defect occurs (new Signal Failure), this event will
not be reported immediately to the protection switching mechanism if the
provisioned hold-off timer value is non-zero. Instead, the hold-off timer will be
started. When the timer expires, whether a defect still exists or not, the timer will be
checked. If one does exist, that defect will be reported to the protection switching
mechanism. The reported defect need not be the same one that started the timer.
Example
Console(config-erps-inst)#holdoff-timer 300
Console(config-erps-inst)#
– 586 –
Chapter 21 | ERPS Commands
major-ring This command specifies the ERPS ring used for sending control packets. Use the no
form to remove the current setting.
Syntax
major-ring instance-name
no major-ring
instance-name - Name of the ERPS instance used for sending control
packets. (Range: 1-12 characters)
Default Setting
None
Command Mode
ERPS Instance Configuration
Command Usage
◆ ERPS control packets can only be sent on one instance. This command is used
to indicate that the current instance is a secondary ring, and to specify the
major instance which will be used to send ERPS control packets.
◆ The Ring Protection Link (RPL) is the west port and can not be configured. So
the physical port on a secondary instance must be the west port. In other
words, if a domain has two physical ring ports, this instance can only be a major
ring, not a secondary ring (or sub-domain) which can have only one physical
ring port. This command will therefore fail if the east port is already configured
(see the ring-port command).
Example
Console(config-erps-inst)#major-domain rd0
Console(config-erps-inst)#
propagate-tc This command enables propagation of topology change messages for a secondary
ring to the primary ring. Use the no form to disable this feature.
Syntax
[no] propagate-tc
Default Setting
Disabled
Command Mode
ERPS Instance Configuration
– 587 –
Chapter 21 | ERPS Commands
Command Usage
◆ When a secondary ring detects a topology change, it can pass a message about
this event to the major ring. When the major ring receives this kind of message
from a secondary ring, it can clear the MAC addresses on its ring ports to help
the secondary ring restore its connections more quickly through protection
switching.
◆ When the MAC addresses are cleared, data traffic may flood onto the major
ring. The data traffic will become stable after the MAC addresses are learned
again. The major ring will not be broken, but the bandwidth of data traffic on
the major ring may suffer for a short period of time due to this flooding
behavior.
Example
Console(config-erps-inst)#propagate-tc
Console(config-erps-inst)#
bpdu-tcn-notify This command configures an ERPS instance to send BPDU TCN notifications. Use
the no form of this command to disable BPDU TCN notifications.
Syntax
[no] bpdu-tcn-notify
Default Setting
Disabled
Command Mode
ERPS Instance Configuration
Command Usage
When enabled, Spanning Tree topology change notification (TCN) BPDUs are
transmitted when an ERPS forwarding database (FDB) flush occurs on a ring
instance.
Example
Console(config-erps-inst)#bpdu-tcn-notify
Console(config-erps-inst)#
non-revertive This command enables non-revertive mode, which requires the protection state on
the RPL to manually cleared. Use the no form to restore the default revertive mode.
Syntax
[no] non-revertive
– 588 –
Chapter 21 | ERPS Commands
Default Setting
Disabled
Command Mode
ERPS Instance Configuration
Command Usage
◆ Revertive behavior allows the switch to automatically return the RPL from
Protection state to Idle state through the exchange of protocol messages.
Non-revertive behavior for Protection, Forced Switch, and Manual Switch states
are basically the same. Non-revertive behavior requires the erps clear
command to used to return the RPL from Protection state to Idle state.
◆ Recovery for Protection Switching – A ring node that has one or more ring ports
in an SF (Signal Fail) condition, upon detecting the SF condition cleared, keeps
at least one of its ring ports blocked for the traffic channel and for the R-APS
channel, until the RPL is blocked as a result of ring protection reversion, or until
there is another higher priority request (e.g., an SF condition) in the ring.
A ring node that has one ring port in an SF condition and detects the SF
condition cleared, continuously transmits the R-APS (NR – no request) message
with its own Node ID as the priority information over both ring ports, informing
that no request is present at this ring node and initiates a guard timer. When
another recovered ring node (or nodes) holding the link block receives this
message, it compares the Node ID information with its own Node ID. If the
received R-APS (NR) message has the higher priority, this ring node unblocks its
ring ports. Otherwise, the block remains unchanged. As a result, there is only
one link with one end blocked.
The ring nodes stop transmitting R-APS (NR) messages when they accept an R-
APS (NR, RB – RPL Blocked), or when another higher priority request is received.
■ Recovery with Revertive Mode – When all ring links and ring nodes have
recovered and no external requests are active, reversion is handled in the
following way:
a. The reception of an R-APS (NR) message causes the RPL Owner Node to
start the WTR (Wait-to-Restore) timer.
b. The WTR timer is cancelled if during the WTR period a higher priority
request than NR is accepted by the RPL Owner Node or is declared
locally at the RPL Owner Node.
c. When the WTR timer expires, without the presence of any other higher
priority request, the RPL Owner Node initiates reversion by blocking its
traffic channel over the RPL, transmitting an R-APS (NR, RB) message
over both ring ports, informing the ring that the RPL is blocked, and
performing a flush FDB action.
d. The acceptance of the R-APS (NR, RB) message causes all ring nodes to
unblock any blocked non-RPL link that does not have an SF condition. If
– 589 –
Chapter 21 | ERPS Commands
it is an R-APS (NR, RB) message without a DNF (do not flush) indication,
all ring nodes flush the FDB.
■ Recovery with Non-revertive Mode – In non-revertive operation, the ring
does not automatically revert when all ring links and ring nodes have
recovered and no external requests are active. Non-revertive operation is
handled in the following way:
a. The RPL Owner Node does not generate a response on reception of an
R-APS (NR) messages.
b. When other healthy ring nodes receive the NR (Node ID) message, no
action is taken in response to the message.
c. When the operator issues the erps clear command for non-revertive
mode at the RPL Owner Node, the non-revertive operation is cleared,
the RPL Owner Node blocks its RPL port, and transmits an R-APS (NR,
RB) message in both directions, repeatedly.
d. Upon receiving an R-APS (NR, RB) message, any blocking node should
unblock its non-failed ring port. If it is an R-APS (NR, RB) message
without a DNF indication, all ring nodes flush the FDB.
◆ Recovery for Forced Switching – An erps forced-switch command is removed
by issuing the erps clear command to the same ring node where Forced Switch
mode is in effect. The clear command removes any existing local operator
commands, and triggers reversion if the ring is in revertive behavior mode.
The ring node where the Forced Switch was cleared keeps the ring port
blocked for the traffic channel and for the R-APS channel, due to the previous
Forced Switch command. This ring port is kept blocked until the RPL is blocked
as a result of ring protection reversion, or until there is another higher priority
request (e.g., an SF condition) in the ring.
The ring node where the Forced Switch was cleared continuously transmits the
R-APS (NR) message on both ring ports, informing other nodes that no request
is present at this ring node. The ring nodes stop transmitting R-APS (NR)
messages when they accept an RAPS (NR, RB) message, or when another higher
priority request is received.
If the ring node where the Forced Switch was cleared receives an R-APS (NR)
message with a Node ID higher than its own Node ID, it unblocks any ring port
which does not have an SF condition and stops transmitting R-APS (NR)
message over both ring ports.
– 590 –
Chapter 21 | ERPS Commands
channel over the RPL, transmitting an R-APS (NR, RB) message over
both ring ports, informing the ring that the RPL is blocked, and flushes
the FDB.
d. The acceptance of the R-APS (NR, RB) message causes all ring nodes to
unblock any blocked non-RPL that does not have an SF condition. If it is
an R-APS (NR, RB) message without a DNF indication, all ring nodes
flush their FDB. This action unblocks the ring port which was blocked as
a result of an operator command.
■ Recovery with non-revertive mode is handled in the following way:
a. The RPL Owner Node, upon reception of an R-APS(NR) message and in
the absence of any other higher priority request does not perform any
action.
b. Then, after the operator issues the erps clear command at the RPL
Owner Node, this ring node blocks the ring port attached to the RPL,
transmits an R-APS (NR, RB) message on both ring ports, informing the
ring that the RPL is blocked, and flushes its FDB.
c. The acceptance of the R-APS (NR, RB) message triggers all ring nodes to
unblock any blocked non-RPL which does not have an SF condition. If it
is an R-APS (NR, RB) message without a DNF indication, all ring nodes
flush their FDB. This action unblocks the ring port which was blocked as
result of an operator command.
– 591 –
Chapter 21 | ERPS Commands
APS (MS) message is ignored due to the higher priority of the WTB
running signal.
b. When the WTB timer expires, it generates the WTB expire signal. The
RPL Owner Node, upon reception of this signal, initiates reversion by
blocking the traffic channel on the RPL, transmitting an R-APS (NR, RB)
message over both ring ports, informing the ring that the RPL is
blocked, and flushes its FDB.
c. The acceptance of the R-APS (NR, RB) message causes all ring nodes to
unblock any blocked non-RPL that does not have an SF condition. If it is
an R-APS (NR, RB) message without a DNF indication, all Ethernet Ring
Nodes flush their FDB. This action unblocks the ring port which was
blocked as a result of an operator command.
■ Recovery with non-revertive mode is handled in the following way:
a. The RPL Owner Node, upon reception of an R-APS (NR) message and in
the absence of any other higher priority request does not perform any
action.
b. Then, after the operator issues the erps clear command at the RPL
Owner Node, this ring node blocks the ring port attached to the RPL,
transmits an R-APS (NR, RB) message over both ring ports, informing
the ring that the RPL is blocked, and flushes its FDB.
c. The acceptance of the R-APS (NR, RB) message triggers all ring nodes to
unblock any blocked non-RPL which does not have an SF condition. If it
is an R-APS (NR, RB) message without a DNF indication, all ring nodes
flush their FDB. This action unblocks the ring port which was blocked as
result of an operator command.
Example
Console(config-erps-inst)#non-revertive
Console(config-erps-inst)#
raps-def-mac This command sets the switch’s MAC address to be used as the node identifier in R-
APS messages. Use the no form to use the node identifier specified in the G8032
standards.
Syntax
[no] raps-def-mac
Default Setting
Enabled
Command Mode
ERPS Instance Configuration
– 592 –
Chapter 21 | ERPS Commands
Command Usage
◆ When ring nodes running ERPSv1 and ERPSv2 co-exist on the same ring, the
Ring ID of each ring node must be configured as “1”.
◆ If this command is disabled, the following strings are used as the node
identifier:
■ ERPSv1: 01-19-A7-00-00-01
■ ERPSv2: 01-19-A7-00-00-[Ring ID]
Example
Console(config-erps-inst)#raps-def-mac
Console(config-erps-inst)#
raps-without-vc This command terminates the R-APS channel at the primary ring to sub-ring
interconnection nodes. Use the no form to restore the default setting.
Syntax
[no] raps-without-vc
Default Setting
R-APS with Virtual Channel
Command Mode
ERPS Instance Configuration
Command Usage
◆ A sub-ring may be attached to a primary ring with or without a virtual channel.
A virtual channel is used to connect two interconnection points on the sub-
ring, tunneling R-APS control messages across an arbitrary Ethernet network
topology. If a virtual channel is not used to cross the intermediate Ethernet
network, data in the traffic channel will still flow across the network, but the all
R-APS messages will be terminated at the interconnection points.
◆ Sub-ring with R-APS Virtual Channel – When using a virtual channel to tunnel
R-APS messages between interconnection points on a sub-ring, the R-APS
virtual channel may or may not follow the same path as the traffic channel over
the network. R-APS messages that are forwarded over the sub-ring’s virtual
channel are broadcast or multicast over the interconnected network. For this
reason the broadcast/multicast domain of the virtual channel should be limited
to the necessary links and nodes. For example, the virtual channel could span
only the interconnecting rings or sub-rings that are necessary for forwarding
R-APS messages of this sub-ring. Care must also be taken to ensure that the
local RAPS messages of the sub-ring being transported over the virtual channel
into the interconnected network can be uniquely distinguished from those of
other interconnected ring R-APS messages. This can be achieved by, for
example, by using separate VIDs for the virtual channels of different sub-rings.
– 593 –
Chapter 21 | ERPS Commands
Note that the R-APS virtual channel requires a certain amount of bandwidth to
forward R-APS messages on the interconnected Ethernet network where a sub-
ring is attached. Also note that the protection switching time of the sub-ring
may be affected if R-APS messages traverse a long distance over an R-APS
virtual channel.
Figure 6: Sub-ring with Virtual Channel
RPL Port Interconnection Node Ring Node
– 594 –
Chapter 21 | ERPS Commands
Example
Console(config-erps-inst)#raps-without-vc
Console(config-erps-inst)#
Syntax
version {1 | 2}
no version
1 - ERPS version 1 based on ITU-T G.8032/Y.1344.
2 - ERPS version 2 based on ITU-T G.8032/Y.1344 Version 2.
Default Setting
2
Command Mode
ERPS Instance Configuration
Command Usage
◆ In addition to the basic features provided by version 1, version 2 also supports:
■ Multi-ring/ladder network support
■ Revertive/Non-revertive recovery
■ Forced Switch (FS) and Manual Switch (MS) commands for manually
blocking a particular ring port
■ Flush FDB (forwarding database) logic which reduces amount of flush FDB
operations in the ring
■ Support of multiple ERP instances on a single ring
– 595 –
Chapter 21 | ERPS Commands
◆ The version number is automatically set to “1” when a ring node, supporting
only the functionalities of G.8032v1, exists on the same ring with other nodes
that support G.8032v2.
◆ When ring nodes running G.8032v1 and G.8032v2 co-exist on a ring, the ring ID
of each node is configured as “1”.
◆ In version 1, the MAC address 01-19-A7-00-00-01 is used for the node identifier.
The raps-def-mac command has no effect.
Example
Console(config-erps-inst)#version 1
Console(config-erps-inst)#
inclusion-vlan Use this command to specify VLAN groups that are to be on the inclusion list of an
ERPS instance. Use the no form of the command to removed the VLAN from the list.
Syntax
[no] inclusion-vlan vlan-group-name
vlan-group-name - Name of the VLAN group. (Range: 1-12 characters).
Default Setting
None
Command Mode
ERPS Instance Configuration
Command Usage
◆ VLANs that are on the inclusion list are protected by the ERPS instance.
◆ Any VLAN not listed on either the inclusion or exclusion list will be blocked on
ring ports.
◆ Use the show erps statistics command to view the inclusion-vlan list of VLAN
IDs.
◆ Traffic from control VLANs, inclusion VLANs, and exclusion VLANs of an ERPS
instance will be forwarded by non-ERPS ring ports.
Example
Console(config-erps-inst)#inclusion-vlan vlgroup3
Console(config-erps-inst)#
– 596 –
Chapter 21 | ERPS Commands
physical-ring Use this command to associate an ERPS instance with an existing physical ring. Use
the no form of the command to removed the association.
Syntax
physical-ring ring-name
no physical-ring
ring-name - Name of a specific ERPS ring. (Range: 1-12 characters)
Default Setting
None
Command Mode
ERPS Instance Configuration
Command Usage
The physical ring name must first be defined using the erps ring command.
Example
Console(config-erps-inst)#phyical-ring campus1
Console(config-erps-inst)#
Syntax
erps forced-switch instance instance-name {east | west}
instance-name - Name of a specific ERPS instance. (Range: 1-12 characters)
east - East ring port.
west - West ring port.
Command Mode
Privileged Exec
Command Usage
◆ A ring with no pending request has a logical topology with the traffic channel
blocked at the RPL and unblocked on all other ring links. In this situation, the
erps forced-switch command triggers protection switching as follows:
a. The ring node where a forced switch command was issued blocks the traffic
channel and R-APS channel on the ring port to which the command was
issued, and unblocks the other ring port.
b. The ring node where the forced switch command was issued transmits R-
APS messages indicating FS over both ring ports. R-APS (FS) messages are
– 597 –
Chapter 21 | ERPS Commands
c. A ring node accepting an R-APS (FS) message, without any local higher
priority requests unblocks any blocked ring port. This action subsequently
unblocks the traffic channel over the RPL.
d. The ring node accepting an R-APS (FS) message, without any local higher
priority requests stops transmission of R-APS messages.
e. The ring node receiving an R-APS (FS) message flushes its FDB.
While an existing forced switch request is present in a ring, any new forced
switch request is accepted, except on a ring node having a prior local forced
switch request. The ring nodes where further forced switch commands are
issued block the traffic channel and R-APS channel on the ring port at which
the forced switch was issued. The ring node where the forced switch command
was issued transmits an R-APS message over both ring ports indicating FS. R-
APS (FS) messages are continuously transmitted by this ring node while the
local FS command is the ring node’s highest priority command. As such, two or
more forced switches are allowed in the ring, which may inadvertently cause
the segmentation of an ring. It is the responsibility of the operator to prevent
this effect if it is undesirable.
Ring protection requests, commands and R-APS signals have the priorities as
specified in the following table.
FS local |
MS local |
– 598 –
Chapter 21 | ERPS Commands
Example
Console#erps forced-switch instance r&d west
Console#
erps manual-switch This command blocks the specified ring port, in the absence of a failure or an erps
forced-switch command.
Syntax
erps manual-switch instance instance-name {east | west}
instance-name - Name of a specific ERPS instance. (Range: 1-12 characters)
east - East ring port.
west - West ring port.
Command Mode
Privileged Exec
Command Usage
◆ A ring with no request has a logical topology with the traffic channel blocked at
the RPL and unblocked on all other ring links. In this situation, the erps
manual-switch command triggers protection switching as follows:
– 599 –
Chapter 21 | ERPS Commands
a. If no other higher priority commands exist, the ring node, where a manual
switch command was issued, blocks the traffic channel and R-APS channel
on the ring port to which the command was issued, and unblocks the other
ring port.
b. If no other higher priority commands exist, the ring node where the
manual switch command was issued transmits R-APS messages over both
ring ports indicating MS. R-APS (MS) message are continuously transmitted
by this ring node while the local MS command is the ring node’s highest
priority command (see Table 112 on page 598). The R-APS (MS) message
informs other ring nodes of the MS command and that the traffic channel is
blocked on one ring port.
c. If no other higher priority commands exist and assuming the ring node was
in Idle state before the manual switch command was issued, the ring node
flushes its local FDB.
d. A ring node accepting an R-APS (MS) message, without any local higher
priority requests unblocks any blocked ring port which does not have an SF
condition. This action subsequently unblocks the traffic channel over the
RPL.
e. A ring node accepting an R-APS (MS) message, without any local higher
priority requests stops transmitting R-APS messages.
a. While an existing manual switch request is present in the ring, any new
manual switch request is rejected. The request is rejected at the ring node
where the new request is issued and a notification is generated to inform
the operator that the new MS request was not accepted.
b. A ring node with a local manual switch command which receives an R-APS
(MS) message with a different Node ID clears its manual switch request and
starts transmitting R-APS (NR) messages. The ring node keeps the ring port
blocked due to the previous manual switch command.
c. An ring node with a local manual switch command that receives an R-APS
message or a local request of higher priority than R-APS (MS) clear its
manual switch request. The ring node then processes the new higher
priority request.
– 600 –
Chapter 21 | ERPS Commands
Example
Console#erps manual-switch instance r&d west
Console#
erps clear This command manually clears the protection state which has been invoked by a
forced switch or manual switch command, and the node is operating under non-
revertive mode; or before the WTR or WTB timer expires when the node is
operating in revertive mode.
Syntax
erps clear instance instance-name
instance-name - Name of a specific ERPS instance. (Range: 1-12 characters)
Command Mode
Privileged Exec
Command Usage
◆ Two steps are required to make a ring operating in non-revertive mode return
to Idle state from forced switch or manual switch state:
1.Issue an erps clear command to remove the forced switch command on the
node where a local forced switch command is active.
2.Issue an erps clear command on the RPL owner node to trigger the
reversion.
◆ The erps clear command will also stop the WTR and WTB delay timers and
reset their values.
◆ More detailed information about using this command for non-revertive mode
is included under the Command Usage section for the non-revertive command.
Example
Console#erps clear instance r&d
Console#
clear erps statistics This command clears all statistics for a specific ERPS instance, or all instances.
Syntax
clear erps statistics [instance instance-name]
instance-name - Name of a specific ERPS instance. (Range: 1-12 characters)
– 601 –
Chapter 21 | ERPS Commands
Command Mode
Privileged Exec
Example
Console#clear erps statistics instance r&d
Console#
show erps statistics This command displays statistics information for all configured instances, or for a
specified instance.
Syntax
show erps statistics [instance instance-name]]
instance-name - Name of a specific ERPS instance. (Range: 1-12 characters)
Command Mode
Privileged Exec
Example
This example displays statistics for all configured ERPS instances.
Console#
– 602 –
Chapter 21 | ERPS Commands
Interface The direction, and port or trunk which is configured as a ring port.
Local Clear SF The number of times a clear command was issued to terminate
protection state entered through a forced switch or manual switch
show erps This command displays status information for all configured VLAN groups, rings,
and instances, or for a specified VLAN group, ring, or instance.
Syntax
show erps {[vlan-group vlan-group-name] | [ring ring-name] |
[instance instance-name]}
vlan-group - Keyword to display ERPS VLAN group settings.
vlan-group-name – Name of the VLAN group. (Range: 1-12 characters).
ring - Keyword to display ERPS ring configuration settings.
ring-name - Name of a specific ERPS ring. (Range: 1-12 characters)
instance - Keyword to display ERPS instance configuration settings.
instance-name - Name of a specific ERPS instance. (Range: 1-12 characters)
Command Mode
Privileged Exec
Example
This example displays a summary of all the ERPS VLAN groups configured on the
switch.
VLAN-group ID VLANs
------------ --- ----------------------------------------
vlgroup3 1 3,6,9
– 603 –
Chapter 21 | ERPS Commands
Console#
This example displays a summary of all the ERPS rings configured on the switch.
Console#
Number of ERPS Ring Shows the number of ERPS rings configured on the switch.
Ring Displays the name of each ring followed by a brief list of status
information
West I/F Shows information on the west ring port for this node.
East I/F Shows information on the east ring port for this node.
– 604 –
Chapter 21 | ERPS Commands
This example displays a summary of all the ERPS instances configured on the
switch.
Instance ID Enabled Physical Ring Ctrl VLAN Node State Node Type
------------ --- ------- ------------- --------- ---------- ------------
test1 1 No Init None
Console#
– 605 –
Chapter 21 | ERPS Commands
– 606 –
22 Class of Service Commands
The commands described in this section allow you to specify which data packets
have greater precedence when traffic is buffered in the switch due to congestion.
This switch supports CoS with eight priority queues for each port. Data packets in a
port’s high-priority queue will be transmitted before those in the lower-priority
queues. The default priority can be set for each interface, also the queue service
mode and the mapping of frame priority tags to the switch's priority queues can be
configured.
Priority Commands Configures the queue mode, queue weights, and default priority for
(Layer 2) untagged frames
Priority Commands Sets the default priority processing method (CoS or DSCP), maps
(Layer 3 and 4) priority tags for internal processing, maps values from internal priority
table to CoS values used in tagged egress packets for Layer 2 interfaces,
maps internal per hop behavior to hardware queues
switchport priority default Sets a port priority for incoming untagged frames IC
– 607 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 2)
queue mode This command sets the scheduling mode used for processing each of the class of
service (CoS) priority queues. The options include strict priority, Weighted Round-
Robin (WRR), or a combination of strict and weighted queuing. Use the no form to
restore the default value.
Syntax
queue mode {strict | wrr | strict-wrr [queue-type-list]}
no queue mode
strict - Services the egress queues in sequential order, transmitting all
traffic in the higher priority queues before servicing lower priority queues.
This ensures that the highest priority packets are always serviced first,
ahead of all other traffic.
wrr - Weighted Round-Robin shares bandwidth at the egress ports by using
scheduling weights (based on the queue weight command), and servicing
each queue in a round-robin fashion.
strict-wrr - Uses strict or weighted service as specified for each queue.
queue-type-list - Indicates if the queue is a normal or strict type.
(Options: 0 indicates a normal queue, 1 indicates a strict queue)
Default Setting
WRR
Command Mode
Global Configuration
Command Usage
◆ The switch can be set to service the port queues based on strict priority, WRR,
or a combination of strict and weighted queuing.
◆ Weighted Round Robin (WRR) uses a predefined relative weight for each queue
that determines the percentage of service time the switch services each queue
before moving on to the next queue. This prevents the head-of-line blocking
that can occur with strict priority queuing. Use the queue weight command to
assign weights for WRR queuing to the eight priority queues.
◆ If Strict and WRR mode is selected, a combination of strict and weighted service
is used as specified for each queue. The queues assigned to use strict or WRR
priority should be specified using the queue-type-list parameter.
◆ A weight can be assigned to each of the weighted queues (and thereby to the
corresponding traffic priorities). This weight sets the frequency at which each
queue is polled for service, and subsequently affects the response time for
software applications assigned a specific priority value.
– 608 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 2)
◆ Service time is shared at the egress ports by defining scheduling weights for
WRR, or for the queuing mode that uses a combination of strict and weighted
queuing. Service time is allocated to each queue by calculating a precise
number of bytes per second that will be serviced on each round.
◆ The specified queue mode applies to all interfaces.
Example
The following example sets the queue mode to strict priority service mode:
Related Commands
queue weight (609)
show queue mode (611)
queue weight This command assigns weights to the eight class of service (CoS) priority queues
when using weighted queuing, or one of the queuing modes that use a
combination of strict and weighted queuing. Use the no form to restore the default
weights.
Syntax
queue weight weight0...weight7
no queue weight
weight0...weight7 - The ratio of weights for queues 0 - 7 determines the
weights used by the WRR scheduler. (Range: 1-255)
Default Setting
Weights 1, 2, 4, 6, 8, 10, 12, 14 are assigned to queues 0 - 7 respectively.
Command Mode
Global Configuration
Command Usage
◆ This command shares bandwidth at the egress port by defining scheduling
weights for Weighted Round-Robin, or for the queuing mode that uses a
combination of strict and weighted queuing (page 608).
– 609 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 2)
Example
The following example shows how to assign round-robin weights of 1 - 8 to the CoS
priority queues 0 - 7.
Console(config)#queue weight 1 2 3 4 5 6 7 8
Console(config)#
Related Commands
queue mode (608)
show queue weight (611)
switchport priority This command sets a priority for incoming untagged frames. Use the no form to
default restore the default value.
Syntax
switchport priority default default-priority-id
no switchport priority default
default-priority-id - The priority number for untagged ingress traffic. The
priority is a number from 0 to 7. Seven is the highest priority.
Default Setting
The priority is not set, and the default value for untagged frames received on the
interface is zero.
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ The precedence for priority mapping is IP DSCP, and then default switchport
priority.
◆ The default priority applies for an untagged frame received on a port set to
accept all frame types (i.e, receives both untagged and tagged frames). This
priority does not apply to IEEE 802.1Q VLAN tagged frames. If the incoming
frame is an IEEE 802.1Q VLAN tagged frame, the IEEE 802.1p User Priority bits
will be used.
◆ The switch provides eight priority queues for each port. It can be configured to
use strict priority queuing, Weighted Round Robin (WRR), or a combination of
strict and weighted queuing using the queue mode command. Inbound frames
that do not have VLAN tags are tagged with the input port's default ingress
user priority, and then placed in the appropriate priority queue at the output
port. The default priority for all ingress ports is zero. Therefore, any inbound
frames that do not have priority tags will be placed in queue 2 of the output
port. (Note that if the output port is an untagged member of the associated
VLAN, these frames are stripped of all VLAN tags prior to transmission.)
– 610 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 2)
Example
The following example shows how to set a default priority on port 3 to 5:
Related Commands
show interfaces switchport (413)
show queue mode This command shows the current queue mode.
Syntax
show queue mode
Command Mode
Privileged Exec
Example
Console#show queue mode
Unit Port queue mode
---- ---- ---------------
1 1 Weighted Round Robin
...
show queue weight This command displays the weights used for the weighted queues.
Syntax
show queue weight
Command Mode
Privileged Exec
Example
Console#show queue weight
Information of Eth 1/1
Queue ID Weight
-------- ------
0 1
1 2
2 4
3 6
4 8
5 10
6 12
– 611 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 3 and 4)
7 14
...
qos map phb-queue Maps internal per-hop behavior values to hardware queues IC
show qos map cos-dscp Shows ingress CoS to internal DSCP map PE
show qos map ip-prec-dscp Shows ingress IP Precedence to internal DSCP map PE
show qos map phb-queue Shows internal per-hop behavior to hardware queue map PE
* The default settings used for mapping priority values to internal DSCP values and back to the
hardware queues are designed to optimize priority services for the majority of network
applications. It should not be necessary to modify any of the default settings unless a queuing
problem occurs with a particular application.
– 612 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 3 and 4)
qos map phb-queue This command determines the hardware output queues to use based on the
internal per-hop behavior value. Use the no form to restore the default settings.
Syntax
qos map phb-queue queue-id from phb0 ... phb7
no map phb-queue phb0 ... phb7
phb - Per-hop behavior, or the priority used for this router hop. (Range: 0-7)
queue-id - The ID of the priority queue. (Range: 0-7, where 7 is the highest
priority queue)
Default Setting
Table 118: Mapping Internal Per-hop Behavior to Hardware Queues
Per-hop Behavior 0 1 2 3 4 5 6 7
Hardware Queues 2 0 1 3 4 5 6 7
Command Mode
Interface Configuration (Port, Static Aggregation)
Command Usage
◆ Enter a queue identifier, followed by the keyword “from” and then up to eight
internal per-hop behavior values separated by spaces.
◆ Egress packets are placed into the hardware queues according to the mapping
defined by this command.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#qos map phb-queue 0 from 1 2 3
Console(config-if)#
– 613 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 3 and 4)
qos map cos-dscp This command maps CoS/CFI values in incoming packets to per-hop behavior and
drop precedence values for priority processing. Use the no form to restore the
default settings.
Syntax
qos map cos-dscp phb drop-precedence from cos0 cfi0...cos7 cfi7
no qos map cos-dscp cos0 cfi0...cos7 cfi7
phb - Per-hop behavior, or the priority used for this router hop. (Range: 0-7)
drop-precedence - Drop precedence used for controlling traffic congestion.
(Range: 0 - Green, 3 - Yellow, 1 - Red)
cos - CoS value in ingress packets. (Range: 0-7)
cfi - Canonical Format Indicator. Set to this parameter to “0” to indicate that
the MAC address information carried in the frame is in canonical format.
(Range: 0-1)
Default Setting
Table 119: Default Mapping of CoS/CFI to Internal PHB/Drop Precedence
CFI 0 1
CoS
0 (0,0) (0,0)
1 (1,0) (1,0)
2 (2,0) (2,0)
3 (3,0) (3,0)
4 (4,0) (4,0)
5 (5,0) (5,0)
6 (6,0) (6,0)
7 (7,0) (7,0)
Command Mode
Interface Configuration (Port, Static Aggregation)
Command Usage
◆ The default mapping of CoS to PHB values shown in Table 119 is based on the
recommended settings in IEEE 802.1p for mapping CoS values to output
queues.
◆ Enter a value pair for the internal per-hop behavior and drop precedence,
followed by the keyword “from” and then up to eight CoS/CFI paired values
separated by spaces.
◆ If a packet arrives with a 802.1Q header but it is not an IP packet, then the CoS/
CFI-to-PHB/Drop Precedence mapping table is used to generate priority and
– 614 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 3 and 4)
drop precedence values for internal processing. Note that priority tags in the
original packet are not modified by this command.
◆ The internal DSCP consists of three bits for per-hop behavior (PHB) which
determines the queue to which a packet is sent; and two bits for drop
precedence (namely color) which is used to control traffic congestion.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#qos map cos-dscp 0 0 from 0 1
Console(config-if)#
qos map This command maps DSCP values in incoming packets to per-hop behavior and
dscp-mutation drop precedence values for priority processing. Use the no form to restore the
default settings.
Syntax
qos map dscp-mutation phb drop-precedence from dscp0 ... dscp7
no qos map dscp-mutation dscp0 ... dscp7
phb - Per-hop behavior, or the priority used for this router hop. (Range: 0-7)
drop-precedence - Drop precedence used for in controlling traffic
congestion. (Range: 0 - Green, 3 - Yellow, 1 - Red)
dscp - DSCP value in ingress packets. (Range: 0-63)
Default Setting
Table 120: Default Mapping of DSCP Values to Internal PHB/Drop Values
ingress- 0 1 2 3 4 5 6 7 8 9
dscp1
ingress-
dscp10
0 0,0 0,1 0,0 0,3 0,0 0,1 0,0 0,3 1,0 1,1
1 1,0 1,3 1,0 1,1 1,0 1,3 2,0 2,1 2,0 2,3
2 2,0 2,1 2,0 2,3 3,0 3,1 3,0 3,3 3.0 3,1
3 3,0 3,3 4,0 4,1 4,0 4,3 4,0 4,1 4.0 4,3
4 5,0 5,1 5,0 5,3 5,0 5,1 6,0 5,3 6,0 6,1
5 6,0 6,3 6,0 6,1 6,0 6,3 7,0 7,1 7.0 7,3
– 615 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 3 and 4)
Command Mode
Interface Configuration (Port, Static Aggregation)
Command Usage
◆ Enter a value pair for the internal per-hop behavior and drop precedence,
followed by the keyword “from” and then up to eight DSCP values separated by
spaces.
◆ This map is only used when the QoS mapping mode is set to “DSCP” by the qos
map trust-mode command, and the ingress packet type is IPv4.
◆ Two QoS domains can have different DSCP definitions, so the DSCP-to-PHB/
Drop Precedence mutation map can be used to modify one set of DSCP values
to match the definition of another domain. The mutation map should be
applied at the receiving port (ingress mutation) at the boundary of a QoS
administrative domain.
Example
This example changes the priority for all packets entering port 1 which contain a
DSCP value of 1 to a per-hop behavior of 3 and a drop precedence of 1. Referring to
Table 120, note that the DSCP value for these packets is now set to 25 (3x23+1) and
passed on to the egress interface.
qos map ip-prec-dscp This command maps IP precedence values in incoming packets to per-hop
behavior and drop precedence values for priority processing. Use the no form to
restore the default settings.
Syntax
qos map ip-prec-dscp phb0 drop-precedence0 ... phb7 drop-precedence7
no map ip-prec-dscp
– 616 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 3 and 4)
phb - Per-hop behavior, or the priority used for this router hop. (Range: 0-7)
drop-precedence - Drop precedence used for controlling traffic congestion.
(Range: 0 - Green, 3 - Yellow, 1 - Red)
Default Setting
Table 121: Default Mapping of IP Precedence to Internal PHB/Drop Values
IP Precedence Value 0 1 2 3 4 5 6 7
Per-hop Behavior 0 1 2 3 4 5 6 7
Drop Precedence 0 0 0 0 0 0 0 0
Command Mode
Interface Configuration (Port, Static Aggregation)
Command Usage
◆ Enter up to eight paired values for per-hop behavior and drop precedence
separated by spaces. These values are used for internal priority processing, and
correspond to IP Precedence values 0 - 7.
◆ If the QoS mapping mode is set the IP Precedence and the ingress packet type
is IPv4, then the IP Precedence-to-DSCP mapping table is used to generate
priority and drop precedence values for internal processing.
Example
Console(config)#interface ethernet 1/5
Console(config-if)#qos map ip-prec-dscp 7 0 6 0 5 0 4 0 3 0 2 1 1 1 0 1
Console(config-if)#
qos map trust-mode This command sets QoS mapping to DSCP or CoS. Use the no form to restore the
default setting.
Syntax
qos map trust-mode {cos | dscp | ip-prec}
no qos map trust-mode
cos - Sets the QoS mapping mode to CoS.
dscp - Sets the QoS mapping mode to DSCP.
ip-prec - Sets the QoS mapping mode to IP Precedence.
Default Setting
CoS
Command Mode
Interface Configuration (Port)
– 617 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 3 and 4)
Command Usage
◆ If the QoS mapping mode is set to IP Precedence with this command, and the
ingress packet type is IPv4, then priority processing will be based on the IP
Precedence value in the ingress packet.
◆ If the QoS mapping mode is set to DSCP with this command, and the ingress
packet type is IPv4, then priority processing will be based on the DSCP value in
the ingress packet.
◆ If the QoS mapping mode is set to either IP Precedence or DSCP, and a non-IP
packet is received, the packet's CoS and CFI (Canonical Format Indicator) values
are used for priority processing if the packet is tagged. For an untagged packet,
the default port priority (see page 610) is used for priority processing.
◆ If the QoS mapping mode is set to CoS with this command, and the ingress
packet type is IPv4, then priority processing will be based on the CoS and CFI
values in the ingress packet.
For an untagged packet, the default port priority (see page 610) is used for
priority processing.
Example
This example sets the QoS priority mapping mode to use DSCP based on the
conditions described in the Command Usage section.
Console(config)#interface ge1/1
Console(config-if)#qos map trust-mode dscp
Console(config-if)#
show qos map This command shows ingress CoS/CFI to internal DSCP map.
cos-dscp
Syntax
show qos map cos-dscp interface interface
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show qos map cos-dscp interface ethernet 1/5
CoS Information of Eth 1/5
– 618 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 3 and 4)
show qos map This command shows the ingress DSCP to internal DSCP map.
dscp-mutation
Syntax
show qos map dscp-mutation interface interface
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
Command Usage
This map is only used when the QoS mapping mode is set to “DSCP” by the qos
map trust-mode command, and the ingress packet type is IPv4.
Example
The ingress DSCP is composed of “d1” (most significant digit in the left column) and
“d2” (least significant digit in the top row (in other words, ingress DSCP = d1 * 10 +
d2); and the corresponding Internal DSCP and drop precedence is shown at the
intersecting cell in the table.
– 619 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 3 and 4)
show qos map This command shows the ingress IP precedence to internal DSCP map.
ip-prec-dscp
Syntax
show qos map ip-prec-dscp interface interface
interface
ethernet unit/port
unit - Stack unit. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
Command Usage
If the QoS mapping mode is set to IP Precedence and the ingress packet type is
IPv4, then the IP Precedence-to-DSCP mapping table is used to generate per-hop
behavior and drop precedence values for internal processing.
Example
Console#show qos map ip-prec-dscp interface ethernet 1/5
Information of Eth 1/5
IP-prec-DSCP map:
IP-prec: 0 1 2 3 4 5 6 7
------------------------------------------------------------
PHB: 0 1 2 3 4 5 6 7
drop precedence: 0 0 0 0 0 0 0 0
Console#
show qos map This command shows internal per-hop behavior to hardware queue map.
phb-queue
Syntax
show qos map phb-queue interface interface
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
– 620 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 3 and 4)
Example
Console#show qos map phb-queue interface ethernet 1/5
Information of Eth 1/5
PHB-queue map:
PHB: 0 1 2 3 4 5 6 7
-------------------------------------------------------
queue: 2 0 1 3 4 5 6 7
Console#
show qos map This command shows the QoS mapping mode.
trust-mode
Syntax
show qos map trust-mode interface interface
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Example
The following shows that the trust mode is set to CoS:
– 621 –
Chapter 22 | Class of Service Commands
Priority Commands (Layer 3 and 4)
– 622 –
23 Quality of Service Commands
police flow Defines an enforcer for classified traffic based on a metered PM-C
flow rate
police srtcm-color Defines an enforcer for classified traffic based on a single PM-C
rate three color meter
police trtcm-color Defines an enforcer for classified traffic based on a two rate PM-C
three color meter
set cos Services IP traffic by setting a class of service value for PM-C
matching packets for internal processing
set ip dscp Services IP traffic by setting a IP DSCP value for matching PM-C
packets for internal processing
set phb Services IP traffic by setting a per-hop behavior value for PM-C
matching packets for internal processing
show class-map Displays the QoS class maps which define matching criteria PE
used for classifying traffic
show policy-map Displays the QoS policy maps which define classification PE
criteria for incoming traffic, and may include policers for
bandwidth limitations
show policy-map interface Displays the configuration of all classes configured for all PE
service policies on the specified interface
– 623 –
Chapter 23 | Quality of Service Commands
To create a service policy for a specific category of ingress traffic, follow these steps:
1. Use the class-map command to designate a class name for a specific category
of traffic, and enter the Class Map configuration mode.
2. Use the match command to select a specific type of traffic based on an access
list, an IPv4 DSCP value, IPv4 Precedence value, a VLAN, or a CoS value.
3. Use the policy-map command to designate a policy name for a specific manner
in which ingress traffic will be handled, and enter the Policy Map configuration
mode.
4. Use the class command to identify the class map, and enter Policy Map Class
configuration mode. A policy map can contain up to 16 class maps.
5. Use the set phb or set cos or set ip dscp command to modify the per-hop
behavior, the class of service value in the VLAN tag, or the priority bits in the IP
header (IP DSCP value) for the matching traffic class, and use one of the police
commands to monitor parameters such as the average flow and burst rate, and
drop any traffic that exceeds the specified rate, or just reduce the DSCP service
level for traffic exceeding the specified rate.
class-map This command creates a class map used for matching packets to the specified class,
and enters Class Map configuration mode. Use the no form to delete a class map.
Syntax
class-map class-map-name match-any
no class-map class-map-name
class-map-name - Name of the class map. (Range: 1-32 characters)
match-any - Match any condition within a class map.
Default Setting
None
Command Mode
Global Configuration
– 624 –
Chapter 23 | Quality of Service Commands
Command Usage
◆ First enter this command to designate a class map and enter the Class Map
configuration mode. Then use match commands to specify the criteria for
ingress traffic that will be classified under this class map.
◆ One or more class maps can be assigned to a policy map (page 627). The policy
map is then bound by a service policy to an interface (page 638). A service
policy defines packet classification, service tagging, and bandwidth policing.
Example
This example creates a class map call “rd-class,” and sets it to match packets marked
for DSCP service value 3:
Related Commands
show class-map (638)
description This command specifies the description of a class map or policy map.Use the no
form of the command to remove the description.
Syntax
description string
no description
string - Description of the class map or policy map. (Range: 1-64 characters)
Command Mode
Class Map Configuration
Policy Map Configuration
Example
Console(config)#class-map rd-class#1
Console(config-cmap)#description matches packets marked for DSCP service
value 3
Console(config-cmap)#
– 625 –
Chapter 23 | Quality of Service Commands
match This command defines the criteria used to classify traffic. Use the no form to delete
the matching criteria.
Syntax
[no] match {access-list acl-name | cos cos | ip dscp dscp |
ip precedence ip-precedence | vlan vlan}
acl-name - Name of the access control list. Any type of ACL can be specified,
including standard or extended IP ACLs and MAC ACLs.
(Range: 1-16 characters)
cos - A Class of Service value. (Range: 0-7)
dscp - A Differentiated Service Code Point value. (Range: 0-63)
ip-precedence - An IP Precedence value. (Range: 0-7)
vlan - A VLAN. (Range:1-4094)
Default Setting
None
Command Mode
Class Map Configuration
Command Usage
◆ First enter the class-map command to designate a class map and enter the
Class Map configuration mode. Then use match commands to specify the fields
within ingress packets that must match to qualify for this class map.
◆ If an ingress packet matches an ACL specified by this command, any deny rules
included in the ACL will be ignored.
◆ If match criteria includes an IP ACL or IP priority rule, then a VLAN rule cannot
be included in the same class map.
◆ If match criteria includes a MAC ACL or VLAN rule, then neither an IP ACL nor IP
priority rule can be included in the same class map.
Example
This example creates a class map called “rd-class#1,” and sets it to match packets
marked for DSCP service value 3.
– 626 –
Chapter 23 | Quality of Service Commands
This example creates a class map call “rd-class#2,” and sets it to match packets
marked for IP Precedence service value 5.
This example creates a class map call “rd-class#3,” and sets it to match packets
marked for VLAN 1.
rename This command redefines the name of a class map or policy map.
Syntax
rename map-name
map-name - Name of the class map or policy map. (Range: 1-32 characters)
Command Mode
Class Map Configuration
Policy Map Configuration
Example
Console(config)#class-map rd-class#1
Console(config-cmap)#rename rd-class#9
Console(config-cmap)#
policy-map This command creates a policy map that can be attached to multiple interfaces,
and enters Policy Map configuration mode. Use the no form to delete a policy map.
Syntax
[no] policy-map policy-map-name
policy-map-name - Name of the policy map. (Range: 1-32 characters)
Default Setting
None
Command Mode
Global Configuration
– 627 –
Chapter 23 | Quality of Service Commands
Command Usage
◆ Use the policy-map command to specify the name of the policy map, and then
use the class command to configure policies for traffic that matches the criteria
defined in a class map.
◆ A policy map can contain multiple class statements that can be applied to the
same interface with the service-policy command.
Example
This example creates a policy called “rd-policy,” uses the class command to specify
the previously defined “rd-class,” uses the set command to classify the service that
incoming packets will receive, and then uses the police flow command to limit the
average bandwidth to 100,000 Kbps, the burst rate to 4000 bytes, and configure the
response to drop any violating packets.
Console(config)#policy-map rd-policy
Console(config-pmap)#class rd-class
Console(config-pmap-c)#set cos 0
Console(config-pmap-c)#police flow 10000 4000 conform-action transmit
violate-action drop
Console(config-pmap-c)#
class This command defines a traffic classification upon which a policy can act, and
enters Policy Map Class configuration mode. Use the no form to delete a class map.
Syntax
[no] class class-map-name
class-map-name - Name of the class map. (Range: 1-32 characters)
Default Setting
None
Command Mode
Policy Map Configuration
Command Usage
◆ Use the policy-map command to specify a policy map and enter Policy Map
configuration mode. Then use the class command to enter Policy Map Class
configuration mode. And finally, use the set command and one of the police
commands to specify the match criteria, where the:
■ set phb command sets the per-hop behavior value in matching packets.
(This modifies packet priority for internal processing only.)
– 628 –
Chapter 23 | Quality of Service Commands
■ set cos command sets the class of service value in matching packets.
(This modifies packet priority in the VLAN tag.)
Example
This example creates a policy called “rd-policy,” uses the class command to specify
the previously defined “rd-class,” uses the set phb command to classify the service
that incoming packets will receive, and then uses the police flow command to limit
the average bandwidth to 100,000 Kbps, the burst rate to 4,000 bytes, and
configure the response to drop any violating packets.
Console(config)#policy-map rd-policy
Console(config-pmap)#class rd-class
Console(config-pmap-c)#set phb 3
Console(config-pmap-c)#police flow 10000 4000 conform-action transmit
violate-action drop
Console(config-pmap-c)#
police flow This command defines an enforcer for classified traffic based on the metered flow
rate. Use the no form to remove a policer.
Syntax
[no] police flow committed-rate committed-burst
conform-action {transmit | new-dscp}
violate-action {drop | new-dscp}
committed-rate - Committed information rate (CIR) in kilobits per second.
(Range: 0-10000000 kbps or maximum port speed, whichever is lower)
committed-burst - Committed burst size (BC) in bytes.
(Range: 64-16000000 bytes)
conform-action - Action to take when packet is within the CIR and BC.
(There are enough tokens to service the packet, the packet is set green).
violate-action - Action to take when packet exceeds the CIR and BC. (There
are not enough tokens to service the packet, the packet is set red).
transmit - Transmits without taking any action.
drop - Drops packet as required by violate-action.
new-dscp - Differentiated Service Code Point (DSCP) value. (Range: 0-63)
Default Setting
None
– 629 –
Chapter 23 | Quality of Service Commands
Command Mode
Policy Map Class Configuration
Command Usage
◆ You can configure up to 16 policers (i.e., class maps) for ingress ports.
◆ Policing is based on a token bucket, where bucket depth (i.e., the maximum
burst before the bucket overflows) is by specified the committed-burst field, and
the average rate tokens are added to the bucket is by specified by the
committed-rate option. Note that the token bucket functions similar to that
described in RFC 2697 and RFC 2698.
◆ The behavior of the meter is specified in terms of one token bucket (C), the rate
at which the tokens are incremented (CIR – Committed Information Rate), and
the maximum size of the token bucket (BC – Committed Burst Size).
The token bucket C is initially full, that is, the token count Tc(0) = BC. Thereafter,
the token count Tc is updated CIR times per second as follows:
■ If Tc is less than BC, Tc is incremented by one, else
■ Tc is not incremented.
Example
This example creates a policy called “rd-policy,” uses the class command to specify
the previously defined “rd-class,” uses the set phb command to classify the service
that incoming packets will receive, and then uses the police flow command to limit
the average bandwidth to 100,000 Kbps, the burst rate to 4000 bytes, and configure
the response to drop any violating packets.
Console(config)#policy-map rd-policy
Console(config-pmap)#class rd-class
Console(config-pmap-c)#set phb 3
Console(config-pmap-c)#police flow 100000 4000 conform-action transmit
violate-action drop
Console(config-pmap-c)#
– 630 –
Chapter 23 | Quality of Service Commands
police srtcm-color This command defines an enforcer for classified traffic based on a single rate three
color meter (srTCM). Use the no form to remove a policer.
Syntax
[no] police {srtcm-color-blind | srtcm-color-aware}
committed-rate committed-burst excess-burst
conform-action {transmit | new-dscp}
exceed-action {drop | new-dscp}
violate action {drop | new-dscp}
srtcm-color-blind - Single rate three color meter in color-blind mode.
srtcm-color-aware - Single rate three color meter in color-aware mode.
committed-rate - Committed information rate (CIR) in kilobits per second.
(Range: 0-10000000 kbps or maximum port speed, whichever is lower)
committed-burst - Committed burst size (BC) in bytes.
(Range: 64-16000000 bytes)
excess-burst - Excess burst size (BE) in bytes. (Range: 64-16000000 bytes)
conform-action - Action to take when rate is within the CIR and BC. (There
are enough tokens in bucket BC to service the packet, packet is set green).
exceed-action - Action to take when rate exceeds the CIR and BC but is
within the BE. (There are enough tokens in bucket BE to service the packet,
the packet is set yellow.)
violate-action - Action to take when rate exceeds the BE. (There are not
enough tokens in bucket BE to service the packet, the packet is set red.)
transmit - Transmits without taking any action.
drop - Drops packet as required by exceed-action or violate-action.
new-dscp - Differentiated Service Code Point (DSCP) value. (Range: 0-63)
Default Setting
None
Command Mode
Policy Map Class Configuration
Command Usage
◆ You can configure up to 16 policers (i.e., class maps) for ingress ports.
◆ The srTCM as defined in RFC 2697 meters a traffic stream and processes its
packets according to three traffic parameters – Committed Information Rate
(CIR), Committed Burst Size (BC), and Excess Burst Size (BE).
◆ The PHB label is composed of five bits, three bits for per-hop behavior, and two
bits for the color scheme used to control queue congestion. A packet is marked
green if it doesn't exceed the CIR and BC, yellow if it does exceed the CIR and
BC, but not the BE, and red otherwise.
– 631 –
Chapter 23 | Quality of Service Commands
◆ The meter operates in one of two modes. In the color-blind mode, the meter
assumes that the packet stream is uncolored. In color-aware mode the meter
assumes that some preceding entity has pre-colored the incoming packet
stream so that each packet is either green, yellow, or red. The marker (re)colors
an IP packet according to the results of the meter. The color is coded in the DS
field [RFC 2474] of the packet.
◆ The behavior of the meter is specified in terms of its mode and two token
buckets, C and E, which both share the common rate CIR. The maximum size of
the token bucket C is BC and the maximum size of the token bucket E is BE.
The token buckets C and E are initially full, that is, the token count Tc(0) = BC
and the token count Te(0) = BE. Thereafter, the token counts Tc and Te are
updated CIR times per second as follows:
■ If Tc is less than BC, Tc is incremented by one, else
■ if Te is less then BE, Te is incremented by one, else
■ neither Tc nor Te is incremented.
When a packet of size B bytes arrives at time t, the following happens if srTCM is
configured to operate in color-blind mode:
■ If Tc(t)-B 0, the packet is green and Tc is decremented by B down to the
minimum value of 0, else
■ if Te(t)-B 0, the packets is yellow and Te is decremented by B down to the
minimum value of 0,
■ else the packet is red and neither Tc nor Te is decremented.
When a packet of size B bytes arrives at time t, the following happens if srTCM is
configured to operate in color-aware mode:
■ If the packet has been precolored as green and Tc(t)-B 0, the packet is
green and Tc is decremented by B down to the minimum value of 0, else
■ If the packet has been precolored as yellow or green and if
■ Te(t)-B 0, the packets is yellow and Te is decremented by B down to the
minimum value of 0, else the packet is red and neither Tc nor Te is
decremented.
Example
This example creates a policy called “rd-policy,” uses the class command to specify
the previously defined “rd-class,” uses the set phb command to classify the service
that incoming packets will receive, and then uses the police srtcm-color-blind
command to limit the average bandwidth to 100,000 Kbps, the committed burst
rate to 4000 bytes, the excess burst rate to 6000 bytes, to remark any packets
exceeding the committed burst size, and to drop any packets exceeding the excess
burst size.
– 632 –
Chapter 23 | Quality of Service Commands
Console(config)#policy-map rd-policy
Console(config-pmap)#class rd-class
Console(config-pmap-c)#set phb 3
Console(config-pmap-c)#police srtcm-color-blind 100000 4000 6000 conform-
action transmit exceed-action 0 violate-action drop
Console(config-pmap-c)#
police trtcm-color This command defines an enforcer for classified traffic based on a two rate three
color meter (trTCM). Use the no form to remove a policer.
Syntax
[no] police {trtcm-color-blind | trtcm-color-aware}
committed-rate committed-burst peak-rate peak-burst
conform-action {transmit | new-dscp}
exceed-action {drop | new-dscp}
violate action {drop | new-dscp}
trtcm-color-blind - Two rate three color meter in color-blind mode.
trtcm-color-aware - Two rate three color meter in color-aware mode.
committed-rate - Committed information rate (CIR) in kilobits per second.
(Range: 0-10000000 kbps or maximum port speed, whichever is lower)
committed-burst - Committed burst size (BC) in bytes.
(Range: 64-16000000 bytes)
peak-rate - Peak information rate (PIR) in kilobits per second.
(Range: 0-1000000 kbps or maximum port speed, whichever is lower)
peak-burst - Peak burst size (BP) in bytes. (Range: 64-16000000 bytes)
conform-action - Action to take when rate is within the CIR and BP. (Packet
size does not exceed BP and there are enough tokens in bucket BC to
service the packet, the packet is set green.)
exceed-action - Action to take when rate exceeds the CIR but is within the
PIR. (Packet size exceeds BC but there are enough tokens in bucket BP to
service the packet, the packet is set yellow.)
violate-action - Action to take when rate exceeds the PIR. (There are not
enough tokens in bucket BP to service the packet, the packet is set red.)
drop - Drops packet as required by exceed-action or violate-action.
transmit - Transmits without taking any action.
new-dscp - Differentiated Service Code Point (DSCP) value. (Range: 0-63)
Default Setting
None
Command Mode
Policy Map Class Configuration
– 633 –
Chapter 23 | Quality of Service Commands
Command Usage
◆ You can configure up to 16 policers (i.e., class maps) for ingress ports.
◆ The trTCM as defined in RFC 2698 meters a traffic stream and processes its
packets based on two rates – Committed Information Rate (CIR) and Peak
Information Rate (PIR), and their associated burst sizes - Committed Burst Size
(BC) and Peak Burst Size (BP).
◆ The PHB label is composed of five bits, three bits for per-hop behavior, and two
bits for the color scheme used to control queue congestion. A packet is marked
red if it exceeds the PIR. Otherwise it is marked either yellow or green
depending on whether it exceeds or doesn't exceed the CIR.
The trTCM is useful for ingress policing of a service, where a peak rate needs to
be enforced separately from a committed rate.
◆ The meter operates in one of two modes. In the color-blind mode, the meter
assumes that the packet stream is uncolored. In color-aware mode the meter
assumes that some preceding entity has pre-colored the incoming packet
stream so that each packet is either green, yellow, or red. The marker (re)colors
an IP packet according to the results of the meter. The color is coded in the DS
field [RFC 2474] of the packet.
◆ The behavior of the meter is specified in terms of its mode and two token
buckets, P and C, which are based on the rates PIR and CIR, respectively. The
maximum size of the token bucket P is BP and the maximum size of the token
bucket C is BC.
◆ The token buckets P and C are initially (at time 0) full, that is, the token count
Tp(0) = BP and the token count Tc(0) = BC. Thereafter, the token count Tp is
incremented by one PIR times per second up to BP and the token count Tc is
incremented by one CIR times per second up to BC.
When a packet of size B bytes arrives at time t, the following happens if trTCM is
configured to operate in color-blind mode:
■ If Tp(t)-B < 0, the packet is red, else
■ if Tc(t)-B < 0, the packet is yellow and Tp is decremented by B, else
■ the packet is green and both Tp and Tc are decremented by B.
When a packet of size B bytes arrives at time t, the following happens if trTCM is
configured to operate in color-aware mode:
■ If the packet has been precolored as red or if Tp(t)-B < 0, the packet is red,
else
■ if the packet has been precolored as yellow or if Tc(t)-B < 0, the packet is
yellow and Tp is decremented by B, else
■ the packet is green and both Tp and Tc are decremented by B.
◆ The trTCM can be used to mark a IP packet stream in a service, where different,
decreasing levels of assurances (either absolute or relative) are given to packets
– 634 –
Chapter 23 | Quality of Service Commands
which are green, yellow, or red. Refer to RFC 2698 for more information on
other aspects of trTCM.
Example
This example creates a policy called “rd-policy,” uses the class command to specify
the previously defined “rd-class,” uses the set phb command to classify the service
that incoming packets will receive, and then uses the police trtcm-color-blind
command to limit the average bandwidth to 100,000 Kbps, the committed burst
rate to 4000 bytes, the peak information rate to 1,000,000 kbps, the peak burst size
to 6000, to remark any packets exceeding the committed burst size, and to drop
any packets exceeding the peak information rate.
Console(config)#policy-map rd-policy
Console(config-pmap)#class rd-class
Console(config-pmap-c)#set phb 3
Console(config-pmap-c)#police trtcm-color-blind 100000 4000 100000 6000
conform-action transmit exceed-action 0 violate-action drop
Console(config-pmap-c)#
set cos This command modifies the class of service (CoS) value for a matching packet (as
specified by the match command) in the packet’s VLAN tag. Use the no form to
remove this setting.
Syntax
[no] set cos cos-value
cos-value - Class of Service value. (Range: 0-7)
Default Setting
None
Command Mode
Policy Map Class Configuration
Command Usage
◆ The set cos command is used to set the CoS value in the VLAN tag for matching
packets.
◆ The set cos and set phb command function at the same level of priority.
Therefore setting either of these commands will overwrite any action already
configured by the other command.
– 635 –
Chapter 23 | Quality of Service Commands
Example
This example creates a policy called “rd-policy,” uses the class command to specify
the previously defined “rd-class,” uses the set cos command to classify the service
that incoming packets will receive, and then uses the police flow command to limit
the average bandwidth to 100,000 Kbps, the burst rate to 4000 bytes, and configure
the response to drop any violating packets.
Console(config)#policy-map rd-policy
Console(config-pmap)#class rd-class
Console(config-pmap-c)#set cos 3
Console(config-pmap-c)#police flow 100000 4000 conform-action transmit
violate-action drop
Console(config-pmap-c)#
set ip dscp This command modifies the IP DSCP value in a matching packet (as specified by the
match command). Use the no form to remove this traffic classification.
Syntax
[no] set ip dscp new-dscp
new-dscp - New Differentiated Service Code Point (DSCP) value.
(Range: 0-63)
Default Setting
None
Command Mode
Policy Map Class Configuration
Command Usage
The set ip dscp command is used to set the priority values in the packet’s ToS field
for matching packets.
Example
This example creates a policy called “rd-policy,” uses the class command to specify
the previously defined “rd-class,” uses the set ip dscp command to classify the
service that incoming packets will receive, and then uses the police flow command
to limit the average bandwidth to 100,000 Kbps, the burst rate to 4000 bytes, and
configure the response to drop any violating packets.
Console(config)#policy-map rd-policy
Console(config-pmap)#class rd-class
Console(config-pmap-c)#set ip dscp 3
Console(config-pmap-c)#police flow 10000 4000 conform-action transmit
violate-action drop
Console(config-pmap-c)#
– 636 –
Chapter 23 | Quality of Service Commands
set phb This command services IP traffic by setting a per-hop behavior value for a matching
packet (as specified by the match command) for internal processing. Use the no
form to remove this setting.
Syntax
[no] set phb phb-value
phb-value - Per-hop behavior value. (Range: 0-7)
Default Setting
None
Command Mode
Policy Map Class Configuration
Command Usage
◆ The set phb command is used to set an internal QoS value in hardware for
matching packets (see Table 119, "Default Mapping of CoS/CFI to Internal PHB/
Drop Precedence"). The QoS label is composed of five bits, three bits for per-
hop behavior, and two bits for the color scheme used to control queue
congestion by the police srtcm-color command and police trtcm-color
command.
◆ The set cos and set phb command function at the same level of priority.
Therefore setting either of these commands will overwrite any action already
configured by the other command.
Example
This example creates a policy called “rd-policy,” uses the class command to specify
the previously defined “rd-class,” uses the set phb command to classify the service
that incoming packets will receive, and then uses the police flow command to limit
the average bandwidth to 100,000 Kbps, the burst rate to 4000 bytes, and configure
the response to drop any violating packets.
Console(config)#policy-map rd-policy
Console(config-pmap)#class rd-class
Console(config-pmap-c)#set phb 3
Console(config-pmap-c)#police flow 10000 4000 conform-action transmit
violate-action drop
Console(config-pmap-c)#
– 637 –
Chapter 23 | Quality of Service Commands
service-policy This command applies a policy map defined by the policy-map command to the
ingress side of a particular interface. Use the no form to remove this mapping.
Syntax
[no] service-policy {input | output} policy-map-name
input - Apply to the input traffic.
output - Apply to the output traffic.
policy-map-name - Name of the policy map for this interface.
(Range: 1-32 characters)
Default Setting
No policy map is attached to an interface.
Command Mode
Interface Configuration (Ethernet)
Command Usage
◆ Only one policy map can be assigned to an interface.
◆ First define a class map, then define a policy map, and finally use the service-
policy command to bind the policy map to the required interface.
◆ The switch does not allow a policy map to be bound to an interface for egress
traffic.
Example
This example applies a service policy to an ingress interface.
show class-map This command displays the QoS class maps which define matching criteria used for
classifying traffic.
Syntax
show class-map [class-map-name]
class-map-name - Name of the class map. (Range: 1-32 characters)
Default Setting
Displays all class maps.
Command Mode
Privileged Exec
– 638 –
Chapter 23 | Quality of Service Commands
Example
Console#show class-map
Class Map match-any rd-class#1
Description:
Match IP DSCP 10
Match access-list rd-access
Match IP DSCP 0
Console#
show policy-map This command displays the QoS policy maps which define classification criteria for
incoming traffic, and may include policers for bandwidth limitations.
Syntax
show policy-map [policy-map-name [class class-map-name]]
policy-map-name - Name of the policy map. (Range: 1-32 characters)
class-map-name - Name of the class map. (Range: 1-32 characters)
Default Setting
Displays all policy maps and all classes.
Command Mode
Privileged Exec
Example
Console#show policy-map
Policy Map rd-policy
Description:
class rd-class
set phb 3
Console#show policy-map rd-policy class rd-class
Policy Map rd-policy
class rd-class
set phb 3
Console#
– 639 –
Chapter 23 | Quality of Service Commands
show policy-map This command displays the service policy assigned to the specified interface.
interface
Syntax
show policy-map interface interface input
interface
unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show policy-map interface 1/5 input
Service-policy rd-policy
Console#
– 640 –
24 Control Plane Commands
Network control packets that are received by the switch are handled by the CPU.
This traffic can potentially overwhelm the switch CPU and impact the overall
system performance. To prevent the switch CPU from receiving too much traffic,
QoS class maps and policy maps can be defined and applied as a service policy to
ingress traffic on the CPU’s “control-plane” interface.
For details on configuring QoS class maps and policy maps, see “Quality of Service
Commands” on page 623.
Syntax
control-plane
Command Mode
Global Configuration
Command Usage
You must enter control-plane interface configuration mode to bind a service policy
to the control-plane interface.
Example
Console(config)#control-plane
Console(config-cp)#
– 641 –
Chapter 24 | Control Plane Commands
service-policy This command applies a QoS policy map defined by the policy-map command to
the ingress side of the control-plane interface. Use the no form to remove this
mapping.
Syntax
[no] service-policy input policy-map-name
input - Apply to the input traffic.
policy-map-name - Name of the policy map for this interface.
(Range: 1-32 characters)
Default Setting
No policy map is attached to the control-plane interface.
Command Mode
Control-Plane Interface Configuration
Command Usage
◆ Only one policy map can be assigned to the control-plane interface.
◆ First define a class map, then define a policy map, and finally use the service-
policy command to bind the policy map to the control-plane interface.
◆ The switch does not allow a policy map to be bound to an interface for egress
traffic.
Example
This example applies a service policy to the control-plane interface.
Console(config)#control-plane
Console(config-cp)#service-policy input cpu-policy
Console(config-cp)#
show policy-map This command displays the QoS policy map that defines classification criteria for
control-plane incoming traffic on the control-plane interface.
Syntax
show policy-map control-plane input [class class-map-name] [hardware
counters]
class-map-name - Name of the class map. (Range: 1-32 characters)
hardware counters - Shows statistics for the policy or class.
Command Mode
Privileged Exec
– 642 –
Chapter 24 | Control Plane Commands
Example
Console#show policy-map control-plane input
Console#
– 643 –
Chapter 24 | Control Plane Commands
– 644 –
25 Multicast Filtering Commands
This switch uses IGMP (Internet Group Management Protocol) to check for any
attached hosts that want to receive a specific multicast service. It identifies the
ports containing hosts requesting a service and sends data out to those ports only.
It then propagates the service request up to any neighboring multicast switch/
router to ensure that it will continue to receive the multicast service.
IGMP Snooping Configures multicast groups via IGMP snooping or static assignment,
sets the IGMP version, enables proxy reporting, displays current
snooping settings, and displays the multicast service and group
members
Static Multicast Routing Configures static multicast router ports which forward all inbound
multicast traffic to the attached VLANs
MLD Filtering and Configures MLD filtering and throttling for IPv6.
Throttling
MVR for IPv4 Configures a single network-wide multicast VLAN shared by hosts
residing in other standard or private VLAN groups, preserving security
and data isolation for normal traffic
IGMP Snooping
This section describes commands used to configure IGMP snooping on the switch.
ip igmp snooping querier Allows this device to act as the querier for IGMP snooping GC
ip igmp snooping router- Discards any IGMPv2/v3 packets that do not include the GC
alert-option-check Router Alert option
– 645 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
ip igmp snooping tcn-flood Floods multicast traffic when a Spanning Tree topology GC
change occurs
ip igmp snooping vlan Suppresses general queries except for ports attached to GC
general-query-suppression downstream multicast hosts
ip igmp snooping vlan last- Configures the number of IGMP proxy query messages that GC
memb-query-count are sent out before the system assumes there are no local
members
ip igmp snooping vlan Configures a static address for proxy IGMP query and GC
proxy-address reporting
ip igmp snooping vlan Configures the interval between sending IGMP general GC
query-interval queries
ip igmp snooping vlan Configures the maximum time the system waits for a GC
query-resp-intvl response to general queries
– 646 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
show ip igmp snooping Shows the IGMP snooping, proxy, and query configuration PE
show ip igmp snooping Shows known multicast group, source, and host port PE
group mapping
show ip igmp snooping Shows IGMP snooping protocol statistics for the specified PE
statistics interface
ip igmp snooping This command enables IGMP snooping globally on the switch or on a selected
VLAN interface. Use the no form to disable it.
Syntax
[no] ip igmp snooping [vlan vlan-id]
vlan-id - VLAN ID (Range: 1-4094)
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ When IGMP snooping is enabled globally, the per VLAN interface settings for
IGMP snooping take precedence.
◆ When IGMP snooping is disabled globally, snooping can still be configured per
VLAN interface, but the interface settings will not take effect until snooping is
re-enabled globally.
Example
The following example enables IGMP snooping globally.
– 647 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
ip igmp snooping This command configures multicast router ports to forward multicast streams only
mrouter-forward- when multicast groups are joined. Use the no form to disable it.
mode dynamic
Syntax
ip igmp snooping mrouter-forward dynamic
no ip igmp snooping mrouter-forward
Default Setting
Disabled
Command Mode
Global Configuration
Example
The following example enables IGMP dynamic forwarding.
ip igmp snooping This command assigns a priority to all multicast traffic. Use the no form to restore
priority the default setting.
Syntax
ip igmp snooping priority priority
no ip igmp snooping priority
priority - The CoS priority assigned to all multicast traffic. (Range: 0-7, where
7 is the highest priority)
Default Setting
2
Command Mode
Global Configuration
Command Usage
This command can be used to set a high priority for low-latency multicast traffic
such as a video-conference, or to set a low priority for normal multicast traffic not
sensitive to latency.
Example
Console(config)#ip igmp snooping priority 6
Console(config)#
– 648 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
ip igmp snooping This command enables IGMP Snooping with Proxy Reporting. Use the no form to
proxy-reporting restore the default setting.
Syntax
[no] ip igmp snooping proxy-reporting
ip igmp snooping vlan vlan-id proxy-reporting {enable | disable}
no ip igmp snooping vlan vlan-id proxy-reporting
vlan-id - VLAN ID (Range: 1-4094)
enable - Enable on the specified VLAN.
disable - Disable on the specified VLAN.
Default Setting
Global: Disabled
VLAN: Based on global setting
Command Mode
Global Configuration
Command Usage
◆ When proxy reporting is enabled with this command, reports received from
downstream hosts are summarized and used to build internal membership
states. Proxy-reporting devices may use the all-zeros IP source address when
forwarding any summarized reports upstream. For this reason, IGMP
membership reports received by the snooping switch must not be rejected
because the source IP address is set to 0.0.0.0.
◆ When proxy reporting is enabled with this command, the switch performs
“IGMP Snooping with Proxy Reporting” (as defined in DSL Forum TR-101, April
2006), including report suppression, last leave, and query suppression. Report
suppression intercepts, absorbs and summarizes IGMP reports coming from
downstream hosts. Last leave sends out a proxy query when the last member
leaves a multicast group, and query suppression means that specific queries
are not forwarded from an upstream multicast router to hosts downstream
from this device.
Example
Console(config)#ip igmp snooping proxy-reporting
Console(config)#
– 649 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
ip igmp snooping This command enables the switch as an IGMP querier. Use the no form to disable it.
querier
Syntax
[no] ip igmp snooping querier
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ IGMP snooping querier is not supported for IGMPv3 snooping (see ip igmp
snooping version).
◆ If enabled, the switch will serve as querier if elected. The querier is responsible
for asking hosts if they want to receive multicast traffic.
Example
Console(config)#ip igmp snooping querier
Console(config)#
ip igmp snooping This command discards any IGMPv2/v3 packets that do not include the Router
router-alert-option- Alert option. Use the no form to ignore the Router Alert Option when receiving
check IGMP messages.
Syntax
[no] ip igmp snooping router-alert-option-check
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
As described in Section 9.1 of RFC 3376 for IGMP Version 3, the Router Alert Option
can be used to protect against DOS attacks. One common method of attack is
launched by an intruder who takes over the role of querier, and starts overloading
multicast hosts by sending a large number of group-and-source-specific queries,
each with a large source list and the Maximum Response Time set to a large value.
To protect against this kind of attack, (1) routers should not forward queries. This is
easier to accomplish if the query carries the Router Alert option. (2) Also, when the
switch is acting in the role of a multicast host (such as when using proxy routing), it
should ignore version 2 or 3 queries that do not contain the Router Alert option.
– 650 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Example
Console(config)#ip igmp snooping router-alert-option-check
Console(config)#
ip igmp snooping This command configures the querier timeout. Use the no form to restore the
router-port- default.
expire-time
Syntax
ip igmp snooping router-port-expire-time seconds
no ip igmp snooping router-port-expire-time
seconds - The time the switch waits after the previous querier stops before
it considers it to have expired. (Range: 1-65535;
Recommended Range: 300-500)
Default Setting
300 seconds
Command Mode
Global Configuration
Example
The following shows how to configure the timeout to 400 seconds:
ip igmp snooping This command enables flooding of multicast traffic if a spanning tree topology
tcn-flood change notification (TCN) occurs. Use the no form to disable flooding.
Syntax
[no] ip igmp snooping tcn-flood
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ When a spanning tree topology change occurs, the multicast membership
information learned by the switch may be out of date. For example, a host
linked to one port before the topology change (TC) may be moved to another
port after the change. To ensure that multicast data is delivered to all receivers,
– 651 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
◆ If a topology change notification (TCN) is received, and all the uplink ports are
subsequently deleted, a timeout mechanism is used to delete all of the
currently learned multicast channels.
◆ When a new uplink port starts up, the switch sends unsolicited reports for all
current learned channels out through the new uplink port.
◆ By default, the switch immediately enters into “multicast flooding mode” when
a spanning tree topology change occurs. In this mode, multicast traffic will be
flooded to all VLAN ports. If many ports have subscribed to different multicast
groups, flooding may cause excessive loading on the link between the switch
and the end host. Flooding may be disabled to avoid this, causing multicast
traffic to be delivered only to those ports on which multicast group members
have been learned.
◆ When the spanning tree topology changes, the root bridge sends a proxy
query to quickly re-learn the host membership/port relations for multicast
channels. The root bridge also sends an unsolicited Multicast Router Discover
(MRD) request to quickly locate the multicast routers in this VLAN.
The proxy query and unsolicited MRD request are flooded to all VLAN ports
except for the receiving port when the switch receives such packets.
Example
The following example enables TCN flooding.
ip igmp snooping This command instructs the switch to send out an IGMP general query solicitation
tcn-query-solicit when a spanning tree topology change notification (TCN) occurs. Use the no form
to disable this feature.
Syntax
[no] ip igmp snooping tcn-query-solicit
Default Setting
Disabled
Command Mode
Global Configuration
– 652 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Command Usage
◆ When the root bridge in a spanning tree receives a topology change
notification for a VLAN where IGMP snooping is enabled, it issues a global IGMP
leave message (query solicitation). When a switch receives this solicitation, it
floods it to all ports in the VLAN where the spanning tree change occurred.
When an upstream multicast router receives this solicitation, it will also
immediately issues an IGMP general query.
Example
The following example instructs the switch to issue an IGMP general query
whenever it receives a spanning tree topology change notification.
ip igmp snooping This command floods unregistered multicast traffic into the attached VLAN. Use the
unregistered-data- no form to drop unregistered multicast traffic.
flood
Syntax
[no] ip igmp snooping unregistered-data-flood
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
Once the table used to store multicast entries for IGMP snooping and multicast
routing is filled, no new entries are learned. If no router port is configured in the
attached VLAN, and unregistered-flooding is disabled, any subsequent multicast
traffic not found in the table is dropped, otherwise it is flooded throughout the
VLAN.
Example
Console(config)#ip igmp snooping unregistered-data-flood
Console(config)#
– 653 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
ip igmp snooping This command specifies how often the upstream interface should transmit
unsolicited-report- unsolicited IGMP reports when report suppression/proxy reporting is enabled. Use
interval the no form to restore the default value.
Syntax
ip igmp snooping unsolicited-report-interval seconds
no ip igmp snooping unsolicited-report-interval
seconds - The interval at which to issue unsolicited reports. (Range: 1-65535
seconds)
Default Setting
400 seconds
Command Mode
Global Configuration
Command Usage
◆ When a new upstream interface (that is, uplink port) starts up, the switch sends
unsolicited reports for all currently learned multicast channels out through the
new upstream interface.
Example
Console(config)#ip igmp snooping unsolicited-report-interval 5
Console(config)#
ip igmp snooping This command configures the IGMP snooping version. Use the no form to restore
version the default.
Syntax
ip igmp snooping [vlan vlan-id] version {1 | 2 | 3}
no ip igmp [vlan vlan-id] snooping version
vlan-id - VLAN ID (Range: 1-4094)
1 - IGMP Version 1
2 - IGMP Version 2
3 - IGMP Version 3
Default Setting
Global: IGMP Version 2
VLAN: Not configured, based on global setting
– 654 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Command Mode
Global Configuration
Command Usage
◆ This command configures the IGMP report/query version used by IGMP
snooping. Versions 1 - 3 are all supported, and versions 2 and 3 are backward
compatible, so the switch can operate with other devices, regardless of the
snooping version employed.
Example
The following configures the global setting for IGMP snooping to version 1.
ip igmp snooping This command discards any received IGMP messages (except for multicast protocol
version-exclusive packets) which use a version different to that currently configured by the ip igmp
snooping version command. Use the no form to disable this feature.
Syntax
ip igmp snooping [vlan vlan-id] version-exclusive
no ip igmp snooping version-exclusive
vlan-id - VLAN ID (Range: 1-4094)
Default Setting
Global: Disabled
VLAN: Using Global Status
Command Mode
Global Configuration
VLAN Configuration
Command Usage
◆ If version exclusive is disabled on a VLAN, then this setting is based on the
global setting. If it is enabled on a VLAN, then this setting takes precedence
over the global setting.
– 655 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Example
Console(config)#ip igmp snooping version-exclusive
Console(config)#
ip igmp snooping vlan This command suppresses general queries except for ports attached to
general-query- downstream multicast hosts. Use the no form to flood general queries to all ports
suppression except for the multicast router port.
Syntax
[no] ip igmp snooping vlan vlan-id general-query-suppression
vlan-id - VLAN ID (Range: 1-4094)
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ By default, general query messages are flooded to all ports, except for the
multicast router through which they are received.
Example
Console(config)#ip igmp snooping vlan 1 general-query-suppression
Console(config)#
ip igmp snooping vlan This command immediately deletes a member port of a multicast service if a leave
immediate-leave packet is received at that port and immediate-leave is enabled for the parent VLAN.
Use the no form to restore the default.
Syntax
ip igmp snooping vlan vlan-id immediate-leave [by-host-ip]
no ip igmp snooping vlan vlan-id immediate-leave
vlan-id - VLAN ID (Range: 1-4094)
by-host-ip - Specifies that the member port will be deleted only when
there are no hosts joining this group.
Default Setting
Disabled
– 656 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Command Mode
Global Configuration
Command Usage
◆ If immediate-leave is not used, a multicast router (or querier) will send a group-
specific query message when an IGMPv2/v3 group leave message is received.
The router/querier stops forwarding traffic for that group only if no host replies
to the query within the timeout period. (The timeout for this release is defined
by Last Member Query Interval (fixed at one second) * Robustness Variable
(fixed at 2) as defined in RFC 2236.)
◆ If immediate-leave is used, the switch assumes that only one host is connected
to the interface. Therefore, immediate leave should only be enabled on an
interface if it is connected to only one IGMP-enabled device, either a service
host or a neighbor running IGMP snooping.
◆ If the “by-host-ip” option is used, the router/querier will not send out a group-
specific query when an IGMPv2/v3 leave message is received. But will check if
there are other hosts joining the multicast group. Only when all hosts on that
port leave the group will the member port be deleted.
Example
The following shows how to enable immediate leave.
ip igmp snooping vlan This command configures the number of IGMP proxy group-specific or group-and-
last-memb-query- source-specific query messages that are sent out before the system assumes there
count are no more local members. Use the no form to restore the default.
Syntax
ip igmp snooping vlan vlan-id last-memb-query-count count
no ip igmp snooping vlan vlan-id last-memb-query-count
vlan-id - VLAN ID (Range: 1-4094)
count - The number of proxy group-specific or group-and-source-specific
query messages to issue before assuming that there are no more group
members. (Range: 1-255)
Default Setting
2
– 657 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Command Mode
Global Configuration
Command Usage
This command will take effect only if IGMP snooping proxy reporting or IGMP
querier is enabled (page 649).
Example
Console(config)#ip igmp snooping vlan 1 last-memb-query-count 7
Console(config)#
ip igmp snooping vlan This command configures the last-member-query interval. Use the no form to
last-memb-query- restore the default.
intvl
Syntax
ip igmp snooping vlan vlan-id last-memb-query-intvl interval
no ip igmp snooping vlan vlan-id last-memb-query-intvl
vlan-id - VLAN ID (Range: 1-4094)
interval - The interval to wait for a response to a group-specific or group-
and-source-specific query message. (Range: 1-31744 tenths of a second)
Default Setting
10 (1 second)
Command Mode
Global Configuration
Command Usage
◆ When a multicast host leaves a group, it sends an IGMP leave message. When
the leave message is received by the switch, it checks to see if this host is the
last to leave the group by sending out an IGMP group-specific or group-and-
source-specific query message, and starts a timer. If no reports are received
before the timer expires, the group record is deleted, and a report is sent to the
upstream multicast router.
◆ A reduced value will result in reduced time to detect the loss of the last
member of a group or source, but may generate more bursty traffic.
◆ This command will take effect only if IGMP snooping proxy reporting is enabled
(page 649).
Example
Console(config)#ip igmp snooping vlan 1 last-memb-query-intvl 700
Console(config)#
– 658 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
ip igmp snooping vlan This command enables sending of multicast router solicitation messages. Use the
mrd no form to disable these messages.
Syntax
[no] ip igmp snooping vlan vlan-id mrd
vlan-id - VLAN ID (Range: 1-4094)
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ Multicast Router Discovery (MRD) uses multicast router advertisement,
multicast router solicitation, and multicast router termination messages to
discover multicast routers. Devices send solicitation messages in order to solicit
advertisement messages from multicast routers. These messages are used to
discover multicast routers on a directly attached link. Solicitation messages are
also sent whenever a multicast forwarding interface is initialized or re-
initialized. Upon receiving a solicitation on an interface with IP multicast
forwarding and MRD enabled, a router will respond with an advertisement.
Example
This example disables sending of multicast router solicitation messages on VLAN 1.
– 659 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
ip igmp snooping vlan This command configures a static source address for locally generated query and
proxy-address report messages used by IGMP proxy reporting. Use the no form to restore the
default source address.
Syntax
no ip igmp snooping vlan vlan-id proxy-address source-address
no ip igmp snooping vlan vlan-id proxy-address
vlan-id - VLAN ID (Range: 1-4094)
source-address - The source address used for proxied IGMP query and
report, and leave messages. (Any valid IP unicast address)
Default Setting
0.0.0.0
Command Mode
Global Configuration
Command Usage
IGMP Snooping uses a null IP address of 0.0.0.0 for the source of IGMP query
messages which are proxied to downstream hosts to indicate that it is not the
elected querier, but is only proxying these messages as defined in RFC 4541. The
switch also uses a null address in IGMP reports sent to upstream ports.
Many hosts do not implement RFC 4541, and therefore do not understand query
messages with the source address of 0.0.0.0. These hosts will therefore not reply to
the queries, causing the multicast router to stop sending traffic to them.
To resolve this problem, the source address in proxied IGMP query and report
messages can be replaced with any valid unicast address (other than the router's
own address) using this command.
– 660 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Example
The following example sets the source address for proxied IGMP query messages to
10.0.1.8.
ip igmp snooping vlan This command configures the interval between sending IGMP general queries. Use
query-interval the no form to restore the default.
Syntax
ip igmp snooping vlan vlan-id query-interval interval
no ip igmp snooping vlan vlan-id query-interval
vlan-id - VLAN ID (Range: 1-4094)
interval - The interval between sending IGMP general queries.
(Range: 2-31744 seconds)
Default Setting
125 seconds
Command Mode
Global Configuration
Command Usage
◆ An IGMP general query message is sent by the switch at the interval specified
by this command. When this message is received by downstream hosts, all
receivers build an IGMP report for the multicast groups they have joined.
◆ This command applies when the switch is serving as the querier (page 650), or
as a proxy host when IGMP snooping proxy reporting is enabled (page 649).
Example
Console(config)#ip igmp snooping vlan 1 query-interval 150
Console(config)#
– 661 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
ip igmp snooping vlan This command configures the maximum time the system waits for a response to
query-resp-intvl general queries. Use the no form to restore the default.
Syntax
ip igmp snooping vlan vlan-id query-resp-intvl interval
no ip igmp snooping vlan vlan-id query-resp-intvl
vlan-id - VLAN ID (Range: 1-4094)
interval - The maximum time the system waits for a response to general
queries. (Range: 10-31740 tenths of a second)
Default Setting
100 (10 seconds)
Command Mode
Global Configuration
Command Usage
This command applies when the switch is serving as the querier (page 650), or as a
proxy host when IGMP snooping proxy reporting is enabled (page 649).
Example
Console(config)#ip igmp snooping vlan 1 query-resp-intvl 20
Console(config)#
ip igmp snooping vlan Use the no form to disable this feature on all VLANs.
report-suppression
Syntax
ip igmp snooping vlan vlan-id report-suppression {enable | disable}
no ip igmp snooping report-suppression
vlan-id - VLAN ID (Range: 1-4094)
enable - Enable on the specified VLAN.
disable - Disable on the specified VLAN.
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ When IGMP snooping report suppression is enabled with this command, the
switch performs report suppression (as defined in DSL Forum TR-101, April
– 662 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
◆ IGMP reports are relayed to the router port only when necessary; that is, when
the first user joins a multicast group, and once only per multicast group in
response to an IGMP query.
◆ When report suppression and proxy reporting are both disabled, all IGMP
reports received by the switch are forwarded natively to the upstream multicast
routers.
Example
Console(config)#ip igmp snooping vlan 1 report-suppression enable
Console(config)#
ip igmp snooping vlan This command adds a port to a multicast group. Use the no form to remove the
static port.
Syntax
[no] ip igmp snooping vlan vlan-id static ip-address interface
vlan-id - VLAN ID (Range: 1-4094)
ip-address - IP address for multicast group
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
uplink - specifies an
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ Static multicast entries are never aged out.
– 663 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Example
The following shows how to statically configure a multicast group on a port.
ip igmp snooping This command enables immediate leave processing on the interface. Use the no
immediate-leave form to restore the default.
Syntax
[no] ip igmp snooping immediate-leave
Default
Disabled
Command Mode
Privileged Exec
Command Usage
The command immediately deletes a member port of a multicast service if a leave
packet is received at that port and immediate-leave is enabled on the port.
Example
Console(config-if)#ip igmp snooping immediate-leave
Console(config-if)
clear ip igmp This command clears multicast group information dynamically learned through
snooping groups IGMP snooping.
dynamic
Syntax
clear ip igmp snooping groups dynamic
Command Mode
Privileged Exec
Command Usage
This command only clears entries learned though IGMP snooping. Statically
configured multicast address are not cleared.
Example
Console#clear ip igmp snooping groups dynamic
Console#
– 664 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Command Mode
Privileged Exec
Example
Console#clear ip igmp snooping statistics
Console#
show ip igmp This command shows the IGMP snooping, proxy, and query configuration settings.
snooping
Syntax
show ip igmp snooping [vlan vlan-id]
vlan-id - VLAN ID (1-4094)
Command Mode
Privileged Exec
Command Usage
This command displays global and VLAN-specific IGMP configuration settings.
Example
The following shows the current IGMP snooping configuration:
– 665 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Querier : Disabled
VLAN 1:
--------
IGMP Snooping : Enabled
IGMP Snooping Running Status : Inactive
Version : Using global Version (2)
Version Exclusive : Using global status (Disabled)
Immediate Leave : Disabled
Last Member Query Interval : 10 (unit: 1/10s)
Last Member Query Count : 2
General Query Suppression : Disabled
Query Interval : 125
Query Response Interval : 100 (unit: 1/10s)
Proxy Query Address : 0.0.0.0
Proxy Reporting : Using global status (Disabled)
Multicast Router Discovery : Disabled
show ip igmp This command shows known multicast group, source, and host port mappings for
snooping group the specified VLAN interface, or for all interfaces if none is specified.
Syntax
show ip igmp snooping group [host-ip-addr [ip-address | interface [ip-
address] | vlan-id [interface [ip-address]] | igmpsnp | sort-by-port [ip-address |
interface [ip-address] | vlan-id [interface [ip-address]] | user | vlan vlan-id
[user | igmpsnp]]
ip-address - IP address for multicast group
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
igmpsnp - Display only entries learned through IGMP snooping.
sort-by-port - Display entries sorted by port.
user - Display only the user-configured multicast entries.
vlan-id - VLAN ID (1-4094)
Default Setting
None
– 666 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Command Mode
Privileged Exec
Command Usage
Member types displayed include IGMP or USER, depending on selected options.
Example
The following shows the multicast entries learned through IGMP snooping for
VLAN 1.
show ip igmp This command displays information on statically configured and dynamically
snooping mrouter learned multicast router ports.
Syntax
show ip igmp snooping mrouter [vlan vlan-id]
vlan-id - VLAN ID (Range: 1-4094)
Default Setting
Displays multicast router ports for all configured VLANs.
Command Mode
Privileged Exec
Command Usage
Multicast router port types displayed include Static or Dynamic.
Example
The following shows the ports in VLAN 1 which are attached to multicast routers.
– 667 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
show ip igmp This command shows IGMP snooping protocol statistics for the specified interface.
snooping statistics
Syntax
show ip igmp snooping statistics
{input [interface interface] |
output [interface interface] |
query [vlan vlan-id]}
input - Specifies to display statistics for messages received by the interface.
output - Specifies to display statistics for messages sent by the interface.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
vlan vlan-id - VLAN ID (Range: 1-4094)
query - Displays IGMP snooping-related statistics.
Default Setting
None
Command Mode
Privileged Exec
Example
The following shows IGMP protocol statistics input:
– 668 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Drop The number of times a report, leave or query was dropped. Packets may
be dropped due to invalid format, rate limiting, or packet content not
allowed.
Join Succ The number of times a multicast group was successfully joined.
Report The number of IGMP membership reports sent from this interface.
G Query The number of general query messages sent from this interface.
Drop The number of times a report, leave or query was dropped. Packets may
be dropped due to invalid format, rate limiting, or packet content not
allowed.
– 669 –
Chapter 25 | Multicast Filtering Commands
IGMP Snooping
Table 128: show ip igmp snooping statistics vlan query - display description
Field Description
Other Querier Expire Time after which remote querier is assumed to have expired.
Self Querier Expire Time after which local querier is assumed to have expired.
General Query Received The number of general queries received on this interface.
General Query Sent The number of general queries sent from this interface.
Specific Query Received The number of specific queries received on this interface.
Specific Query Sent The number of specific queries sent from this interface.
Warn Rate Limit The rate at which received query messages of the wrong version type
cause the Vx warning count to increment. Note that “0 sec” means that
the Vx warning count is incremented for each wrong message version
received.
V1 Warning Count The number of times the query version received (Version 1) does not
match the version configured for this interface.
V2 Warning Count The number of times the query version received (Version 2) does not
match the version configured for this interface.
V3 Warning Count The number of times the query version received (Version 3) does not
match the version configured for this interface.
– 670 –
Chapter 25 | Multicast Filtering Commands
Static Multicast Routing
ip igmp snooping vlan This command statically configures a (Layer 2) multicast router port on the
mrouter specified VLAN. Use the no form to remove the configuration.
Syntax
[no] ip igmp snooping vlan vlan-id mrouter interface
vlan-id - VLAN ID (Range: 1-4094)
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
No static multicast router ports are configured.
Command Mode
Global Configuration
Command Usage
◆ Depending on your network connections, IGMP snooping may not always be
able to locate the IGMP querier. Therefore, if the IGMP querier is a known
multicast router or switch connected over the network to an interface (port or
trunk) on this switch, that interface can be manually configured to join all the
current multicast groups.
◆ IGMP Snooping must be enabled globally on the switch (using the ip igmp
snooping command) before a multicast router port can take effect.
– 671 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
Example
The following shows how to configure port 10 as a multicast router port within VLAN
1.
ip igmp profile Sets a profile number and enters IGMP filter profile GC
configuration mode
ip igmp max-groups action Sets the IGMP throttling action for an interface IC
show ip igmp query-drop Shows if the interface is configured to drop IGMP query PE
packets
show ip igmp throttle Displays the IGMP throttling setting for interfaces PE
interface
– 672 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
ip igmp filter This command globally enables IGMP filtering and throttling on the switch. Use the
(Global Configuration) no form to disable the feature.
Syntax
[no] ip igmp filter
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ IGMP filtering enables you to assign a profile to a switch port that specifies
multicast groups that are permitted or denied on the port. An IGMP filter profile
can contain one or more, or a range of multicast addresses; but only one profile
can be assigned to a port. When enabled, IGMP join reports received on the
port are checked against the filter profile. If a requested multicast group is
permitted, the IGMP join report is forwarded as normal. If a requested multicast
group is denied, the IGMP join report is dropped.
◆ The IGMP filtering feature operates in the same manner when MVR is used to
forward multicast traffic.
Example
Console(config)#ip igmp filter
Console(config)#
ip igmp profile This command creates an IGMP filter profile number and enters IGMP profile
configuration mode. Use the no form to delete a profile number.
Syntax
[no] ip igmp profile profile-number
profile-number - An IGMP filter profile number. (Range: 1-4294967295)
Default Setting
Disabled
Command Mode
Global Configuration
– 673 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
Command Usage
A profile defines the multicast groups that a subscriber is permitted or denied to
join. The same profile can be applied to many interfaces, but only one profile can
be assigned to one interface. Each profile has only one access mode; either permit
or deny.
Example
Console(config)#ip igmp profile 19
Console(config-igmp-profile)#
permit, deny This command sets the access mode for an IGMP filter profile.
Syntax
{permit | deny}
Default Setting
Deny
Command Mode
IGMP Profile Configuration
Command Usage
◆ Each profile has only one access mode; either permit or deny.
◆ When the access mode is set to permit, IGMP join reports are processed when a
multicast group falls within the controlled range. When the access mode is set
to deny, IGMP join reports are only processed when a multicast group is not in
the controlled range.
Example
Console(config)#ip igmp profile 19
Console(config-igmp-profile)#permit
Console(config-igmp-profile)#
range This command specifies multicast group addresses for a profile. Use the no form to
delete addresses from a profile.
Syntax
[no] range low-ip-address high-ip-address
low-ip-address - A valid IP address of a multicast group or start of a group
range.
high-ip-address - A valid IP address for the end of a multicast group range.
– 674 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
Default Setting
None
Command Mode
IGMP Profile Configuration
Command Usage
Enter this command multiple times to specify more than one multicast address or
address range for a profile.
Example
Console(config)#ip igmp profile 19
Console(config-igmp-profile)#range 239.2.3.1 239.2.3.100
Console(config-igmp-profile)#
ip igmp This command enables IGMP authentication on the specified interface. When
authentication enabled and an IGMP JOIN request is received, an authentication request is sent to
a configured RADIUS server. Use the no form to disable IGMP authentication.
Syntax
[no] ip igmp authentication
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ If IGMP authentication is enabled on an interface, and a join report is received
on the interface, the switch will send an access request to the RADIUS server to
perform authentication.
◆ If the RADIUS server responds that authentication failed or the timer expires,
the report will be dropped and the group will not be learned. The entry (host
MAC, port number, VLAN ID, and group IP) will be put in the “authentication
failed list”.
◆ The “authentication failed list” is valid for the period of the interval defined by
the command ip igmp snooping vlan query-interval. When receiving the same
report during this interval, the switch will not send the access request to the
RADIUS server.
– 675 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
◆ If the interface leaves the group and subsequently rejoins the same group, the
join report needs to again be authenticated.
◆ When receiving an IGMP v3 report message, the switch will send the access
request to the RADIUS server only when the record type is either IS_EX or
TO_EX, and the source list is empty. Other types of packets will not initiate
RADIUS authentication.
IS_EX (MODE_IS_EXCLUDE) - Indicates that the interface’s filter mode is
EXCLUDE for the specified multicast address. The Source Address fields in this
Group Record contain the interface's source list for the specified multicast
address, if not empty.
TO_EX (CHANGE_TO_EXCLUDE_MODE) - Indicates that the interface has
changed to EXCLUDE filter mode for the specified multicast address. The
Source Address fields in this Group Record contain the interface's new source
list for the specified multicast address, if not empty.
◆ When a report is received for the first time and is being authenticated, whether
authentication succeeds or fails, the report will still be sent to the multicast-
router port.
◆ The following table shows the RADIUS server Attribute Value Pairs used for
authentication:
Example
This example shows how to enable IGMP Authentication on all of the switch’s
Ethernet interfaces.
Related Commands
show ip igmp authentication
– 676 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
ip igmp filter This command assigns an IGMP filtering profile to an interface on the switch. Use
(Interface Configuration) the no form to remove a profile from an interface.
Syntax
ip igmp filter profile-number
no ip igmp filter
profile-number - An IGMP filter profile number. (Range: 1-4294967295)
Default Setting
None
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ The IGMP filtering profile must first be created with the ip igmp profile
command before being able to assign it to an interface.
◆ A profile can also be assigned to a trunk interface. When ports are configured as
trunk members, the trunk uses the filtering profile assigned to the first port
member in the trunk.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ip igmp filter 19
Console(config-if)#
ip igmp max-groups This command sets the IGMP throttling number for an interface on the switch. Use
the no form to restore the default setting.
Syntax
ip igmp max-groups number
no ip igmp max-groups
number - The maximum number of multicast groups an interface can join at
the same time. (Range: 1-1024)
Default Setting
1024
Command Mode
Interface Configuration (Ethernet, Port Channel)
– 677 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
Command Usage
◆ IGMP throttling sets a maximum number of multicast groups that a port can
join at the same time. When the maximum number of groups is reached on a
port, the switch can take one of two actions; either “deny” or “replace” (see the
ip igmp max-groups action command). If the action is set to deny, any new
IGMP join reports will be dropped. If the action is set to replace, the switch
randomly removes an existing group and replaces it with the new multicast
group.
◆ IGMP throttling can also be set on a trunk interface. When ports are configured
as trunk members, the trunk uses the throttling settings of the first port
member in the trunk.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ip igmp max-groups 10
Console(config-if)#
ip igmp This command sets the IGMP throttling action for an interface on the switch. Use
max-groups action the no form of the command to restore the action to the default value.
Syntax
ip igmp max-groups action {deny | replace}
no ip igmp max-groups action
deny - The new multicast group join report is dropped.
replace - The new multicast group replaces an existing group.
Default Setting
Deny
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
When the maximum number of groups is reached on a port, the switch can take
one of two actions; either “deny” or “replace.” If the action is set to deny, any new
IGMP join reports will be dropped. If the action is set to replace, the switch
randomly removes an existing group and replaces it with the new multicast group.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ip igmp max-groups action replace
Console(config-if)#
– 678 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
ip igmp query-drop This command drops any received IGMP query packets. Use the no form to restore
the default setting.
Syntax
[no] ip igmp query-drop [vlan vlan-id]
vlan-id - VLAN ID (Range: 1-4094)
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
This command can be used to drop any query packets received on the specified
interface. If this switch is acting as a Querier, this prevents it from being affected by
messages received from another Querier.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ip igmp query-drop
Console(config-if)#
ip multicast-data-drop This command drops all multicast data packets. Use the no form to disable this
feature.
Syntax
[no] ip multicast-data-drop
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
This command can be used to stop multicast services from being forwarded to
users attached to the downstream port (i.e., the interfaces specified by this
command).
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ip multicast-data-drop
Console(config-if)#
– 679 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
show ip igmp This command displays the interface settings for IGMP authentication.
authentication
Syntax
show ip igmp authentication interface [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
Command Usage
Using this command without specifying an interface displays information for all
interfaces.
Example
Console#show ip igmp authentication
Ethernet 1/1: Enabled
Ethernet 1/2: Enabled
Ethernet
. 1/3: Enabled
.
.
Ethernet 1/27: Enabled
Ethernet 1/28: Enabled
Other ports/port channels are Disable
Console#
show ip igmp filter This command displays the global and interface settings for IGMP filtering.
Syntax
show ip igmp filter [interface interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
None
– 680 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
Command Mode
Privileged Exec
Example
Console#show ip igmp filter
IGMP Filter enabled
Console#show ip igmp filter interface ethernet 1/1
Ethernet 1/1 information
---------------------------------
IGMP Profile 19
Deny
Range 239.1.1.1 239.1.1.1
Range 239.2.3.1 239.2.3.100
Console#
show ip igmp profile This command displays IGMP filtering profiles created on the switch.
Syntax
show ip igmp profile [profile-number]
profile-number - An existing IGMP filter profile number.
(Range: 1-4294967295)
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show ip igmp profile
IGMP Profile 19
Deny
Range 239.1.1.1 239.1.1.1
Range 239.2.3.1 239.2.3.100
IGMP Profile 50
Deny
Range 239.1.1.1 239.1.1.12
Console#show ip igmp profile 19
IGMP Profile 19
Deny
Range 239.1.1.1 239.1.1.1
Range 239.2.3.1 239.2.3.100
Console#
– 681 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
show ip igmp This command shows if the specified interface is configured to drop IGMP query
query-drop packets.
Syntax
show ip igmp query-drop [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
Command Usage
Using this command without specifying an interface displays the query drop
configuration for all interfaces.
Example
Console#show ip igmp query-drop interface ethernet 1/1
Ethernet 1/1: Enabled
Console#
show ip igmp throttle This command displays the interface settings for IGMP throttling.
interface
Syntax
show ip igmp throttle interface [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
– 682 –
Chapter 25 | Multicast Filtering Commands
IGMP Filtering and Throttling
Command Usage
Using this command without specifying an interface displays information for all
interfaces.
Example
Console#show ip igmp throttle interface ethernet 1/1
Eth 1/1 Information
Status : FALSE
Action : Deny
Max Multicast Groups : 1024
Current Multicast Groups : 0
Console#
show ip This command shows if the specified interface is configured to drop multicast data
multicast-data-drop packets.
Syntax
show ip multicast-data-drop [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
Command Usage
Using this command without specifying an interface displays information for all
interfaces.
Example
Console#show ip multicast-data-drop interface ethernet 1/1
Ethernet 1/1: Enabled
Console#
– 683 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
MLD Snooping
Multicast Listener Discovery (MLD) snooping operates on IPv6 traffic and performs
a similar function to IGMP snooping for IPv4. That is, MLD snooping dynamically
configures switch ports to limit IPv6 multicast traffic so that it is forwarded only to
ports with users that want to receive it. This reduces the flooding of IPv6 multicast
packets in the specified VLANs.
There are two versions of the MLD protocol, version 1 and version 2. MLDv1 control
packets include Listener Query, Listener Report, and Listener Done messages
(equivalent to IGMPv2 query, report, and leave messages). MLDv2 control packets
include MLDv2 query and report messages, as well as MLDv1 report and done
messages.
Remember that IGMP Snooping and MLD Snooping are independent functions,
and can therefore both function at the same time.
ipv6 mld snooping querier Allows the switch to act as the querier for MLD snooping GC
ipv6 mld snooping Configures the interval between sending MLD general GC
query-interval query messages
ipv6 mld snooping query- Configures the maximum response time for a general GC
max-response-time queries
ipv6 mld snooping Specifies how often the upstream interface should GC
unsolicited-report-interval transmit unsolicited MLD snooping reports (when proxy
reporting is enabled)
ipv6 mld snooping vlan Removes a member port of an IPv6 multicast service if a GC
immediate-leave leave packet is received at that port and MLD immediate-
leave is enabled for the parent VLAN
clear ipv6 mld snooping Clears multicast group information dynamically learned PE
groups dynamic through MLD snooping
– 684 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
show ipv6 mld snooping Displays the learned groups and corresponding source list PE
group source-list
show ipv6 mld snooping Displays the information of multicast router ports PE
mrouter
show ipv6 mld snooping Shows IGMP snooping protocol statistics for the specified PE
statistics interface
ipv6 mld snooping This command enables MLD Snooping globally on the switch. Use the no form to
disable MLD Snooping.
Syntax
[no] ipv6 mld snooping
Default Setting
Disabled
Command Mode
Global Configuration
Example
The following example enables MLD Snooping:
ipv6 mld snooping This command enables MLD Snooping with Proxy Reporting. Use the no form to
proxy-reporting restore the default setting.
Syntax
[no] ipv6 mld snooping proxy-reporting
Default Setting
Disabled
Command Mode
Global Configuration
– 685 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
Command Usage
◆ When proxy reporting is enabled with this command, reports received from
downstream hosts are summarized and used to build internal membership
states. Proxy-reporting devices may use the IPv6 address configured on this
VLAN or Source IP address from received report message as source address
when forwarding any summarized reports upstream.
Example
Console(config)#ipv6 mld snooping proxy-reporting
Console(config)#
ipv6 mld snooping This command allows the switch to act as the querier for MLDv2 snooping. Use the
querier no form to disable this feature.
Syntax
[no] ipv6 mld snooping querier
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ If enabled, the switch will serve as querier if elected. The querier is responsible
for asking hosts if they want to receive multicast traffic.
◆ An IPv6 address must be configured on the VLAN interface from which the
querier will act if elected. When serving as the querier, the switch uses its own
IPv6 address as the query source address.
◆ The querier will not start or will disable itself after having started if it detects an
IPv6 multicast router on the network.
Example
Console(config)#ipv6 mld snooping querier
Console(config)#
– 686 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
ipv6 mld snooping This command configures the interval between sending MLD general queries. Use
query-interval the no form to restore the default.
Syntax
ipv6 mld snooping query-interval interval
no ipv6 mld snooping query-interval
interval - The interval between sending MLD general queries.
(Range: 60-125 seconds)
Default Setting
125 seconds
Command Mode
Global Configuration
Command Usage
◆ This command applies when the switch is serving as the querier.
◆ An MLD general query message is sent by the switch at the interval specified by
this command. When this message is received by downstream hosts, all
receivers build an MLD report for the multicast groups they have joined.
Example
Console(config)#ipv6 mld snooping query-interval 150
Console(config)#
ipv6 mld snooping This command configures the maximum response time advertised in MLD general
query-max-response- queries. Use the no form to restore the default.
time
Syntax
ipv6 mld snooping query-max-response-time seconds
no ipv6 mld snooping query-max-response-time
seconds - The maximum response time allowed for MLD general queries.
(Range: 5-25 seconds)
Default Setting
10 seconds
Command Mode
Global Configuration
Command Usage
This command controls how long the host has to respond to an MLD Query
message before the switch deletes the group if it is the last member.
– 687 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
Example
Console(config)#ipv6 mld snooping query-max-response-time 15
Console(config)#
ipv6 mld snooping This command configures the MLD Snooping robustness variable. Use the no form
robustness to restore the default value.
Syntax
ipv6 mld snooping robustness value
no ipv6 mld snooping robustness
value - The number of the robustness variable. (Range: 2-10)
Default Setting
2
Command Mode
Global Configuration
Command Usage
A port will be removed from the receiver list for a multicast service when no MLD
reports are detected in response to a number of MLD queries. The robustness
variable sets the number of queries on ports for which there is no report.
Example
Console(config)#ipv6 mld snooping robustness 2
Console(config)#
ipv6 mld snooping This command configures the MLD query timeout. Use the no form to restore the
router-port- default.
expire-time
Syntax
ipv6 mld snooping router-port-expire-time time
no ipv6 mld snooping router-port-expire-time
time - Specifies the timeout of a dynamically learned router port.
(Range: 300-500 seconds)
Default Setting
300 seconds
Command Mode
Global Configuration
– 688 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
Command Usage
The router port expire time is the time the switch waits after the previous querier
stops before it considers the router port (i.e., the interface that had been receiving
query packets) to have expired.
Example
Console(config)#ipv6 mld snooping router-port-expire-time 300
Console(config)#
ipv6 mld snooping This command sets the action for dealing with unknown multicast packets. Use the
unknown-multicast no form to restore the default.
mode
Syntax
ipv6 mld snooping unknown-multicast mode {flood | to-router-port}
no ipv6 mld snooping unknown-multicast mode
flood - Floods the unknown multicast data packets to all ports.
to-router-port - Forwards the unknown multicast data packets to router
ports.
Default Setting
to-router-port
Command Mode
Global Configuration
Command Usage
◆ When set to “flood,” any received IPv6 multicast packets that have not been
requested by a host are flooded to all ports in the VLAN.
◆ When set to “router-port,” any received IPv6 multicast packets that have not
been requested by a host are forwarded to ports that are connected to a
detected multicast router.
Example
Console(config)#ipv6 mld snooping unknown-multicast mode flood
Console(config)#
– 689 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
ipv6 mld snooping This command specifies how often the upstream interface should transmit
unsolicited-report- unsolicited MLD snooping reports when proxy reporting is enabled. Use the no
interval form to restore the default value.
Syntax
ipv6 mld snooping unsolicited-report-interval seconds
no ipv6 mld snooping unsolicited-report-interval
seconds - The interval at which to issue unsolicited reports.
(Range: 1-65535 seconds)
Default Setting
400 seconds
Command Mode
Global Configuration
Command Usage
◆ When a new upstream interface (that is, uplink port) starts up, the switch sends
unsolicited reports for all currently learned multicast channels out through the
new upstream interface.
Example
Console(config)#ipv6 mld snooping unsolicited-report-interval 5
Console(config)#
ipv6 mld snooping This command configures the MLD snooping version. Use the no form to restore
version the default.
Syntax
ipv6 mld snooping version {1 | 2}
no ipv6 mld snooping version
1 - MLD version 1.
2 - MLD version 2.
Default Setting
Version 2
Command Mode
Global Configuration
– 690 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
Example
Console(config)#ipv6 mld snooping version 1
Console(config)#
ipv6 mld snooping This command immediately deletes a member port of an IPv6 multicast service
vlan immediate-leave when a leave packet is received at that port and immediate-leave is enabled for the
parent VLAN. Use the no form to restore the default.
Syntax
ipv6 mld snooping vlan vlan-id immediate-leave [by-host-ip]
no ipv6 mld snooping vlan vlan-id immediate-leave
vlan-id - VLAN ID (Range: 1-4094)
by-host-ip - Specifies that the member port will be deleted only when
there are no hosts joining this group.
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ If MLD immediate-leave is not used, a multicast router (or querier) will send a
group-specific query message when an MLD group leave message is received.
The router/querier stops forwarding traffic for that group only if no host replies
to the query within the specified timeout period.
◆ If MLD immediate-leave is enabled, the switch assumes that only one host is
connected to the interface. Therefore, immediate leave should only be enabled
on an interface if it is connected to only one MLD-enabled device, either a
service host or a neighbor running MLD snooping.
◆ If the “by-host-ip” option is used, the router/querier will not send out a group-
specific query when an MLD leave message is received, but will check if there
are other hosts joining the multicast group. Only when all hosts on that port
leave the group will the member port be deleted.
Example
The following shows how to enable MLD immediate leave.
– 691 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
ipv6 mld snooping This command statically configures an IPv6 multicast router port. Use the no form
vlan mrouter to remove the configuration.
Syntax
[no] ipv6 mld snooping vlan vlan-id mrouter interface
vlan-id - VLAN ID (Range: 1-4094)
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
No static multicast router ports are configured.
Command Mode
Global Configuration
Command Usage
Depending on your network connections, MLD snooping may not always be able
to locate the MLD querier. Therefore, if the MLD querier is a known multicast router/
switch connected over the network to an interface (port or trunk) on the switch,
you can manually configure that interface to join all the current multicast groups.
Example
The following shows how to configure port 1 as a multicast router port within VLAN
1:
– 692 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
ipv6 mld snooping This command adds a port to an IPv6 multicast group. Use the no form to remove
vlan static the port.
Syntax
[no] ipv6 mld snooping vlan vlan-id static ipv6-address interface
vlan - VLAN ID (Range: 1-4094)
ipv6-address - An IPv6 address of a multicast group. (Format: X:X:X:X::X)
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
None
Command Mode
Global Configuration
Example
Console(config)#ipv6 mld snooping vlan 1 static ff05:0:1:2:3:4:5:6 ethernet
1/6
Console(config)#
clear ipv6 mld This command clears multicast group information dynamically learned through
snooping groups MLD snooping.
dynamic
Syntax
clear ipv6 mld snooping groups dynamic
Command Mode
Privileged Exec
Command Usage
This command only clears entries learned though MLD snooping. Statically
configured multicast address are not cleared.
Example
Console#clear ipv6 mld snooping groups dynamic
Console#
– 693 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
Command Mode
Privileged Exec
Example
Console#clear ipv6 mld snooping statistics
Console#
show ipv6 This command shows the current global MLD Snooping configuration and can be
mld snooping used with the vlan keyword to show the VLAN specific configuration.
Syntax
show ipv6 mld snooping [vlan [vlan-id]]
vlan vlan-id - VLAN ID (1-4094)
Command Mode
Privileged Exec
Command Usage
This command displays global and VLAN-specific MLD snooping configuration
settings.
Example
The following shows MLD Snooping configuration information using the global
form of the command first and then the command is executed with keyword vlan
to show specific VLAN MLD configuration.
– 694 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
show ipv6 mld This command shows known multicast groups, member ports, and the means by
snooping group which each group was learned.
Syntax
show ipv6 mld snooping group [mld-group | host-ip-addr | sort-by-port |
vlan vlan-id]
mld-group - X:X:X:X::X show only the groups by the specified IPv6
address
host-ip-addr - Displays the ip address of the subscribers of each group.
sort-by-port - Displays groups sorted by port number.
vlan vlan-id - VLAN ID (1-4094), displays the groups of the specified
VLAN.
Command Mode
Privileged Exec
Example
The following shows MLD Snooping group configuration information:
Console#
– 695 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
show ipv6 mld This command shows known multicast groups, member ports, the means by which
snooping group each group was learned, and the corresponding source list.
source-list
Syntax
show ipv6 mld snooping group source-list [ipv6-address | vlan vlan-id]
ipv6-address - An IPv6 address of a multicast group. (Format: X:X:X:X::X)
vlan-id - VLAN ID (1-4094)
Command Mode
Privileged Exec
Example
The following shows MLD Snooping group mapping information:
VLAN ID : 1
Mutlicast IPv6 Address : FF02::01:01:01:01
Member Port : Eth 1/1
MLD Snooping : Multicast Data
Filter Mode : Include
(if exclude filter mode)
Filter Timer Elapse : 10 sec.
Request List : ::01:02:03:04, ::01:02:03:05, ::01:02:03:06,
::01:02:03:07
Exclude List : ::02:02:03:04, ::02:02:03:05, ::02:02:03:06,
::02:02:03:07
(if include filter mode)
Include List : ::02:02:03:04, ::02:02:03:05, ::02:02:03:06,
::02:02:03:06
Option:
Filter Mode: Include, Exclude
Console#
show ipv6 mld This command shows MLD Snooping multicast router information.
snooping mrouter
Syntax
show ipv6 mld snooping mrouter [vlan vlan-id}
vlan-id - A VLAN identification number. (Range: 1-4094)
Command Mode
Privileged Exec
– 696 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
Example
Console#show ipv6 mld snooping mrouter vlan 1
VLAN Multicast Router Port Type Expire
---- --------------------- --------- ------
1 Eth 1/ 2 Static
Console#
show ipv6 mld This command shows MLD snooping protocol statistics for the specified interface.
snooping statistics
Syntax
show ipv6 mld snooping statistics
{input [interface interface] |
output [interface interface] |
query [vlan vlan-id] |
summary interface interface}
input - Specifies to display statistics for messages received by the interface.
output - Specifies to display statistics for messages sent by the interface.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
vlan vlan-id - VLAN ID (Range: 1-4094)
query - Displays MLD snooping query-related statistics.
Default Setting
None
Command Mode
Privileged Exec
Example
The following shows MLD snooping input-related message statistics:
– 697 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
Table 133: show ipv6 MLD snooping statistics input - display description
Field Description
Drop The number of times a report, leave or query was dropped. Packets may
be dropped due to invalid format, rate limiting, packet content not
allowed, or MLD group report received.
Join Succ The number of times a multicast group was successfully joined.
Console#
Table 134: show ipv6 MLD snooping statistics output - display description
Field Description
G Query The number of general query messages transmitted from this interface.
Drop The number of times a report, leave or query was dropped. Packets may
be dropped due to invalid format, rate limiting, packet content not
allowed, or MLD group report received.
Join Succ The number of times a multicast group was successfully joined.
– 698 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
Table 135: show ipv6 MLD snooping statistics query - display description
Field Description
Other Querier Expire Time after which remote querier is assumed to have expired.
Self Querier Expire Time after which local querier is assumed to have expired.
General Query Received The number of general queries received on this interface.
General Query Sent The number of general queries sent from this interface.
Specific Query Received The number of group specific queries received on this interface.
Specific Query Sent The number of group specific queries sent from this interface.
– 699 –
Chapter 25 | Multicast Filtering Commands
MLD Snooping
Filter Drop : 0
Source Port Drop: 0
Others Drop : 0
Console#
Table 136: show ipv6 MLD snooping statistics summary - display description
Field Description
Number of Groups Number of active MLD groups active on the specified interface.
Querier:
Transmit
General The number of general queries sent from this interface.
Group Specific The number of group specific queries sent from this interface.
Recieved
General The number of general queries received on this interface.
Group Specific The number of group specific queries received on this interface.
Transmit
Report The number of MLD membership reports sent from this interface.
Leave The number of leave messages sent from this interface.
Recieved
Report The number of MLD membership reports received on this interface.
Leave The number of leave messages received on this interface.
join Success The number of times a multicast group was successfully joined.
Filter Drop The number of messages dropped by an MLD filtering profile.
Source Port Drop The number of dropped messages that are received on MVR source
port or mrouter port.
Others Drop The number of received invalid messages.
Logical Interface (VLAN) The following additional parameters are included for a VLAN interface
Querier:
Other Expire Time after which remote querier is assumed to have expired.
Self Expire Time after which local querier is assumed to have expired.
– 700 –
Chapter 25 | Multicast Filtering Commands
MLD Filtering and Throttling
Table 136: show ipv6 MLD snooping statistics summary - display description
Field Description
Host Addr The link-local or global IPv6 address that is assigned on that VLAN.
Unsolicit Expire The number of group leaves resulting from timeouts instead of explicit
leave messages.
ipv6 mld filter Enables MLD filtering and throttling on the switch GC
ipv6 mld profile Sets a profile number and enters MLD filter profile GC
configuration mode
ipv6 mld max-groups Sets the MLD throttling action for an interface IC
action
show ipv6 mld query-drop Shows if the interface is configured to drop MLD query PE
packets
show ipv6 mld throttle Displays the MLD throttling setting for interfaces PE
interface
– 701 –
Chapter 25 | Multicast Filtering Commands
MLD Filtering and Throttling
ipv6 mld filter This command globally enables MLD filtering and throttling on the switch. Use the
(Global Configuration) no form to disable the feature.
Syntax
[no] ipv6 mld filter
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ MLD filtering enables you to assign a profile to a switch port that specifies
multicast groups that are permitted or denied on the port. An MLD filter profile
can contain one or more, or a range of multicast addresses; but only one profile
can be assigned to a port. When enabled, MLD join reports received on the port
are checked against the filter profile. If a requested multicast group is
permitted, the MLD join report is forwarded as normal. If a requested multicast
group is denied, the MLD join report is dropped.
◆ The MLD filtering feature operates in the same manner when MVR6 is used to
forward multicast traffic.
Example
Console(config)#ipv6 mld filter
Console(config)#
Related Commands
show ipv6 mld filter
ipv6 mld profile This command creates an MLD filter profile number and enters MLD profile
configuration mode. Use the no form to delete a profile number.
Syntax
[no] ipv6 mld profile profile-number
profile-number - An MLD filter profile number. (Range: 1-4294967295)
Default Setting
Disabled
– 702 –
Chapter 25 | Multicast Filtering Commands
MLD Filtering and Throttling
Command Mode
Global Configuration
Command Usage
A profile defines the multicast groups that a subscriber is permitted or denied to
join. The same profile can be applied to many interfaces, but only one profile can
be assigned to one interface. Each profile has only one access mode; either permit
or deny.
Example
Console(config)#ipv6 mld profile 19
Console(config-mld-profile)#
Related Commands
show ipv6 mld profile
permit, deny This command sets the access mode for an MLD filter profile.
Syntax
{permit | deny}
Default Setting
deny
Command Mode
MLD Profile Configuration
Command Usage
◆ Each profile has only one access mode; either permit or deny.
◆ When the access mode is set to permit, MLD join reports are processed when a
multicast group falls within the controlled range. When the access mode is set
to deny, MLD join reports are only processed when a multicast group is not in
the controlled range.
Example
Console(config)#ipv6 mld profile 19
Console(config-mld-profile)#permit
Console(config-mld-profile)#
range This command specifies multicast group addresses for a profile. Use the no form to
delete addresses from a profile.
– 703 –
Chapter 25 | Multicast Filtering Commands
MLD Filtering and Throttling
Syntax
[no] range low-ipv6-address high-ipv6-address
low-ipv6-address - A valid IPv6 address (X:X:X:X::X) of a multicast group or
start of a group range.
high-ipv6-address - A valid IPv6 address (X:X:X:X::X) for the end of a
multicast group range.
Default Setting
None
Command Mode
MLD Profile Configuration
Command Usage
Enter this command multiple times to specify more than one multicast address or
address range for a profile.
Example
Console(config-mld-profile)#range ff01::0101 ff01::0202
Console(config-mld-profile)#
ipv6 mld filter This command assigns an MLD filtering profile to an interface on the switch. Use
(Interface Configuration) the no form to remove a profile from an interface.
Syntax
ipv6 mld filter profile-number
no ipv6 mld filter
profile-number - An MLD filter profile number. (Range: 1-4294967295)
Default Setting
None
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ The MLD filtering profile must first be created with the ipv6 mld profile
command before being able to assign it to an interface.
◆ A profile can also be assigned to a trunk interface. When ports are configured as
trunk members, the trunk uses the filtering profile assigned to the first port
member in the trunk.
– 704 –
Chapter 25 | Multicast Filtering Commands
MLD Filtering and Throttling
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ipv6 mld filter 19
Console(config-if)#
ipv6 mld max-groups This command configures the maximum number of MLD groups that an interface
can join. Use the no form to restore the default setting.
Syntax
ipv6 mld max-groups number
no ipv6 mld max-groups
number - The maximum number of multicast groups an interface can join at
the same time. (Range: 1-255)
Default Setting
255
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ MLD throttling sets a maximum number of multicast groups that a port can join
at the same time. When the maximum number of groups is reached on a port,
the switch can take one of two actions; either “deny” or “replace.” If the action is
set to deny, any new MLD join reports will be dropped. If the action is set to
replace, the switch randomly removes an existing group and replaces it with
the new multicast group.
◆ MLD throttling can also be set on a trunk interface. When ports are configured
as trunk members, the trunk uses the throttling settings of the first port
member in the trunk.
◆ If the maximum number of MLD groups is set to the default value, the running
status of MLD throttling will change to false. This means that any configuration
for MLD throttling will have no effect until the maximum number of MLD
groups is configured to another value.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ipv6 mld max-groups 10
Console(config-if)#
– 705 –
Chapter 25 | Multicast Filtering Commands
MLD Filtering and Throttling
ipv6 mld max-groups This command sets the MLD throttling action for an interface on the switch. Use the
action no form of the command to set the action to the default.
Syntax
ipv6 mld max-groups action {deny | replace}
no ipv6 mld max-groups action
deny - The new multicast group join report is dropped.
replace - The new multicast group replaces an existing group.
Default Setting
Deny
Command Mode
Interface Configuration (Ethernet)
Command Usage
When the maximum number of groups is reached on a port, the switch can take
one of two actions; either “deny” or “replace.” If the action is set to deny, any new
MLD join reports will be dropped. If the action is set to replace, the switch randomly
removes an existing group and replaces it with the new multicast group.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ipv6 mld max-groups action replace
Console(config-if)#
ipv6 mld query-drop This command drops any received MLD query packets. Use the no form to restore
the default setting.
Syntax
[no] ipv6 mld query-drop
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
This command can be used to drop any query packets received on the specified
interface. If this switch is acting as a Querier, this prevents it from being affected by
messages received from another Querier.
– 706 –
Chapter 25 | Multicast Filtering Commands
MLD Filtering and Throttling
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ipv6 mld query-drop
Console(config-if)#
ipv6 Use this command to enable multicast data drop mode on a port interface. Use the
multicast-data-drop no form of the command to disable multicast data drop.
Syntax
[no] ipv6 multicast-data-drop
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet)
Example
Console(config)#interface ethernet 1/3
Console(config-if)#ipv6 multicast-data-drop
Console(config-if)#
show ipv6 mld filter This command displays the global and interface settings for MLD filtering.
Syntax
show ipv6 mld filter [interface interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show ipv6 mld filter
MLD filter Enabled
Console#show ipv6 mld filter interface ethernet 1/3
– 707 –
Chapter 25 | Multicast Filtering Commands
MLD Filtering and Throttling
show ipv6 mld profile This command displays MLD filtering profiles created on the switch.
Syntax
show ipv6 mld profile [profile-number]
profile-number - An existing MLD filter profile number.
(Range: 1-4294967295)
Default Setting
None
Command Mode
Privileged Exec
Example
Console#show ipv6 mld profile
MLD Profile 19
MLD Profile 50
Console#show ipv6 mld profile 19
MLD Profile 19
Deny
Range ff01::101 ff01::faa
Console#
show ipv6 mld This command shows if the specified interface is configured to drop MLD query
query-drop packets.
Syntax
show ipv6 mld query-drop [interface interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
None
– 708 –
Chapter 25 | Multicast Filtering Commands
MLD Filtering and Throttling
Command Mode
Privileged Exec
Command Usage
Using this command without specifying an interface displays all interfaces.
Example
Console#show ipv6 mld query-drop interface ethernet 1/1
Ethernet 1/1: Enabled
Console#
show ipv6 mld throttle This command displays the interface settings for MLD throttling.
interface
Syntax
show ipv6 mld throttle interface [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
Command Usage
Using this command without specifying an interface displays information for all
interfaces.
Example
Console#show ipv6 mld throttle interface ethernet 1/3
Eth 1/3 Information
Status : TRUE
Action : Replace
Max Multicast Groups : 10
Current Multicast Groups : 0
Console#
– 709 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
mvr proxy-query-interval Configures the interval at which the receiver port sends out GC
general queries.
mvr proxy-switching Enables MVR proxy switching, where the source port acts GC
as a host, and the receiver port acts as an MVR router with
querier service enabled
mvr robustness-value Configures the expected packet loss, and thereby the GC
number of times to generate report and group-specific
queries
mvr vlan Specifies the VLAN through which MVR multicast data is GC
received
clear mvr groups dynamic Clears multicast group information dynamically learned PE
through MVR
show mvr interface Shows MVR settings for interfaces attached to the MVR PE
VLAN
– 710 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
show mvr members Shows information about the current number of entries in PE
the forwarding database, or detailed information about a
specific multicast address
show mvr statistics Shows MVR protocol statistics for the specified interface PE
mvr This command enables Multicast VLAN Registration (MVR) globally on the switch.
Use the no form of this command to globally disable MVR.
Syntax
[no] mvr
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
Only IGMP version 2 or 3 hosts can issue multicast join or leave messages. If MVR
must be configured for an IGMP version 1 host, the multicast groups must be
statically assigned using the mvr vlan group command.
Example
The following example enables MVR globally.
Console(config)#mvr
Console(config)#
mvr associated-profile This command binds the MVR group addresses specified in a profile to an MVR
domain. Use the no form of this command to remove the binding.
Syntax
[no] mvr domain domain-id associated-profile profile-name
domain-id - An independent multicast domain. (Range: 1-5)
profile-name - The name of a profile containing one or more MVR group
addresses. (Range: 1-21 characters)
Default Setting
Disabled
– 711 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
Command Mode
Global Configuration
Example
The following an MVR group address profile to domain 1:
Related Commands
mvr profile (712)
mvr domain This command enables Multicast VLAN Registration (MVR) for a specific domain.
Use the no form of this command to disable MVR for a domain.
Syntax
[no] mvr domain domain-id
domain-id - An independent multicast domain. (Range: 1-5)
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
Only IGMP version 2 or 3 hosts can issue multicast join or leave messages. If MVR
must be configured for an IGMP version 1 host, the multicast groups must be
statically assigned using the mvr vlan group command.
Example
The following example enables MVR for domain 1:
Console(config)#mvr domain 1
Console(config)#
mvr profile This command maps a range of MVR group addresses to a profile. Use the no form
of this command to remove the profile.
Syntax
mvr profile profile-name start-ip-address end-ip-address
no mvr profile profile-name
– 712 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
Default Setting
No profiles are defined
Command Mode
Global Configuration
Command Usage
◆ Use this command to statically configure all multicast group addresses that will
join the MVR VLAN. Any multicast data associated an MVR group is sent from all
source ports to all receiver ports that have registered to receive data from that
multicast group.
◆ IGMP snooping and MVR share a maximum number of 1024 groups. Any
multicast streams received in excess of this limitation will be flooded to all ports
in the associated domain.
Example
The following example maps a range of MVR group addresses to a profile:
mvr proxy-query- This command configures the interval at which the receiver port sends out general
interval queries. Use the no form to restore the default setting.
Syntax
mvr proxy-query-interval interval
no mvr proxy-query-interval
interval - The interval at which the receiver port sends out general queries.
(Range: 2-31744 seconds)
Default Setting
125 seconds
– 713 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
Command Mode
Global Configuration
Command Usage
This command sets the general query interval at which active receiver ports send
out general queries. This interval is only effective when proxy switching is enabled
with the mvr proxy-switching command.
Example
This example sets the proxy query interval for MVR proxy switching.
mvr proxy-switching This command enables MVR proxy switching, where the source port acts as a host,
and the receiver port acts as an MVR router with querier service enabled. Use the
no form to disable this function.
Syntax
[no] mvr proxy-switching
Default Setting
Enabled
Command Mode
Global Configuration
Command Usage
◆ When MVR proxy-switching is enabled, an MVR source port serves as the
upstream or host interface. The source port performs only the host portion of
MVR by sending summarized membership reports, and automatically disables
MVR router functions.
◆ When the source port receives report and leave messages, it only forwards
them to other source ports.
◆ When receiver ports receive any query messages, they are dropped.
◆ When changes occurring in the downstream MVR groups are learned by the
receiver ports through report and leave messages, an MVR state change report
is created and sent to the upstream source port, which in turn forwards this
information upstream.
– 714 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
Example
The following example enable MVR proxy switching.
Console(config)#mvr proxy-switching
Console(config)#
Related Commands
mvr robustness-value (715)
mvr robustness-value This command configures the expected packet loss, and thereby the number of
times to generate report and group-specific queries. Use the no form to restore the
default setting.
Syntax
mvr robustness-value value
no mvr robustness-value
value - The robustness used for all interfaces. (Range: 1-255)
Default Setting
2
Command Mode
Global Configuration
Command Usage
◆ This command is used to set the number of times report messages are sent
upstream when changes are learned about downstream groups, and the
number of times group-specific queries are sent to downstream receiver ports.
◆ This command only takes effect when MVR proxy switching is enabled.
Example
Console(config)#mvr robustness-value 5
Console(config)#
– 715 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
Related Commands
mvr proxy-switching (714)
mvr source-port- This command configures the switch to forward only multicast streams that a
mode source port has dynamically joined or to forward all multicast groups. Use the no
form to restore the default setting.
Syntax
mvr source-port-mode {dynamic | forward}
no mvr source-port-mode
dynamic - Configures source ports to only forward dynamically-joined
MVR group multicast streams.
forward - Configures source ports to always forward MVR groups.
Default Setting
Forwards all multicast streams which have been specified in a profile and bound to
a domain.
Command Mode
Global Configuration
Command Usage
◆ By default, the switch forwards any multicast streams within the address range
set by a profile, and bound to a domain. The multicast streams are sent to all
source ports on the switch and to all receiver ports that have elected to receive
data on that multicast address.
◆ When the mvr source-port-mode dynamic command is used, the switch only
forwards multicast streams which the source port has dynamically joined. In
other words, both the receiver port and source port must subscribe to a
multicast group before a multicast stream is forwarded to any attached client.
Note that the requested streams are still restricted to the address range which
has been specified in a profile and bound to a domain.
Example
Console(config)#mvr source-port-mode dynamic
Console(config)#
– 716 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
mvr upstream- This command configures the source IP address assigned to all MVR control packets
source-ip sent upstream on all domains or on a specified domain. Use the no form to restore
the default setting.
Syntax
mvr [domain domain-id] upstream-source-ip source-ip-address
no mvr [domain domain-id] upstream-source-ip
domain-id - An independent multicast domain. (Range: 1-5)
source-ip-address – The source IPv4 address assigned to all MVR control
packets sent upstream.
Default Setting
All MVR reports sent upstream use a null source IP address
Command Mode
Global Configuration
Example
Console(config)#mvr domain 1 upstream-source-ip 192.168.0.3
Console(config)#
mvr vlan This command specifies the VLAN through which MVR multicast data is received.
Use the no form of this command to restore the default MVR VLAN.
Syntax
mvr [domain domain-id] vlan vlan-id
no mvr [domain domain-id] vlan
domain-id - An independent multicast domain. (Range: 1-5)
vlan-id - Specifies the VLAN through which MVR multicast data is received.
This is also the VLAN to which all source ports must be assigned.
(Range: 1-4094)
Default Setting
VLAN 1
Command Mode
Global Configuration
Command Usage
◆ This command specifies the VLAN through which MVR multicast data is
received. This is the VLAN to which all source ports must be assigned.
– 717 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
◆ MVR source ports can be configured as members of the MVR VLAN using the
switchport allowed vlan command and switchport native vlan command, but
MVR receiver ports should not be statically configured as members of this
VLAN.
Example
The following example sets the MVR VLAN to VLAN 2:
Console(config)#mvr
Console(config)#mvr domain 1 vlan 2
Console(config)#
mvr immediate-leave This command causes the switch to immediately remove an interface from a
multicast stream as soon as it receives a leave message for that group. Use the no
form to restore the default settings.
Syntax
mvr [domain domain-id] immediate-leave [by-host-ip]
no mvr [domain domain-id] immediate-leave
domain-id - An independent multicast domain. (Range: 1-5)
by-host-ip - Specifies that the member port will be deleted only when
there are no hosts joining this group.
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ Immediate leave applies only to receiver ports. When enabled, the receiver port
is immediately removed from the multicast group identified in the leave
message. When immediate leave is disabled, the switch follows the standard
rules by sending a group-specific query to the receiver port and waiting for a
response to determine if there are any remaining subscribers for that multicast
group before removing the port from the group list.
◆ If the “by-host-ip” option is used, the router/querier will not send out a group-
specific query when an IGMPv2/v3 leave message is received (the same as it
would without this option having been used). Instead of immediately deleting
that group, it will look up the record, and only delete the group if there are no
other subscribers for it on the member port. Only when all hosts on that port
leave the group will the member port be deleted.
– 718 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
◆ Using immediate leave can speed up leave latency, but should only be enabled
on a port attached to only one multicast subscriber to avoid disrupting services
to other group members attached to the same interface.
◆ Immediate leave does not apply to multicast groups which have been statically
assigned to a port with the mvr vlan group command.
Example
The following enables immediate leave on a receiver port.
mvr type This command configures an interface as an MVR receiver or source port. Use the
no form to restore the default settings.
Syntax
[no] mvr [domain domain-id] type {receiver | source}
domain-id - An independent multicast domain. (Range: 1-5)
receiver - Configures the interface as a subscriber port that can receive
multicast data.
source - Configures the interface as an uplink port that can send and
receive multicast data for the configured multicast groups.
Default Setting
The port type is not defined.
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ A port which is not configured as an MVR receiver or source port can use IGMP
snooping to join or leave multicast groups using the standard rules for
multicast filtering.
◆ Receiver ports can belong to different VLANs, but should not normally be
configured as a member of the MVR VLAN. IGMP snooping can also be used to
allow a receiver port to dynamically join or leave multicast groups not sourced
through the MVR VLAN. Also, note that VLAN membership for MVR receiver
ports cannot be set to access mode (see the switchport mode command).
◆ One or more interfaces may be configured as MVR source ports. A source port is
able to both receive and send data for multicast groups which it has joined
through the MVR protocol or which have been assigned through the mvr vlan
group command.
– 719 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
◆ Only IGMP version 2 or 3 hosts can issue multicast join or leave messages. If
MVR must be configured for an IGMP version 1 host, the multicast groups must
be statically assigned using the mvr vlan group command.
Example
The following configures one source port and several receiver ports on the switch.
mvr vlan group This command statically binds a multicast group to a port which will receive long-
term multicast streams associated with a stable set of hosts. Use the no form to
restore the default settings.
Syntax
[no] mvr [domain domain-id] vlan vlan-id group ip-address
domain-id - An independent multicast domain. (Range: 1-5)
vlan-id - Receiver VLAN to which the specified multicast traffic is flooded.
(Range: 1-4094)
group - Defines a multicast service sent to the selected port.
ip-address - Statically configures an interface to receive multicast traffic
from the IPv4 address specified for an MVR multicast group.
(Range: 224.0.1.0 - 239.255.255.255)
Default Setting
No receiver port is a member of any configured multicast group.
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ Multicast groups can be statically assigned to a receiver port using this
command.
– 720 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
◆ Only IGMP version 2 or 3 hosts can issue multicast join or leave messages. If
MVR must be configured for an IGMP version 1 host, the multicast groups must
be statically assigned using the mvr vlan group command.
◆ The MVR VLAN cannot be specified as the receiver VLAN for static bindings.
Example
The following statically assigns a multicast group to a receiver port:
clear mvr groups This command clears multicast group information dynamically learned through
dynamic MVR.
Syntax
clear mvr groups dynamic [domain-id]
domain-id - The MVR domain ID - Range: 1-5
Command Mode
Privileged Exec
Command Usage
This command only clears entries learned though MVR. Statically configured
multicast address are not cleared.
Example
Console#clear mvr groups dynamic
Console#
Syntax
clear mvr statistics [interface interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
– 721 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
Command Mode
Privileged Exec
Example
Console#clear mvr statistics
Console#
show mvr This command shows information about MVR domain settings, including MVR
operational status, the multicast VLAN, the current number of group addresses, and
the upstream source IP address.
Syntax
show mvr [domain domain-id]
domain-id - An independent multicast domain. (Range: 1-5)
Default Setting
Displays configuration settings for all MVR domains.
Command Mode
Privileged Exec
Example
The following shows the MVR settings:
Console#show mvr
MVR Proxy Switching : Enabled
MVR Robustness Value : 1
MVR Proxy Query Interval : 125(sec.)
MVR Source Port Mode : Always Forward
MVR Domain : 1
MVR Config Status : Enabled
MVR Running Status : Active
MVR Multicast VLAN : 1
MVR Current Learned Groups : 10
. MVR Upstream Source IP : 192.168.0.3
.
.
MVR Robustness Value Shows the number of reports or query messages sent when proxy
switching is enabled
– 722 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
MVR Proxy Query Interval Shows the interval at which the receiver port sends out general queries
MVR Source Port Mode Shows if the switch forwards all multicast streams, or only those which
the source port has dynamically joined
MVR Running Status Indicates whether or not all necessary conditions in the MVR
environment are satisfied. (Running status is true as long as MVR Status
is enabled, and the specified MVR VLAN exists.)
MVR Multicast VLAN Shows the VLAN used to transport all MVR multicast traffic.
MVR Upstream Source IP The source IP address assigned to all upstream control packets.
show mvr This command shows the profiles bound the specified domain.
associated-profile
Syntax
show mvr [domain domain-id] associated-profile
domain-id - An independent multicast domain. (Range: 1-5)
Default Setting
Displays profiles bound to all MVR domains.
Command Mode
Privileged Exec
Example
The following displays the profiles bound to domain 1:
– 723 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
show mvr interface This command shows MVR configuration settings for interfaces attached to the
MVR VLAN.
Syntax
show mvr [domain domain-id] interface
domain-id - An independent multicast domain. (Range: 1-5)
Default Setting
Displays configuration settings for all attached interfaces.
Command Mode
Privileged Exec
Example
The following displays information about the interfaces attached to the MVR VLAN
in domain 1:
Status Shows the MVR status and interface status. MVR status for source ports
is “ACTIVE” if MVR is globally enabled on the switch. MVR status for
receiver ports is “ACTIVE” only if there are subscribers receiving
multicast traffic from one of the MVR groups, or a multicast group has
been statically assigned to an interface. Also shows if MVR traffic is
being forwarded or discarded.
Static Group Address Shows any static MVR group assigned to an interface, and the receiver
VLAN.
– 724 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
show mvr members This command shows information about the current number of entries in the
forwarding database, detailed information about a specific multicast address, the IP
address of the hosts subscribing to all active multicast groups, or the multicast
groups associated with each port.
Syntax
show mvr [domain domain-id] members [ip-address |
host-ip-address [ip-address | ds-vlan vlan-id [ip-address | interface ip-address]
| interface ip-address ] | igmp | sort-by-port [ip-address | ds-vlan vlan-id [ip-
address | interface ip-address] | interface ip-address ]| unknown | user]
domain-id - An independent multicast domain. (Range: 1-5)
ip-address - IPv4 address for an MVR multicast group.
(Range: 224.0.1.0 - 239.255.255.255)
members - The multicast groups assigned to the MVR VLAN.
host-ip-address - The subscriber IP addresses.
ds-vlan - Downstream VLAN ID (Range: 1-4094)
igmp - Entry created by IGMP protocol.
sort-by-port - The multicast groups associated with an interface.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
unknown - Entry created by receiving a multicast stream.
user - Snooping entry learned from user’s configuration settings.
Default Setting
Displays configuration settings for all domains and all forwarding entries.
Command Mode
Privileged Exec
Example
The following shows information about the number of multicast forwarding entries
currently active in domain 1:
– 725 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
Console#
Console#
Count The number of times this address has been learned by IGMP snooping.
– 726 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
show mvr profile This command shows all configured MVR profiles.
Command Mode
Privileged Exec
Example
The following shows all configured MVR profiles:
show mvr statistics This command shows MVR protocol-related statistics for the specified interface.
Syntax
show mvr [domain domain-id] statistics
{input [interface interface] | output [interface interface] |
query | summary interface [interface | mvr-vlan]]}
input - Specifies to display statistics for messages received by the interface.
output - Specifies to display statistics for messages sent by the interface.
domain-id - An independent multicast domain. (Range: 1-5)
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
vlan vlan-id - VLAN ID (Range: 1-4094)
query - Displays MVR query-related statistics.
summary - Displays summary of MVR statistics.
mvr vlan - Displays summary statistics for the MVR VLAN.
Default Setting
Displays statistics for all domains.
Command Mode
Privileged Exec
– 727 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
Example
The following shows MVR protocol-related statistics received:
Drop The number of times a report, leave or query was dropped. Packets may
be dropped due to invalid format, rate limiting, packet content not
allowed, or MVR group report received
Join Succ The number of times a multicast group was successfully joined.
Report The number of IGMP membership reports sent from this interface.
– 728 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
G Query The number of general query messages sent from this interface.
Drop The number of times a report, leave or query was dropped. Packets may
be dropped due to invalid format, rate limiting, or packet content not
allowed.
Other Querier Expire The time after which this querier is assumed to have expired.
General Query Received The number of general queries received on this interface.
General Query Sent The number of general queries sent from this interface.
Specific Query Received The number of specific queries received on this interface.
Specific Query Sent The number of specific queries sent from this interface.
– 729 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
Warn Rate Limit Count down from 15 seconds after receiving a Query different from the
configured version.
V# Warning Count Number of queries received on MVR that were configured for IGMP
version 1, 2 or 3.
Field Description
Querier
Transmit
Received
V# Warning Count Number of queries received on MVR that were configured for IGMP
version 1, 2 or 3.
Transmit
Received
– 730 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
Field Description
Source Port Drop Number of report/leave messages dropped by MVR source port.
The following shows MVR summary statistics for the MVR VLAN:
Table 146: show mvr statistics summary interface mvr vlan - description
Field Description
Querier
Transmit
– 731 –
Chapter 25 | Multicast Filtering Commands
MVR for IPv4
Table 146: show mvr statistics summary interface mvr vlan - description
Field Description
Group Specific Number of group specific queries sent from receiver port.
Received
V# Warning Count Number of queries received on MVR that were configured by IGMP
version 1, 2 or 3.
Host IP Addr Source IP address used to send report/leave messages from source
port.
Unsolicit Expire Expiration time for unsolicit reports sent out from source port
Transmit
Received
Source Port Drop Number of report/leave messages dropped by MVR source port.
– 732 –
26 LLDP Commands
Link Layer Discovery Protocol (LLDP) is used to discover basic information about
neighboring devices on the local broadcast domain. LLDP is a Layer 2 protocol that
uses periodic broadcasts to advertise information about the sending device.
Advertised information is represented in Type Length Value (TLV) format according
to the IEEE 802.1AB standard, and can include details such as device identification,
capabilities and configuration settings. LLDP also defines how to store and
maintain information gathered about the neighboring network nodes it discovers.
– 733 –
Chapter 26 | LLDP Commands
show lldp config Shows LLDP configuration settings for all ports PE
show lldp info statistics Shows statistical counters for all LLDP-enabled PE
interfaces
– 734 –
Chapter 26 | LLDP Commands
lldp This command enables LLDP globally on the switch. Use the no form to disable
LLDP.
Syntax
[no] lldp
Default Setting
Enabled
Command Mode
Global Configuration
Example
Console(config)#lldp
Console(config)#
lldp This command configures the time-to-live (TTL) value sent in LLDP advertisements.
holdtime-multiplier Use the no form to restore the default setting.
Syntax
lldp holdtime-multiplier value
no lldp holdtime-multiplier
value - Calculates the TTL in seconds based on the following rule:
minimum of ((Transmission Interval * Holdtime Multiplier), or65536)
(Range: 2 - 10)
Default Setting
Holdtime multiplier: 4
TTL: 4*30 = 120 seconds
Command Mode
Global Configuration
Command Usage
◆ The time-to-live tells the receiving LLDP agent how long to retain all
information pertaining to the sending LLDP agent if it does not transmit
updates in a timely manner.
Example
Console(config)#lldp holdtime-multiplier 10
Console(config)#
– 735 –
Chapter 26 | LLDP Commands
lldp This command specifies the amount of MED Fast Start LLDPDUs to transmit during
med-fast-start-count the activation process of the LLDP-MED Fast Start mechanism. Use the no form to
restore the default setting.
Syntax
lldp med-fast-start-count packet-number
no lldp med-fast-start-count
packet-number - Amount of packets. (Range: 1-10 packets;
Default: 4 packets)
Default Setting
4 packets
Command Mode
Global Configuration
Command Usage
This parameter is part of the timer which ensures that the LLDP-MED Fast Start
mechanism is active for the port. LLDP-MED Fast Start is critical to the timely
startup of LLDP, and therefore integral to the rapid availability of Emergency Call
Service.
Example
Console(config)#lldp med-fast-start-count 6
Console(config)#
lldp This command configures the allowed interval for sending SNMP notifications
notification-interval about LLDP MIB changes. Use the no form to restore the default setting.
Syntax
lldp notification-interval seconds
no lldp notification-interval
seconds - Specifies the periodic interval at which SNMP notifications are
sent. (Range: 5 - 3600 seconds)
Default Setting
5 seconds
Command Mode
Global Configuration
Command Usage
◆ This parameter only applies to SNMP applications which use data stored in the
LLDP MIB for network monitoring or management.
– 736 –
Chapter 26 | LLDP Commands
Example
Console(config)#lldp notification-interval 30
Console(config)#
lldp refresh-interval This command configures the periodic transmit interval for LLDP advertisements.
Use the no form to restore the default setting.
Syntax
lldp refresh-interval seconds
no lldp refresh-delay
seconds - Specifies the periodic interval at which LLDP advertisements are
sent. (Range: 5 - 32768 seconds)
Default Setting
30 seconds
Command Mode
Global Configuration
Example
Console(config)#lldp refresh-interval 60
Console(config)#
lldp reinit-delay This command configures the delay before attempting to re-initialize after LLDP
ports are disabled or the link goes down. Use the no form to restore the default
setting.
Syntax
lldp reinit-delay seconds
no lldp reinit-delay
seconds - Specifies the delay before attempting to re-initialize LLDP.
(Range: 1 - 10 seconds)
Default Setting
2 seconds
– 737 –
Chapter 26 | LLDP Commands
Command Mode
Global Configuration
Command Usage
When LLDP is re-initialized on a port, all information in the remote systems LLDP
MIB associated with this port is deleted.
Example
Console(config)#lldp reinit-delay 10
Console(config)#
lldp tx-delay This command configures a delay between the successive transmission of
advertisements initiated by a change in local LLDP MIB variables. Use the no form
to restore the default setting.
Syntax
lldp tx-delay seconds
no lldp tx-delay
seconds - Specifies the transmit delay. (Range: 1 - 8192 seconds)
Default Setting
2 seconds
Command Mode
Global Configuration
Command Usage
◆ The transmit delay is used to prevent a series of successive LLDP transmissions
during a short period of rapid changes in local LLDP MIB objects, and to
increase the probability that multiple, rather than single changes, are reported
in each transmission.
Example
Console(config)#lldp tx-delay 10
Console(config)#
– 738 –
Chapter 26 | LLDP Commands
lldp admin-status This command enables LLDP transmit, receive, or transmit and receive mode on the
specified port. Use the no form to disable this feature.
Syntax
lldp admin-status {rx-only | tx-only | tx-rx}
no lldp admin-status
rx-only - Only receive LLDP PDUs.
tx-only - Only transmit LLDP PDUs.
tx-rx - Both transmit and receive LLDP Protocol Data Units (PDUs).
Default Setting
tx-rx
Command Mode
Interface Configuration (Ethernet, Port Channel)
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp admin-status rx-only
Console(config-if)#
lldp basic-tlv This command configures an LLDP-enabled port to advertise the management
management-ip- address for this device. Use the no form to disable this feature.
address
Syntax
[no] lldp basic-tlv management-ip-address
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ The management address protocol packet includes the IPv4 address of the
switch. If no management address is available, the address should be the MAC
address for the CPU or for the port sending this advertisement.
◆ The management address TLV may also include information about the specific
interface associated with this address, and an object identifier indicating the
type of hardware component or protocol entity associated with this address.
The interface number and OID are included to assist SNMP applications to
perform network discovery by indicating enterprise specific or other starting
points for the search, such as the Interface or Entity MIB.
– 739 –
Chapter 26 | LLDP Commands
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp basic-tlv management-ip-address
Console(config-if)#
lldp basic-tlv This command configures an LLDP-enabled port to advertise the management
management-ipv6- IPv6 address for this device. Use the no form to disable this feature.
address
Syntax
[no] lldp basic-tlv management-ipv6-address
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ If both the management-ip-address and the IPv4 address of a VLAN interface is
configured, the primary IPv4 address of the VLAN ID will be sent in the
Management Address TLV of the LLDP PDU transmitted.
◆ Two Management Address TLVs in the LLDP PDU will be sent if both of the two
conditions below are true:
■ The interface has both commands configured i.e. management-ip-address
and management-ipv6-address.
■ The VLAN interface has both IPv4 and IPv6 addresses set.
One address will be the IPv4 address and the other will be the IPv6 address.
◆ If either or both the management-ip-address or management-ipv6-address are
configured
- and -
– 740 –
Chapter 26 | LLDP Commands
Neither the IPv4 address nor the IPv6 address of a VLAN interface is configured.
The CPU MAC address (or device MAC address) will be sent in the Management
Address TLV of the LLDP PDU transmitted.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp basic-tlv management-ipv6-address
Console(config-if)#
lldp basic-tlv This command configures an LLDP-enabled port to advertise its port description.
port-description Use the no form to disable this feature.
Syntax
[no] lldp basic-tlv port-description
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
The port description is taken from the ifDescr object in RFC 2863, which includes
information about the manufacturer, the product name, and the version of the
interface hardware/software.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp basic-tlv port-description
Console(config-if)#
lldp basic-tlv This command configures an LLDP-enabled port to advertise its system
system-capabilities capabilities. Use the no form to disable this feature.
Syntax
[no] lldp basic-tlv system-capabilities
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
– 741 –
Chapter 26 | LLDP Commands
Command Usage
The system capabilities identifies the primary function(s) of the system and
whether or not these primary functions are enabled. The information advertised by
this TLV is described in IEEE 802.1AB.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp basic-tlv system-capabilities
Console(config-if)#
lldp basic-tlv This command configures an LLDP-enabled port to advertise the system
system-description description. Use the no form to disable this feature.
Syntax
[no] lldp basic-tlv system-description
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
The system description is taken from the sysDescr object in RFC 3418, which
includes the full name and version identification of the system's hardware type,
software operating system, and networking software.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp basic-tlv system-description
Console(config-if)#
lldp basic-tlv This command configures an LLDP-enabled port to advertise the system name. Use
system-name the no form to disable this feature.
Syntax
[no] lldp basic-tlv system-name
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
– 742 –
Chapter 26 | LLDP Commands
Command Usage
The system name is taken from the sysName object in RFC 3418, which contains the
system’s administratively assigned name, and is in turn based on the hostname
command.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp basic-tlv system-name
Console(config-if)#
lldp dot1-tlv This command configures an LLDP-enabled port to advertise the supported
proto-ident protocols. Use the no form to disable this feature.
Syntax
[no] lldp dot1-tlv proto-ident
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
This option advertises the protocols that are accessible through this interface.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp dot1-tlv proto-ident
Console(config-if)#
lldp dot1-tlv proto-vid This command configures an LLDP-enabled port to advertise port-based protocol
VLAN information. Use the no form to disable this feature.
Syntax
[no] lldp dot1-tlv proto-vid
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
– 743 –
Chapter 26 | LLDP Commands
Command Usage
This option advertises the port-based protocol VLANs configured on this interface
(see “Configuring Protocol-based VLANs” on page 557).
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp dot1-tlv proto-vid
Console(config-if)#
lldp dot1-tlv pvid This command configures an LLDP-enabled port to advertise its default VLAN ID.
Use the no form to disable this feature.
Syntax
[no] lldp dot1-tlv pvid
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
The port’s default VLAN identifier (PVID) indicates the VLAN with which untagged
or priority-tagged frames are associated (see the switchport native vlan command).
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp dot1-tlv pvid
Console(config-if)#
lldp dot1-tlv This command configures an LLDP-enabled port to advertise its VLAN name. Use
vlan-name the no form to disable this feature.
Syntax
[no] lldp dot1-tlv vlan-name
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
– 744 –
Chapter 26 | LLDP Commands
Command Usage
This option advertises the name of all VLANs to which this interface has been
assigned. See “switchport allowed vlan” on page 535 and “protocol-vlan protocol-
group (Configuring Interfaces)” on page 558.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp dot1-tlv vlan-name
Console(config-if)#
lldp dot3-tlv link-agg This command configures an LLDP-enabled port to advertise link aggregation
capabilities. Use the no form to disable this feature.
Syntax
[no] lldp dot3-tlv link-agg
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
This option advertises link aggregation capabilities, aggregation status of the link,
and the 802.3 aggregated port identifier if this interface is currently a link
aggregation member.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp dot3-tlv link-agg
Console(config-if)#
lldp dot3-tlv mac-phy This command configures an LLDP-enabled port to advertise its MAC and physical
layer capabilities. Use the no form to disable this feature.
Syntax
[no] lldp dot3-tlv mac-phy
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
– 745 –
Chapter 26 | LLDP Commands
Command Usage
This option advertises MAC/PHY configuration/status which includes information
about auto-negotiation support/capabilities, and operational Multistation Access
Unit (MAU) type.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#no lldp dot3-tlv mac-phy
Console(config-if)#
lldp dot3-tlv This command configures an LLDP-enabled port to advertise its maximum frame
max-frame size. Use the no form to disable this feature.
Syntax
[no] lldp dot3-tlv max-frame
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
Refer to “Frame Size” on page 115 for information on configuring the maximum
frame size for this switch.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp dot3-tlv max-frame
Console(config-if)#
– 746 –
Chapter 26 | LLDP Commands
lldp med-location This command configures an LLDP-MED-enabled port to advertise its location
civic-addr identification details. Use the no form to restore the default settings.
Syntax
lldp med-location civic-addr [[country country-code] | [what device-type] |
[ca-type ca-value]]
no lldp med-location civic-addr [[country] | [what] | [ca-type]]
country-code – The two-letter ISO 3166 country code in capital ASCII letters.
(Example: DK, DE or US)
Default Setting
Not advertised
No description
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ Use this command without any keywords to advertise location identification
details.
◆ Use the ca-type to advertise the physical location of the device, that is the city,
street number, building and room information. The address location is
specified as a type and value pair, with the civic address (CA) type being
defined in RFC 4776. The following table describes some of the CA type
numbers and provides examples.
0 The ISO 639 language code used for presenting the address en
information.
– 747 –
Chapter 26 | LLDP Commands
27 Floor 5
28 Room 509B
Any number of CA type and value pairs can be specified for the civic address
location, as long as the total does not exceed 250 characters.
◆ For the location options defined for device-type, normally option 2 is used to
specify the location of the client device. In situations where the client device
location is not known, 0 and 1 can be used, providing the client device is
physically close to the DHCP server or network element.
Example
The following example enables advertising location identification details.
lldp med-notification This command enables the transmission of SNMP trap notifications about LLDP-
MED changes. Use the no form to disable LLDP-MED notifications.
Syntax
[no] lldp med-notification
– 748 –
Chapter 26 | LLDP Commands
Default Setting
Disabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ This option sends out SNMP trap notifications to designated target stations at
the interval specified by the lldp notification-interval command. Trap
notifications include information about state changes in the LLDP MIB (IEEE
802.1AB), the LLDP-MED MIB (ANSI/TIA 1057), or organization-specific LLDP-
EXT-DOT1 and LLDP-EXT-DOT3 MIBs.
◆ SNMP trap destinations are defined using the snmp-server host command.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp med-notification
Console(config-if)#
lldp med-tlv inventory This command configures an LLDP-MED-enabled port to advertise its inventory
identification details. Use the no form to disable this feature.
Syntax
[no] lldp med-tlv inventory
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
This option advertises device details useful for inventory management, such as
manufacturer, model, software version and other pertinent information.
– 749 –
Chapter 26 | LLDP Commands
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp med-tlv inventory
Console(config-if)#
lldp med-tlv location This command configures an LLDP-MED-enabled port to advertise its location
identification details. Use the no form to disable this feature.
Syntax
[no] lldp med-tlv location
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
This option advertises location identification details.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp med-tlv location
Console(config-if)#
lldp med-tlv med-cap This command configures an LLDP-MED-enabled port to advertise its Media
Endpoint Device capabilities. Use the no form to disable this feature.
Syntax
[no] lldp med-tlv med-cap
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
This option advertises LLDP-MED TLV capabilities, allowing Media Endpoint and
Connectivity Devices to efficiently discover which LLDP-MED related TLVs are
supported on the switch.
– 750 –
Chapter 26 | LLDP Commands
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp med-tlv med-cap
Console(config-if)#
lldp med-tlv This command configures an LLDP-MED-enabled port to advertise its network
network-policy policy configuration. Use the no form to disable this feature.
Syntax
[no] lldp med-tlv network-policy
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
This option advertises network policy configuration information, aiding in the
discovery and diagnosis of VLAN configuration mismatches on a port. Improper
network policy configurations frequently result in voice quality degradation or
complete service disruption.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp med-tlv network-policy
Console(config-if)#
lldp notification This command enables the transmission of SNMP trap notifications about LLDP
changes in remote neighbors. Use the no form to disable LLDP notifications.
Syntax
[no] lldp notification
Default Setting
Enabled
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ This option sends out SNMP trap notifications to designated target stations at
the interval specified by the lldp notification-interval command. Trap
– 751 –
Chapter 26 | LLDP Commands
notifications include information about state changes in the LLDP MIB (IEEE
802.1AB), or organization-specific LLDP-EXT-DOT1 and LLDP-EXT-DOT3 MIBs.
◆ SNMP trap destinations are defined using the snmp-server host command.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#lldp notification
Console(config-if)#
show lldp config This command shows LLDP configuration settings for all ports.
Syntax
show lldp config [detail interface]
detail - Shows configuration summary.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
Example
The following example shows the basic LLDP parameters for Port 1.
– 752 –
Chapter 26 | LLDP Commands
proto-vlan
proto-ident
802.3 specific TLVs Advertised : mac-phy
link-agg
max-frame
MED Notification Status : Disabled
MED Enabled TLVs Advertised : med-cap
network-policy
location
inventory
MED Location Identification
Location Data Format : Civic Address LCI
Country Name : DK
What : 2 - DHCP Client
CA Type 1 : 12
CA Type 13 : 13
Console#
show lldp info This command shows LLDP global and interface-specific configuration settings for
local-device this device.
Syntax
show lldp info local-device [detail interface]
detail - Shows configuration summary.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show lldp info local-device
LLDP Local Global Information
Chassis Type : MAC Address
Chassis ID : 00-01-02-03-04-05
System Name :
System Description : ECS5520-18X
System Capabilities Support : Bridge
System Capabilities Enabled : Bridge
Management Address : 192.168.0.101 (IPv4)
– 753 –
Chapter 26 | LLDP Commands
.
Console#show lldp info local-device detail ethernet 1/1
LLDP Local Port Information Detail
Port : Eth 1/1
Port ID Type : MAC Address
Port ID : 00-12-CF-DA-FC-E9
Port Description : Ethernet Port on unit 1, port 1
MED Capability : LLDP-MED Capabilities
Network Policy
Location Identification
Inventory
Console#
show lldp info This command shows LLDP global and interface-specific configuration settings for
remote-device remote devices attached to an LLDP-enabled port.
Syntax
show lldp info remote-device [detail interface]
detail - Shows detailed information.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
Example
Note that an IP phone or other end-node device which advertises LLDP-MED
capabilities must be connected to the switch for information to be displayed in the
“LLDP-MED Capability” and other related fields.
– 754 –
Chapter 26 | LLDP Commands
Port VLAN ID : 1
MAC/PHY Configuration/Status
Port Auto-neg Supported : Yes
Port Auto-neg Enabled : Yes
Port Auto-neg Advertised Cap (Hex) : 6C00
Port MAU Type : 16
Link Aggregation
Link Aggregation Capable : Yes
Link Aggregation Enable : No
Link Aggregation Port ID : 0
Console#
The following example shows information which is displayed for end-node device
which advertises LLDP-MED TLVs.
...
LLDP-MED Capability :
Device Class : Network Connectivity
Supported Capabilities : LLDP-MED Capabilities
Network Policy
Location Identification
Extended Power via MDI - PSE
Inventory
Current Capabilities : LLDP-MED Capabilities
Location Identification
Extended Power via MDI - PSE
Inventory
Location Identification :
Location Data Format : Civic Address LCI
Country Name : TW
What : 2
Extended Power via MDI :
Power Type : PSE
Power Source : Unknown
Power Priority : Unknown
Power Value : 0 Watts
Inventory :
Hardware Revision : R0A
Firmware Revision : 1.2.6.0
– 755 –
Chapter 26 | LLDP Commands
show lldp info This command shows statistics based on traffic received through all attached LLDP-
statistics enabled interfaces.
Syntax
show lldp info statistics [detail interface]
detail - Shows configuration summary.
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show lldp info statistics
LLDP Global Statistics
Neighbor Entries List Last Updated : 485 seconds
New Neighbor Entries Count : 2
Neighbor Entries Deleted Count : 1
Neighbor Entries Dropped Count : 0
Neighbor Entries Ageout Count : 1
– 756 –
27 OAM Commands
efm oam link-monitor Sets the threshold for errored frame link events IC
frame threshold
efm oam link-monitor Sets the monitor period for errored frame link events IC
frame window
efm oam mode Sets the OAM operational mode to active or passive IC
clear efm oam counters Clears statistical counters for various OAMPDU message PE
types
clear efm oam event-log Clears all entries from the OAM event log for the specified PE
port
show efm oam counters Displays counters for various OAM PDU message types NE,PE
interface
show efm oam remote- Displays results of OAM remote loopback test NE,PE
loopback interface
show efm oam Displays OAM configuration settings and event counters NE,PE
status interface
show efm oam status Displays information about attached OAM-enabled NE,PE
remote interface devices
– 757 –
Chapter 27 | OAM Commands
efm oam This command enables OAM functions on the specified port. Use the no form to
disable this function.
Syntax
[no] efm oam
Default Setting
Disabled
Command Mode
Interface Configuration
Command Usage
◆ If the remote device also supports OAM, both exchange Information OAMPDUs
to establish an OAM link.
◆ Not all CPEs support OAM functions, and OAM is therefore disabled by default.
If the CPE attached to a port supports OAM, then this functionality must first be
enabled by the efm oam command to gain access to other remote
configuration functions.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#efm oam
Console(config-if)#
efm oam This command enables reporting of critical event or dying gasp. Use the no form to
critical-link-event disable this function.
Syntax
[no] efm oam critical-link-event {critical-event | dying-gasp}
critical-event - If a critical event occurs, the local OAM entity (this switch)
indicates this to its peer by setting the appropriate flag in the next
OAMPDU to be sent and stores this information in its OAM event log.
dying-gasp - If an unrecoverable condition occurs, the local OAM entity
indicates this by immediately sending a trap message.
Default Setting
Enabled
Command Mode
Interface Configuration
– 758 –
Chapter 27 | OAM Commands
Command Usage
◆ Critical events are vendor-specific and may include various failures, such as
abnormal voltage fluctuations, out-of-range temperature detected, fan failure,
CRC error in flash memory, insufficient memory, or other hardware faults.
Note: When system power fails, the switch will always send a dying gasp trap
message prior to power down.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#efm oam critical-link-event dying-gasp
Console(config-if)#
efm oam This command enables reporting of errored frame link events. Use the no form to
link-monitor frame disable this function.
Syntax
[no] efm oam link-monitor frame
Default Setting
Enabled
Command Mode
Interface Configuration
Command Usage
◆ An errored frame is a frame in which one or more bits are errored.
◆ If this feature is enabled and an errored frame link event occurs, the local OAM
entity (this switch) sends an Event Notification OAMPDU.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#efm oam link-monitor frame
Console(config-if)#
– 759 –
Chapter 27 | OAM Commands
efm oam link-monitor This command sets the threshold for errored frame link events. Use the no form to
frame threshold restore the default setting.
Syntax
efm oam link-monitor frame threshold count
no efm oam link-monitor frame threshold
count - The threshold for errored frame link events. (Range: 1-65535)
Default Setting
1
Command Mode
Interface Configuration
Command Usage
If this feature is enabled, an event notification message is sent if the threshold is
reached or exceeded within the period specified by the efm oam link-monitor
frame window command. The Errored Frame Event TLV includes the number of
errored frames detected during the specified period.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#efm oam link-monitor frame threshold 5
Console(config-if)#
efm oam link-monitor This command sets the monitor period for errored frame link events. Use the no
frame window form to restore the default setting.
Syntax
efm oam link-monitor frame window size
no efm oam link-monitor frame window
size - The period of time in which to check the reporting threshold for
errored frame link events. (Range: 10-65535 units of 10 milliseconds)
Default Setting
10 (units of 100 milliseconds) = 1 second
Command Mode
Interface Configuration
Command Usage
If this feature is enabled, an event notification message is sent if the threshold
specified by the efm oam link-monitor frame threshold command is reached or
– 760 –
Chapter 27 | OAM Commands
exceeded within the period specified by this command. The Errored Frame Event
TLV includes the number of errored frames detected during the specified period.
Example
This example set the window size to 5 seconds.
efm oam mode This command sets the OAM mode on the specified port. Use the no form to
restore the default setting.
Syntax
efm oam mode {active | passive}
no efm oam mode
active - All OAM functions are enabled.
passive - All OAM functions are enabled, except for OAM discovery, and
sending loopback control OAMPDUs.
Default Setting
Active
Command Mode
Interface Configuration
Command Usage
When set to active mode, the selected interface will initiate the OAM discovery
process. When in passive mode, it can only respond to discovery messages.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#efm oam mode active
Console(config-if)#
– 761 –
Chapter 27 | OAM Commands
clear efm oam This command clears statistical counters for various OAMPDU message types.
counters
Syntax
clear efm oam counters [interface-list]
interface-list - unit/port
unit - Unit identifier. (Range: 1)
port - Port number or list of ports. To enter a list, separate
nonconsecutive port identifiers with a comma and no spaces; use a
hyphen to designate a range of ports. (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#clear efm oam counters
Console#
Related Commands
show efm oam counters interface (765)
clear efm oam This command clears all entries from the OAM event log for the specified port.
event-log
Syntax
clear efm oam event-log [interface-list]
unit - Unit identifier. (Range: 1)
port - Port number or list of ports. To enter a list, separate nonconsecutive
port identifiers with a comma and no spaces; use a hyphen to designate a
range of ports. (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#clear efm oam event-log
Console#
– 762 –
Chapter 27 | OAM Commands
efm oam This command starts or stops OAM loopback test mode to the attached CPE.
remote-loopback
Syntax
efm oam remote-loopback {start | stop} interface
start - Starts remote loopback test mode.
stop - Stops remote loopback test mode.
interface - unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
Default Setting
None
Command Mode
Privileged Exec
Command Usage
◆ OAM remote loop back can be used for fault localization and link performance
testing. Statistics from both the local and remote DTE can be queried and
compared at any time during loop back testing.
◆ Use the efm oam remote-loopback start command to start OAM remote loop
back test mode on the specified port. Afterwards, use the efm oam remote-
loopback test command to start sending test packets. Then use the efm oam
remote loopback stop command to terminate testing (if test packets are still
being sent) and to terminate loop back test mode.
◆ The port that you specify to run this test must be connected to a peer OAM
device capable of entering into OAM remote loopback mode.
◆ During a remote loopback test, the remote OAM entity loops back every frame
except for OAMPDUs and pause frames.
◆ During loopback testing, both the switch and remote device are permitted to
send OAMPDUs to the peer device and to process any OAMPDUs received from
the peer.
Example
Console#efm oam remote-loopback start 1/1
Loopback operation is processing, please wait.
Enter loopback mode succeeded.
Console#
– 763 –
Chapter 27 | OAM Commands
efm oam remote- This command performs a remote loopback test, sending a specified number of
loopback test packets.
Syntax
efm oam remote-loopback test interface [number-of-packets [packet-size]]
interface - unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
number-of-packets - Number of packets to send. (Range: 1-99999999)
packet-size - Size of packets to send. (Range: 64-1518 bytes)
Default Setting
Number of packets: 10,000
Packet size: 64 bytes
Command Mode
Privileged Exec
Command Usage
◆ You can use this command to perform an OAM remote loopback test on the
specified port. The port that you specify to run this test must be connected to a
peer OAM device capable of entering into OAM remote loopback mode.
◆ During a remote loopback test, the remote OAM entity loops back every frame
except for OAMPDUs and pause frames.
◆ OAM remote loopback can be used for fault localization and link performance
testing. Statistics from both the local and remote DTE can be queried and
compared at any time during loopback testing.
Example
Console#efm oam remote-loopback test 1/2
Loopback test is processing, press ESC to suspend.
....
Port OAM loopback Tx OAM loopback Rx Loss Rate
---- --------------- --------------- ---------
1/2 1990 1016 48.94 %
Console#
– 764 –
Chapter 27 | OAM Commands
show efm oam This command displays counters for various OAM PDU message types.
counters interface
Syntax
show efm oam counters interface [interface-list]
interface-list - unit/port
unit - Unit identifier. (Range: 1)
port - Port number or list of ports. To enter a list, separate
nonconsecutive port identifiers with a comma and no spaces; use a
hyphen to designate a range of ports. (Range: 1-28)
Command Mode
Normal Exec, Privileged Exec
Example
Console#show efm oam counters interface 1/1
Port OAMPDU Type TX RX
---- --------------------- ---------- ----------
1/1 Information 1121 1444
1/1 Event Notification 0 0
1/1 Loopback Control 1 0
1/1 Organization Specific 76 0
Console#
show efm oam This command displays the OAM event log for the specified port(s) or for all ports
event-log interface that have logs.
Command Mode
Normal Exec, Privileged Exec
Command Usage
◆ When a link event occurs, no matter whether the location is local or remote, this
information is entered in the OAM event log.
◆ When the log system becomes full, older events are automatically deleted to
make room for new entries.
– 765 –
Chapter 27 | OAM Commands
Example
Console#show efm oam event-log interface 1/1
OAM event log of Eth 1/1:
00:24:07 2001/01/01
"Unit 1, Port 1: Dying Gasp at Remote"
Console#
This command can show OAM link status changes for link partner as shown in this
example.
This command can show OAM dying gasp changes for link partner as shown in this
example.
– 766 –
Chapter 27 | OAM Commands
show efm oam This command displays the results of an OAM remote loopback test.
remote-loopback
interface Syntax
show efm oam remote-loopback interface [interface-list]
interface-list - unit/port
unit - Unit identifier. (Range: 1)
port - Port number or list of ports. To enter a list, separate
nonconsecutive port identifiers with a comma and no spaces; use a
hyphen to designate a range of ports. (Range: 1-28)
Command Mode
Normal Exec, Privileged Exec
Example
Console#show efm oam remote-loopback interface 1/1
Port OAM loopback Tx OAM loopback Rx Loss Rate
---- --------------- --------------- ---------
1/1 2300 2250 0.01 %
Console#
show efm oam This command displays OAM configuration settings and event counters.
status interface
Syntax
show efm oam status interface [interface-list] [brief ]
interface - unit/port
unit - Unit identifier. (Range: 1)
port - Port number or list of ports. To enter a list, separate
nonconsecutive port identifiers with a comma and no spaces; use a
hyphen to designate a range of ports. (Range: 1-28)
brief - Displays a brief list of OAM configuration states.
Command Mode
Normal Exec, Privileged Exec
Example
Console#show efm oam status interface 1/1
OAM information of Eth 1/1:
Basic Information:
Admin State : Enabled
Operation State : Operational
Mode : Active
Remote Loopback : Disabled
Remote Loopback Status : No loopback
Dying Gasp : Enabled
Critical Event : Enabled
– 767 –
Chapter 27 | OAM Commands
show efm oam status This command displays information about attached OAM-enabled devices.
remote interface
Syntax
show efm oam status remote interface [interface-list]
interface-list - unit/port
unit - Unit identifier. (Range: 1)
port - Port number or list of ports. To enter a list, separate
nonconsecutive port identifiers with a comma and no spaces; use a
hyphen to designate a range of ports. (Range: 1-28)
Command Mode
Normal Exec, Privileged Exec
Example
Console#show efm oam status remote interface 1/1
Port MAC Address OUI Remote Unidirectional Link MIB Variable
Loopback Monitor Retrieval
---- ----------------- ------ -------- -------------- ------- ------------
1/1 00-12-CF-6A-07-F6 000084 Enabled Disabled Enabled Disabled
Console#
– 768 –
28 Domain Name Service
Commands
These commands are used to configure Domain Naming System (DNS) services.
Entries can be manually configured in the DNS domain name to IP address
mapping table, default domain names configured, or one or more name servers
specified to use for domain name to address translation.
Note that domain name services will not be enabled until at least one name server
is specified with the ip name-server command and domain lookup is enabled with
the ip domain-lookup command.
The switch performs both as a DNS client and a DNS server/proxy in the following
manner:
PC (DNS Client) <------> Switch (DNS client1, server/proxy2) <------> Server (another
server/proxy)
1 For the case that the switch performs as a DNS client and an incomplete host
name is received, it will work through the domain list, appending each domain
name in the list to the host name, and checking with the specified name servers
for a match.
2 Otherwise, the switch acts as a DNS server/proxy when an outside host (namely, a
DNS client) intends to get an IP address for a host name through the switch. In
this case, it will not add the domain suffix to query name servers). That means
that the DNS client is responsible for adding the domain suffix.
DNS
ip name-server Specifies the address of one or more name servers to use for GC
host name-to-address translation
clear dns cache Clears all entries from the DNS cache PE
– 769 –
Chapter 28 | Domain Name Service Commands
DNS Commands
mDNS
DNS Commands
ip domain-list This command defines a list of domain names that can be appended to incomplete
host names (i.e., host names passed from a client that are not formatted with
dotted notation). Use the no form to remove a name from this list.
Syntax
[no] ip domain-list name
name - Name of the host. Do not include the initial dot that separates the
host name from the domain name. (Range: 1-127 characters)
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ Domain names are added to the end of the list one at a time.
◆ When an incomplete host name is received by the DNS service on this switch, it
will work through the domain list, appending each domain name in the list to
the host name, and checking with the specified name servers for a match.
◆ If there is no domain list, the domain name specified with the ip domain-name
command is used. If there is a domain list, the default domain name is not used.
Example
This example adds two domain names to the current list and then displays the list.
– 770 –
Chapter 28 | Domain Name Service Commands
DNS Commands
Related Commands
ip domain-name (772)
ip domain-lookup This command enables DNS host name-to-address translation. Use the no form to
disable DNS.
Syntax
[no] ip domain-lookup
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ At least one name server must be specified before DNS can be enabled.
◆ If one or more name servers are configured, but DNS is not yet enabled and the
switch receives a DHCP packet containing a DNS field with a list of DNS servers,
then the switch will automatically enable DNS host name-to-address
translation.
Example
This example enables DNS and then displays the configuration.
Console(config)#ip domain-lookup
Console(config)#end
Console#show dns
Domain Lookup Status:
DNS Enabled
Default Domain Name:
sample.com
Domain Name List:
sample.com.jp
sample.com.uk
Name Server List:
192.168.1.55
10.1.0.55
Console#
– 771 –
Chapter 28 | Domain Name Service Commands
DNS Commands
Related Commands
ip domain-name (772)
ip name-server (773)
ip domain-name This command defines the default domain name appended to incomplete host
names (i.e., host names passed from a client that are not formatted with dotted
notation). Use the no form to remove the current domain name.
Syntax
ip domain-name name
no ip domain-name
name - Name of the host. Do not include the initial dot that separates the
host name from the domain name. (Range: 1-127 characters)
Default Setting
None
Command Mode
Global Configuration
Example
Console(config)#ip domain-name sample.com
Console(config)#end
Console#show dns
Domain Lookup Status:
DNS Disabled
Default Domain Name:
sample.com
Domain Name List:
Name Server List:
Console#
Related Commands
ip domain-list (770)
ip name-server (773)
ip domain-lookup (771)
ip host This command creates a static entry in the DNS table that maps a host name to an
IPv4 address. Use the no form to remove an entry.
Syntax
[no] ip host name address
– 772 –
Chapter 28 | Domain Name Service Commands
DNS Commands
Default Setting
No static entries
Command Mode
Global Configuration
Command Usage
Use the no ip host command to clear static entries.
Example
This example maps an IPv4 address to a host name.
ip name-server This command specifies the address of one or more domain name servers to use for
name-to-address resolution. Use the no form to remove a name server from this
list.
Syntax
[no] ip name-server server-address1 [server-address2 …
server-address6]
server-address1 - IPv4 or IPv6 address of domain-name server.
server-address2 … server-address6 - IPv4 or IPv6 address of additional
domain-name servers.
Default Setting
None
Command Mode
Global Configuration
Command Usage
The listed name servers are queried in the specified sequence until a response is
received, or the end of the list is reached with no response.
– 773 –
Chapter 28 | Domain Name Service Commands
DNS Commands
Example
This example adds two domain-name servers to the list and then displays the list.
Related Commands
ip domain-name (772)
ip domain-lookup (771)
ipv6 host This command creates a static entry in the DNS table that maps a host name to an
IPv6 address. Use the no form to remove an entry.
Syntax
[no] ipv6 host name ipv6-address
name - Name of an IPv6 host. (Range: 1-127 characters)
ipv6-address - Corresponding IPv6 address. This address must be entered
according to RFC 2373 “IPv6 Addressing Architecture,” using 8 colon-
separated 16-bit hexadecimal values. One double colon may be used in the
address to indicate the appropriate number of zeros required to fill the
undefined fields.
Default Setting
No static entries
Command Mode
Global Configuration
Example
This example maps an IPv6 address to a host name.
– 774 –
Chapter 28 | Domain Name Service Commands
DNS Commands
clear dns cache This command clears all entries in the DNS cache.
Command Mode
Privileged Exec
Example
Console#clear dns cache
Console#show dns cache
No. Flag Type IP Address TTL Host
------- ------- ------- --------------- ------- --------
Console#
show dns This command displays the configuration of the DNS service.
Command Mode
Privileged Exec
Example
Console#show dns
Domain Lookup Status:
DNS enabled
Default Domain Name:
sample.com
Domain Name List:
sample.com.jp
sample.com.uk
Name Server List:
192.168.1.55
10.1.0.55
Console#
show dns cache This command displays entries in the DNS cache.
Command Mode
Privileged Exec
Example
Console#show dns cache
No. Flag Type IP Address TTL Host
------- ------- ------- --------------- ------- --------
0 4 Host 52.196.118.60 3501 www.accton.com
1 4 Host 166.62.56.229 21540 www.edge-core.com
2 4 Host 35.201.87.174 1787 ignitenet.com
– 775 –
Chapter 28 | Domain Name Service Commands
DNS Commands
Flag The flag is always “4” indicating a cache entry and therefore unreliable.
Type This field includes “Host” which specifies the primary name for the owner, and
“CNAME” which specifies multiple domain names (or aliases) which are
mapped to the same IP address as an existing entry.
show hosts This command displays the static host name-to-address mapping table.
Command Mode
Privileged Exec
Example
Note that a host name will be displayed as an alias if it is mapped to the same
address(es) as a previously configured entry.
Console#show hosts
No. Flag Type IP Address TTL Host
---- ---- ------- -------------------- ----- ----------------------------------
0 2 Address 192.168.2.1 rdrouter
1 4 Address 52.196.118.60 3341 www.accton.com
2 4 Address 166.62.56.229 21381 www.edge-core.com
3 4 Address 35.201.87.174 1627 ignitenet.com
4 4 CNAME POINTER TO:3 1628 www.ignitenet.com
Console#
Flag The field displays “2” for a static entry, or “4” for a dynamic entry stored in the
cache.
Type This field includes “Address” which specifies the primary name for the owner,
and “CNAME” which specifies multiple domain names (or aliases) which are
mapped to the same IP address as an existing entry.
– 776 –
Chapter 28 | Domain Name Service Commands
Multicast DNS Commands
TTL The time to live reported by the name server. This field is always blank for static
entries.
ip mdns This command enables multicast DNS. Use the no form to disable this feature.
Syntax
[no] ip mdns
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
Use this command to enable multicast DNS host name-to-address mapping on the
local network without the need for a dedicated DNS server. For more information
on this command refer to the Web Management Guide.
Example
Console(config)#ip mdns
Console(config)#
show ip mdns This command displays the configuration state multicast DNS service.
Command Mode
Privileged Exec
Example
Console#show ip mdns
Multicast DNS Status : Enabled
Console#
– 777 –
Chapter 28 | Domain Name Service Commands
Multicast DNS Commands
– 778 –
29 DHCP Commands
DHCP Relay Relays DHCP requests from local hosts to a remote DHCP server
DHCP Server Configures DHCP service using address pools or static bindings
DHCP Client
Use the commands in this section to allow the switch’s VLAN interfaces to
dynamically acquire IP address information.
ip dhcp client class-id Specifies the DHCP client identifier for an interface IC
ipv6 dhcp client Specifies the Rapid Commit option for DHCPv6 message GC
rapid-commit vlan exchange
show ipv6 dhcp duid Shows the DHCP Unique Identifier for this switch PE
show ipv6 dhcp vlan Shows DHCPv6 information for specified interface PE
show ipv6 dhcp Shows the status of dynamic provision via DHCPv6 PE
dynamic-provision
– 779 –
Chapter 29 | DHCP Commands
DHCP Client
ip dhcp This command enables dynamic provisioning via DHCP. Use the no form to disable
dynamic-provision this feature.
Syntax
[no] ip dhcp dynamic-provision
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
DHCPD is the daemon used by Linux to dynamically configure TCP/IP information
for client systems. To support DHCP option 66/67, you have to add corresponding
statements to the configuration file of DHCPD. Information on how to complete
this process are described in “Downloading a Configuration File and Other
Parameters from a DHCP Server” on page 65.
The following are some alternative commands which can be added to the DHCPD
to complete the dynamic provisioning process.
By default, the parameters for DHCP option 66/67 are not carried by the reply sent
from the DHCP server. To ask for a DHCP reply with option 66/67, the client can
inform the server that it is interested in option 66/67 by sending a DHCP request
that includes a 'parameter request list' option. Besides this, the client can also send
a DHCP request that includes a 'vendor class identifier' option to the server so that
the DHCP server can identify the device, and determine what information should
be given to requesting device.
The following are two additional sample configurations of the dhcpd.conf file for
the server version dhcp-3.0.4rc1, you can choose either one of them.
– 780 –
Chapter 29 | DHCP Commands
DHCP Client
shared-network Sample2 {
subnet 192.168.1.0 netmask 255.255.255.0 {
}
pool {
allow members of "OPT66_67";
range 192.168.1.10 192.168.1.20;
}
}
Example
In the following example enables dhcp dynamic provisioning.
ip dhcp client class-id This command specifies the DCHP client vendor class identifier for the current
interface. Use the no form to remove the class identifier from the DHCP packet.
Syntax
ip dhcp client class-id [text text | hex hex]
no ip dhcp client class-id
text - A text string. (Range: 1-32 characters)
hex - A hexadecimal value. (Range: 1-64 characters)
Default Setting
Class identifier option enabled, using the model number as the string
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ Use this command without any keyword to restore the default setting.
– 781 –
Chapter 29 | DHCP Commands
DHCP Client
◆ This command is used to identify the vendor class and configuration of the
switch to the DHCP server, which then uses this information to decide on how
to service the client or the type of information to return.
◆ The general framework for this DHCP option is set out in RFC 2132 (Option 60).
This information is used to convey configuration settings or other identification
information about a client, but the specific string to use should be supplied by
your service provider or network administrator. Options 60, 66 and 67
statements can be added to the server daemon’s configuration file.
◆ By default, DHCP option 66/67 parameters are not carried in a DHCP server
reply. To ask for a DHCP reply with option 66/67 information, the DHCP client
request sent by this switch includes a “parameter request list” asking for this
information. Besides, the client request also includes a “vendor class identifier”
set by the ip dhcp client class-id command that allows the DHCP server to
identify the device, and select the appropriate configuration file for download.
This information is included in Option 55 and 124.
◆ The server should reply with Option 66 attributes, including the TFTP server
name and boot file name.
◆ Note that the vendor class identifier can be formatted in either text or
hexadecimal using the ip dhcp client class-id command, but the format used
by both the client and server must be the same.
Example
Console(config)#interface vlan 2
Console(config-if)#ip dhcp client class-id hex 0000e8666572
Console(config-if)#
Related Commands
ip dhcp restart client (783)
– 782 –
Chapter 29 | DHCP Commands
DHCP Client
Default Setting
None
Command Mode
Privileged Exec
Command Usage
◆ This command issues a DHCP client request for any IP interface that has been
set to DHCP mode through the ip address command.
◆ DHCP requires the server to reassign the client’s last address if available.
◆ If the DHCP server has been moved to a different domain, the network portion
of the address provided to the client will be based on this new domain.
Example
In the following example, the device is reassigned the same address.
Console(config)#interface vlan 1
Console(config-if)#ip address dhcp
Console(config-if)#exit
Console#ip dhcp restart client
Console#show ip interface
VLAN 1 is Administrative Up - Link Up
Address is 00-E0-00-00-00-01
Index: 1001, MTU: 1500
Address Mode is DHCP
IP Address: 192.168.0.2 Mask: 255.255.255.0
Proxy ARP is disabled
DHCP Client Vendor Class ID (text): ECS5520-18X
DHCP Relay Server:
Console#
Related Commands
ip address (808)
show ip dhcp This command shows the status of dynamic provision via DHCP.
dynamic-provision
Command Mode
Privileged Exec
Example
Console#show ip dhcp dynamic-provision
Dynamic Provision via DHCP Status: Disabled
Console#
– 783 –
Chapter 29 | DHCP Commands
DHCP Client
ipv6 dhcp client This command specifies the Rapid Commit option for DHCPv6 message exchange
rapid-commit vlan for all DHCPv6 client requests submitted from the specified interface. Use the no
form to disable this option.
Syntax
[no] ipv6 dhcp client rapid-commit vlan vlan-list
vlan-list - VLAN ID, specified as a single number, a range of consecutive
numbers separated by a hyphen, or multiple numbers separated by
commas. (Range: 1-4094; Maximum command length: 300 characters)
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ DHCPv6 clients can obtain configuration parameters from a server through a
normal four-message exchange (solicit, advertise, request, reply), or through a
rapid two-message exchange (solicit, reply). The rapid-commit option must be
enabled on both client and server for the two-message exchange to be used.
◆ If the rapid commit option has been enabled on the switch with this command,
and on the DHCPv6 server, message exchange can be reduced from the normal
four step process to a two-step exchange of only solicit and reply messages.
Example
Console(config)#ipv6 dhcp client rapid-commit vlan 2
Console(config)#
– 784 –
Chapter 29 | DHCP Commands
DHCP Client
Default Setting
None
Command Mode
Privileged Exec
Command Usage
◆ This command starts the DHCPv6 client process if it is not yet running by
submitting requests for configuration information through the specified
interface(s). When DHCPv6 is restarted, the switch may attempt to acquire an IP
address prefix through stateful address auto-configuration. If the router
advertisements have the “other stateful configuration” flag set, the switch may
also attempt to acquire other non-address configuration information (such as a
default gateway or DNS server) when DHCPv6 is restarted.
Prior to submitting a client request to a DHCPv6 server, the switch should be
configured with a link-local address using the ipv6 address autoconfig
command. The state of the Managed Address Configuration flag (M flag) and
Other Stateful Configuration flag (O flag) received in Router Advertisement
messages will determine the information this switch should attempt to acquire
from the DHCPv6 server as described below.
◆ If the rapid commit option has been enabled on the switch using the ipv6 dhcp
client rapid-commit vlan command, and on the DHCPv6 server, message
exchange can be reduced from the normal four step process to a two-step
exchange of only solicit and reply messages.
– 785 –
Chapter 29 | DHCP Commands
DHCP Client
Example
The following command submits a client request on VLAN 1.
Related Commands
ipv6 address autoconfig (823)
ipv6 dhcp This command enables dynamic provisioning via DHCPv6. Use the no form to
dynamic-provision disable this feature.
Syntax
[no] ipv6 dhcp dynamic-provision
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ DHCPD is the daemon used by Linux to dynamically configure TCP/IP
information for client systems. To support DHCPv6 options 59 and 60, you have
to add corresponding statements to the configuration file of DHCPD.
Information on how to complete this process are described in “Downloading a
Configuration File and Other Parameters from a DHCP Server” on page 65.
◆ The DHCPv6 options (59/60) for dynamic provision are described in RFC5970.
Example
In the following example enables DHCPv6 dynamic provisioning.
show ipv6 dhcp duid This command shows the DHCP Unique Identifier for this switch.
Command Mode
Privileged Exec
– 786 –
Chapter 29 | DHCP Commands
DHCP Client
Command Usage
DHCPv6 clients and servers are identified by a DHCP Unique Identifier (DUID)
included in the client identifier and server identifier options. Static or dynamic
address prefixes may be assigned by a DHCPv6 server based on the client’s DUID.
Example
Console#show ipv6 dhcp duid
DHCPv6 Unique Identifier (DUID): 0001-0001-4A8158B4-00E00C0000FD
Console#
show ipv6 dhcp vlan This command shows DHCPv6 information for the specified interface(s).
Syntax
show ipv6 dhcp vlan vlan-list
vlan-list - VLAN ID, specified as a single number, a range of consecutive
numbers separated by a hyphen, or multiple numbers separated by
commas. (Range: 1-4094; Maximum command length: 300 characters)
Command Mode
Privileged Exec
Command Usage
Each allocation in the DHCPv6 server is identified by a DUID and an IAID. IAID
means Interface Association Identifier, and is a binding between the interface and
one or more IP addresses.
Example
Console#show ipv6 dhcp vlan 1
VLAN 1 is in DHCP client mode, Rapid-Commit
IAID: C0000F0
List of known servers:
Server address : FE80::250:FCFF:FEF9:A494
DUID : 0001-0001-48CFB0D5-F48F2A006801
Related Commands
ipv6 address (821)
show ipv6 dhcp This command shows the status of dynamic provision via DHCPv6.
dynamic-provision
Command Mode
Privileged Exec
– 787 –
Chapter 29 | DHCP Commands
DHCP Relay
Example
Console#show ipv6 dhcp dynamic-provision
Dynamic Provision via DHCPv6 Status: Disabled
Console#
DHCP Relay
This section describes commands used to configure the switch to relay DHCP
requests from local hosts to a remote DHCP server.
ipv6 dhcp relay destination Specifies a DHCPv6 server or VLAN to which client requests IC
are forwarded and enables DHCPv6 relay service
show ipv6 dhcp relay Displays a DHCPv6 server or VLAN to which client requests PE
destination are forwarded
ip dhcp relay server This command specifies the DHCP server or relay server addresses to use.
Use the no form to clear all addresses.
Syntax
ip dhcp relay server address1 [address2 [address3 ...]]
no ip dhcp relay server
address - IP address of DHCP server. (Range: 1-5 addresses)
Default Setting
None
Command Mode
Interface Configuration (VLAN)
Usage Guidelines
◆ DHCP relay service applies to DHCP client requests received on the specified
VLAN.
◆ This command is used to configure DHCP relay for host devices attached to the
switch. If DHCP relay service is enabled, and this switch sees a DHCP client
– 788 –
Chapter 29 | DHCP Commands
DHCP Relay
request, it inserts its own IP address into the request so that the DHCP server
will know the subnet where the client is located. Then, the switch forwards the
packet to a DHCP server on another network. When the server receives the
DHCP request, it allocates a free IP address for the DHCP client from its defined
scope for the DHCP client’s subnet, and sends a DHCP response back to the
DHCP relay agent (i.e., this switch). This switch then passes the DHCP response
received from the server to the client.
◆ You must specify the IP address for at least one active DHCP server. Otherwise,
the switch’s DHCP relay agent will not be able to forward client requests to a
DHCP server. Up to five DHCP servers can be specified in order of preference.
If any of the specified DHCP server addresses are not located in the same
network segment with this switch, use the ip default-gateway or ipv6 default-
gateway command to specify the default router through which this switch can
reach other IP subnetworks.
◆ To start DHCP relay service, enter the ip dhcp restart relay command.
Example
Console(config)#interface vlan 1
Console(config-if)#ip dhcp relay server 192.168.10.19
Console(config-if)#
Related Commands
ip dhcp restart relay (789)
ip dhcp restart relay This command enables DHCP relay for the specified VLAN. Use the no form to
disable it.
Syntax
ip dhcp restart relay
Default Setting
Disabled
Command Mode
Privileged Exec
Command Usage
This command is used to configure DHCP relay functions for host devices attached
to the switch. If DHCP relay service is enabled, and this switch sees a DHCP request
broadcast, it inserts its own IP address into the request so the DHCP server will
know the subnet where the client is located. Then, the switch forwards the packet
to the DHCP server on another network. When the server receives the DHCP
request, it allocates a free IP address for the DHCP client from its defined scope for
the DHCP client’s subnet, and sends a DHCP response back to the DHCP relay agent
– 789 –
Chapter 29 | DHCP Commands
DHCP Relay
(i.e., this switch). This switch then broadcasts the DHCP response received from the
server to the client.
Example
In the following example, the device is reassigned the same address.
Related Commands
ip dhcp relay server (788)
ipv6 dhcp relay This command specifies a DHCPv6 server or the VLAN to which client requests are
destination forwarded, and also enables DHCPv6 relay service on this interface. Use the no
form to disable this service.
Syntax
ipv6 dhcp relay destination {ipv6-address | multicast {all | vlan vlan-id}}
no ipv6 dhcp relay destination [ipv6-address | multicast {all |
vlan vlan-id}]
ipv6-address - A full IPv6 address including the network prefix and host
address bits. This address may designate another relay server or a DHCPv6
server.
multicast - All DHCP server multicast address (FF:05::1:3).
all - Specifies all local VLAN interfaces.
vlan-id - ID of configured VLAN. (Range: 1-4094)
Default Setting
None
Command Mode
Interface Configuration (VLAN)
Usage Guidelines
◆ You must specify the IPv6 address for at least one DHCPv6 server or another
relay agent, or the VLAN to which to multicast a relay message. Otherwise, the
switch’s DHCPv6 relay agent will not forward client requests. This command
– 790 –
Chapter 29 | DHCP Commands
DHCP Relay
enables DHCPv6 relay service for the VLAN from which the command is
entered.
◆ This command is used to configure DHCPv6 relay functions for host devices
attached to the switch. If DHCPv6 relay service is enabled (by entering this
command), and this switch sees a DHCPv6 request broadcast, it inserts its own
IP address into the request so the DHCPv6 server will know the subnet where
the client is located. Then, the switch forwards the packet to the next relay
agent or DHCPv6 server on another network. When the server receives the
DHCPv6 request, it allocates a free IP address for the DHCPv6 client from its
defined scope for the DHCPv6 client’s subnet, and sends a DHCPv6 response
back to the DHCPv6 relay agent (i.e., this switch). This switch then broadcasts
the DHCPv6 response received from the server to the client.
◆ When the multicast option is used, the switch multicasts the modified client
request to all configured VLANs or to a specified VLAN, and enables DHCPv6
relay service for those VLANs.
◆ When issuing the no ipv6 dhcp relay destination command without any
arguments, the switch will delete all configured destination addresses and
disable DHCP for IPv6 relay for all VLANs.
EXAMPLE
Console(config)#interface vlan 1
Console(config-if)#ipv6 dhcp relay destination 2001:0DB8:3000:3000::42
Console(config-if)#
show ipv6 dhcp relay This command shows the destination addresses or VLAN to which client messages
destination are forwarded for DHCP relay service.
Syntax
show ipv6 dhcp relay destination interface [vlan vlan-id]
vlan-id - VLAN ID (Range: 1-4094)
Command Mode
Privileged Exec
Example
Console#show ipv6 dhcp relay destination interface vlan 1
DHCP relay destination :
VLAN 1 :
– 791 –
Chapter 29 | DHCP Commands
DHCP Server
Unicast : 2001:DB8:3000:3000::42
Console#
DHCP Server
This section describes commands used to configure client address pools for the
DHCP service.
ip dhcp excluded-address Specifies IP addresses that a DHCP server should not assign GC
to DHCP clients
clear ip dhcp binding Deletes an automatic address binding from the DHCP PE
server database
show ip dhcp binding Displays address bindings on the DHCP server PE, NE
– 792 –
Chapter 29 | DHCP Commands
DHCP Server
ip dhcp This command specifies IP addresses that the DHCP server should not assign to
excluded-address DHCP clients. Use the no form to remove the excluded IP addresses.
Syntax
[no] ip dhcp excluded-address low-address [high-address]
low-address - An excluded IP address, or the first IP address in an excluded
address range.
high-address - The last IP address in an excluded address range.
Default Setting
All IP pool addresses may be assigned.
Command Mode
Global Configuration
Example
Console(config)#ip dhcp excluded-address 10.1.0.19
Console(config)#
ip dhcp pool This command configures a DHCP address pool and enter DHCP Pool Configuration
mode. Use the no form to remove the address pool.
Syntax
[no] ip dhcp pool name
name - A string or integer. (Range: 1-32 characters)
Default Setting
DHCP address pools are not configured.
Command Mode
Global Configuration
Usage Guidelines
◆ After executing this command, the switch changes to DHCP Pool Configuration
mode, identified by the (config-dhcp)# prompt.
◆ From this mode, first configure address pools for the network interfaces (using
the network command). You can also manually bind an address to a specific
client (with the host command) if required. You can configure up to 8 network
address pools, and up to 32 manually bound host address pools (i.e., listing one
host address per pool). However, note that any address specified in a host
command must fall within the range of a configured network address pool.
– 793 –
Chapter 29 | DHCP Commands
DHCP Server
Example
Console(config)#ip dhcp pool R&D
Console(config-dhcp)#
Related Commands
network (801)
host (798)
service dhcp This command enables the DHCP server on this switch. Use the no form to disable
the DHCP server.
Syntax
[no] service dhcp
Default Setting
Enabled
Command Mode
Global Configuration
Command Usage
If the DHCP server is running, you must restart it to implement any configuration
changes.
Example
Console(config)#service dhcp
Console(config)#
bootfile This command specifies the name of the default boot image for a DHCP client. This
file should placed on the Trivial File Transfer Protocol (TFTP) server specified with
the next-server command. Use the no form to delete the boot image name.
Syntax
bootfile filename
no bootfile
filename - Name of the file that is used as a default boot image. (Range: 1 to
128 characters)
Default Setting
None
Command Mode
DHCP Pool Configuration
– 794 –
Chapter 29 | DHCP Commands
DHCP Server
Example
Console(config-dhcp)#bootfile wme.bat
Console(config-dhcp)#
Related Commands
next-server (802)
client-identifier This command specifies the client identifier of a DHCP client. Use the no form to
remove the client identifier.
Syntax
client-identifier {text text | hex hex}
no client-identifier
text - A text string. (Range: 1-32 characters)
hex - The hexadecimal value.
Default Setting
None
Command Mode
DHCP Pool Configuration
Command Usage
◆ This command identifies a DHCP client to bind to an address specified in the
host command. If both a client identifier and hardware address are configured
for a host address, the client identifier takes precedence over the hardware
address in the search procedure.
Example
Console(config-dhcp)#client-identifier text steve
Console(config-dhcp)#
Related Commands
host (798)
– 795 –
Chapter 29 | DHCP Commands
DHCP Server
default-router This command specifies default routers for a DHCP pool. Use the no form to remove
the default routers.
Syntax
default-router { address1 [address2] | bootfile filename}
no default-router
address1 - Specifies the IP address of the primary router.
address2 - Specifies the IP address of an alternate router.
bootfile filename - specifies the boot file name. (Range: 1-128 characters)
Default Setting
None
Command Mode
DHCP Pool Configuration
Usage Guidelines
The IP address of the router should be on the same subnet as the client. You can
specify up to two routers. Routers are listed in order of preference (starting with
address1 as the most preferred router).
Example
Console(config-dhcp)#default-router 10.1.0.54 10.1.0.64
Console(config-dhcp)#
dns-server This command specifies the Domain Name System (DNS) IP servers available to a
DHCP client. Use the no form to remove the DNS server list.
Syntax
dns-server address1 [address2]
no dns-server
address1 - Specifies the IP address of the primary DNS server.
address2 - Specifies the IP address of the alternate DNS server.
Default Setting
None
Command Mode
DHCP Pool Configuration
– 796 –
Chapter 29 | DHCP Commands
DHCP Server
Usage Guidelines
◆ If DNS IP servers are not configured for a DHCP client, the client cannot
correlate host names to IP addresses.
◆ Servers are listed in order of preference (starting with address1 as the most
preferred server).
Example
Console(config-dhcp)#dns-server 10.1.1.253 192.168.3.19
Console(config-dhcp)#
domain-name This command specifies the domain name for a DHCP client. Use the no form to
remove the domain name.
Syntax
domain-name domain
no domain-name
domain - Specifies the domain name of the client.
(Range: 1-128 characters)
Default Setting
None
Command Mode
DHCP Pool Configuration
Example
Console(config-dhcp)#domain-name sample.com
Console(config-dhcp)#
hardware-address This command specifies the hardware address of a DHCP client. This command is
valid for manual bindings only. Use the no form to remove the hardware address.
Syntax
hardware-address hardware-address type
no hardware-address
hardware-address - Specifies the MAC address of the client device.
type - Indicates the following protocol used on the client device:
• ethernet
• ieee802
– 797 –
Chapter 29 | DHCP Commands
DHCP Server
Default Setting
If no type is specified, the default protocol is Ethernet.
Command Mode
DHCP Pool Configuration
Command Usage
This command identifies a DHCP or BOOTP client to bind to an address specified in
the host command. BOOTP clients cannot transmit a client identifier. To bind an
address to a BOOTP client, you must associate a hardware address with the host
entry.
Example
Console(config-dhcp)#hardware-address 00-e0-29-94-34-28 ethernet
Console(config-dhcp)#
Related Commands
host (798)
host Use this command to specify the IP address and network mask to manually bind to
a DHCP client. Use the no form to remove the IP address for the client.
Syntax
host address [mask]
no host
address - Specifies the IP address of a client.
mask - Specifies the network mask of the client.
Default Setting
None
Command Mode
DHCP Pool Configuration
Usage Guidelines
◆ Host addresses must fall within the range specified for an existing network
pool.
◆ When a client request is received, the switch first checks for a network address
pool matching the gateway where the request originated (i.e., if the request
was forwarded by a relay server). If there is no gateway in the client request (i.e.,
the request was not forwarded by a relay server), the switch searches for a
network pool matching the interface through which the client request was
received. It then searches for a manually configured host address that falls
within the matching network pool.
– 798 –
Chapter 29 | DHCP Commands
DHCP Server
◆ When searching for a manual binding, the switch compares the client identifier
for DHCP clients, and then compares the hardware address for DHCP or BOOTP
clients.
◆ If no manual binding has been specified for a host entry with the client-
identifier or hardware-address commands, then the switch will assign an
address from the matching network pool.
◆ If the mask is unspecified, DHCP examines its address pools. If no mask is found
in the pool database, the Class A, B, or C natural mask is used (see page 801).
This command is valid for manual bindings only.
◆ The no host command only clears the address from the DHCP server database.
It does not cancel the IP address currently in use by the host.
Example
Console(config-dhcp)#host 10.1.0.21 255.255.255.0
Console(config-dhcp)#
Related Commands
client-identifier (795)
hardware-address (797)
lease This command configures the duration that an IP address is assigned to a DHCP
client. Use the no form to restore the default value.
Syntax
lease {days [hours] [minutes] | infinite}
no lease
days - Specifies the duration of the lease in numbers of days. (Range: 0-365)
hours - Specifies the number of hours in the lease. A days value must be
supplied before you can configure hours. (Range: 0-23)
minutes - Specifies the number of minutes in the lease. A days and hours
value must be supplied before you can configure minutes. (Range: 0-59)
infinite - Specifies that the lease time is unlimited. This option is normally
used for addresses manually bound to a BOOTP client via the host
command.
Default Setting
One day
Command Modes
DHCP Pool Configuration
– 799 –
Chapter 29 | DHCP Commands
DHCP Server
Example
The following example leases an address to clients using this pool for 7 days.
Console(config-dhcp)#lease 7
Console(config-dhcp)#
netbios-name-server This command configures NetBIOS Windows Internet Naming Service (WINS) name
servers that are available to Microsoft DHCP clients. Use the no form to remove the
NetBIOS name server list.
Syntax
netbios-name-server address1 [address2]
no netbios-name-server
address1 - Specifies IP address of primary NetBIOS WINS name server.
address2 - Specifies IP address of alternate NetBIOS WINS name server.
Default Setting
None
Command Mode
DHCP Pool Configuration
Usage Guidelines
Servers are listed in order of preference (starting with address1 as the most
preferred server).
Example
Console(config-dhcp)#netbios-name-server 10.1.0.33 10.1.0.34
Console(config-dhcp)#
Related Commands
netbios-node-type (800)
netbios-node-type This command configures the NetBIOS node type for Microsoft DHCP clients. Use
the no form to remove the NetBIOS node type.
Syntax
netbios-node-type type
no netbios-node-type
type - Specifies the NetBIOS node type:
– 800 –
Chapter 29 | DHCP Commands
DHCP Server
broadcast
hybrid (recommended)
mixed
peer-to-peer
Default Setting
None
Command Mode
DHCP Pool Configuration
Example
Console(config-dhcp)#netbios-node-type hybrid
Console(config-dhcp)#
Related Commands
netbios-name-server (800)
network This command configures the subnet number and mask for a DHCP address pool.
Use the no form to remove the subnet number and mask.
Syntax
network network-number [mask]
no network
network-number - The IP address of the DHCP address pool.
mask - The bit combination that identifies the network (or subnet) and the
host portion of the DHCP address pool.
Command Mode
DHCP Pool Configuration
Usage Guidelines
◆ When a client request is received, the switch first checks for a network address
pool matching the gateway where the request originated (i.e., if the request
was forwarded by a relay server). If there is no gateway in the client request (i.e.,
the request was not forwarded by a relay server), the switch searches for a
network pool matching the interface through which the client request was
received. It then searches for a manually configured host address that falls
within the matching network pool. If no manually configured host address is
found, it assigns an address from the matching network address pool. However,
if no matching address pool is found the request is ignored.
◆ This command is valid for DHCP network address pools only. If the mask is not
specified, the class A, B, or C natural mask is used. Subnet addresses are
– 801 –
Chapter 29 | DHCP Commands
DHCP Server
◆ The DHCP server assumes that all host addresses are available. You can exclude
subsets of the address space by using the ip dhcp excluded-address command.
Example
Console(config-dhcp)#network 10.1.0.0 255.255.255.0
Console(config-dhcp)#
next-server This command configures the next server in the boot process of a DHCP client. Use
the no form to remove the boot server list.
Syntax
[no] next-server address
address - Specifies the IP address of the next server in the boot process,
which is typically a Trivial File Transfer Protocol (TFTP) server.
Default Setting
None
Command Mode
DHCP Pool Configuration
Example
Console(config-dhcp)#next-server 10.1.0.21
Console(config-dhcp)#
Related Commands
bootfile (794)
– 802 –
Chapter 29 | DHCP Commands
DHCP Server
option Use this command to enable DHCP options. Use the no form of the command to
disable DHCP options.
Syntax
option code {ascii word | hex hex-value | ip-address address1[address2
[address3[ address 4]]]}
code - A DHCP option code (Range: 0-254).
ascii word - ASCII character string representing a network device (Range: 1-
48 ASCII characters).
hex hex-value - A concatenated hex number string of up to 4 IPv4
addresses in hex format each representing a network device.
ip-address address - up to 4 IPv4 addresses can be entered sequentially
with blank spaces between. Each address represents a device in the
network.
Default:
Disabled
Command Mode:
DHCP Pool Configuration
Command Usage:
To convert IPv4 address to a hex number string, each octet of the address is
individually converted to hex and then all four hex values obtained concatenated.
Take for example the address 192.168.2.1, 192=c016, 168=a816, 2=0216, and 1=0116
resulting in c0a8020116 as the hex value for the IPv4 address.
Example
In this example network devices 192.168.2.1 and 192.168.3.1 are entered in hex
format using the option command.
clear ip dhcp binding This command deletes an automatic address binding from the DHCP server
database.
Syntax
clear ip dhcp binding [address]
address - The address of the binding to clear.
Default Setting
None
– 803 –
Chapter 29 | DHCP Commands
DHCP Server
Command Mode
Privileged Exec
Usage Guidelines
◆ An address specifies the client’s IP address. If no ip address is specified, the
DHCP server clears all automatic bindings.
◆ This command is normally used after modifying the address pool, or after
moving DHCP service to another device.
Example.
Console#clear ip dhcp binding
Console
Related Commands
show ip dhcp binding (804)
show ip dhcp binding This command displays address bindings on the DHCP server.
Syntax
show ip dhcp binding [address]
address - Specifies the IP address of the DHCP client for which bindings will
be displayed.
Default Setting
None
Command Mode
Normal Exec, Privileged Exec
Example
Console#show ip dhcp binding
Total entries : 1
Console#
– 804 –
Chapter 29 | DHCP Commands
DHCP Server
show ip dhcp This command displays DHCP address pools configured on the switch.
Command Mode
Privileged Exec
Example
Console#show ip dhcp
Total entry : 1
Console#
show ip dhcp pool This command displays the detailed configuration information of DHCP address
pools on the switch.
Command Mode
Privileged Exec
Example
Console#show ip dhcp pool
Pool name : officea
Pool type : Network
Network address : 192.168.3.1
Boot file :
Client identifier mode : Hex
Client identifier :
Default router : 10.2.3.4
0.0.0.0
DNS server : 192.168.4.4
0.0.0.0
Domain name : officeA
Hardware type : None
Hardware address : 00-00-00-00-00-00
Lease time : 1 d/ 0 h/ 0 m
Netbios name server : 0.0.0.0
0.0.0.0
Netbios node type : Hybrid
Next server : 192.168.5.1
Console#
– 805 –
Chapter 29 | DHCP Commands
DHCP Server
– 806 –
30 IP Interface Commands
An IP Version 4 and Version 6 address may be used for management access to the
switch over the network. Both IPv4 or IPv6 addresses can be used simultaneously to
access the switch. You can manually configure a specific IPv4 or IPv6 address or
direct the switch to obtain an IPv4 address from a BOOTP or DHCP server when it is
powered on. An IPv6 address can either be manually configured or dynamically
generated.
The IPv4 address for VLAN 1 on this switch is set to 192.168.2.10 by default. You may
also need to a establish an IPv4 or IPv6 default gateway between this device and
management stations that exist on another network segment.
ND Snooping Maintains IPv6 prefix table and user address binding table which can be
used for stateless address auto-configuration or for address filtering by
IPv6 Source Guard
IPv4 Interface
An initial IPv4 address of 192.168.2.10 is assigned to VLAN 1 on this switch by
default. If this address is not suitable, you can manually configure a new address to
manage the switch over your network or to connect the switch to existing IP
subnets. You may also need to a establish a default gateway between this device
and management stations or other devices that exist on another network segment
(if routing is not enabled).
Basic IPv4 Configuration Configures the IP address for interfaces and the gateway router
– 807 –
Chapter 30 | IP Interface Commands
IPv4 Interface
Basic IPv4 Configuration This section describes commands used to configure IP addresses for VLAN
interfaces on the switch.
ip default-gateway Defines the default gateway through which this switch can GC
reach other subnetworks
show ip traffic Displays statistics for IP, ICMP, UDP, TCP and ARP protocols PE
ping Sends ICMP echo request packets to another node on the NE, PE
network
ip address This command sets the IPv4 address for the currently selected VLAN interface. Use
the no form to remove an IP address.
Syntax
ip address {ip-address netmask [secondary]
[default-gateway ip-address] | bootp | dhcp}
no ip address [ip-address netmask [secondary] | dhcp]
ip-address - IP address
netmask - Network mask for the associated IP subnet. This mask identifies
the host address bits used for routing to specific subnets. The network
mask can use either the traditional format xxx.xxx.xxx.xxx or classless
format with the range /5 to /32. For example the subnet 255.255.224.0
would be /19.
secondary - Specifies a secondary IP address.
default-gateway - The default gateway. (Refer to the ip default-gateway
command which provides the same function.)
bootp - Obtains IP address from BOOTP.
dhcp - Obtains IP address from DHCP.
Default Setting
192.168.2.10/24
Command Mode
Interface Configuration (VLAN)
– 808 –
Chapter 30 | IP Interface Commands
IPv4 Interface
Command Usage
◆ Before any network interfaces are configured on the router, first create a VLAN
for each unique user group, or for each network application and its associated
users. Then assign the ports associated with each of these VLANs.
◆ An interface can have only one primary IP address, but can have many
secondary IP addresses. In other words, secondary addresses need to be
specified if more than one IP subnet can be accessed through this interface.
Note that a secondary address cannot be configured prior to setting the
primary IP address, and the primary address cannot be removed if a secondary
address is still present. Also, if any router/switch in a network segment uses a
secondary address, all other routers/switches in that segment must also use a
secondary address from the same network or subnet address space.
◆ If bootp or dhcp options are selected, the system will immediately start
broadcasting service requests for all VLANs configured to obtain address
assignments through BOOTP or DHCP. IP is enabled but will not function until a
BOOTP or DHCP reply has been received. Requests are broadcast periodically
by the router in an effort to learn its IP address. (BOOTP and DHCP values can
include the IP address, default gateway, and subnet mask). If the DHCP/BOOTP
server is slow to respond, you may need to use the ip dhcp restart client
command to re-start broadcasting service requests, or reboot the switch.
Note: Each VLAN group can be assigned its own IP interface address. You can
manage the switch via any of these IP addresses.
Example
In the following example, the device is assigned an address in VLAN 1.
Console(config)#interface vlan 1
Console(config-if)#ip address 192.168.1.5 255.255.255.0
Console(config-if)#
Console(config)#interface vlan 2
Console(config-if)#ip address 10.2.2.1/24
Console(config-if)#
– 809 –
Chapter 30 | IP Interface Commands
IPv4 Interface
Related Commands
ip dhcp restart client (783)
ip default-gateway (810)
ipv6 address (821)
ip default-gateway This command specifies the default gateway for destinations not found in local
routing tables. Use the no form to remove a default gateway.
Syntax
ip default-gateway gateway
no ip default-gateway
gateway - IP address of the default gateway
Default Setting
No default gateway is established.
Command Mode
Global Configuration
Command Usage
◆ The default gateway can also be defined using the following Global
configuration command: ip route 0.0.0.0 0.0.0.0 gateway-address.
◆ Static routes can also be defined using the ip route command to ensure that
traffic to the designated address or subnet passes through a preferred gateway.
◆ A default gateway can only be successfully set when a network interface that
directly connects to the gateway has been configured on the router.
Example
The following example defines a default gateway for this device:
– 810 –
Chapter 30 | IP Interface Commands
IPv4 Interface
Related Commands
ip address (808)
ip route (866)
ipv6 default-gateway (820)
Syntax
Command Mode
Privileged Exec
Example
Console#show ip interface
VLAN 1 is Administrative Up - Link Up
Address is CC-37-AB-BC-4F-FA
Index: 1001, MTU: 1500
Address Mode is User specified
IP Address: 192.168.2.98 Mask: 255.255.255.0
Proxy ARP is disabled
DHCP Relay Server:
VLAN 200 is Administrative Up - Link Down
Address is CC-37-AB-BC-4F-FA
Index: 1200, MTU: 1500
Address Mode is not specified
Proxy ARP is disabled
DHCP Client Vendor Class ID (text): ECS5520-18X
DHCP Relay Server:
Console#
Related Commands
ip address (808)
show ipv6 interface (830)
– 811 –
Chapter 30 | IP Interface Commands
IPv4 Interface
show ip traffic This command displays statistics for IP, ICMP, UDP, TCP and ARP protocols.
Command Mode
Privileged Exec
Example
Console#show ip traffic
IP Statistics:
IP received
7845 total received
header errors
unknown protocols
address errors
discards
7845 delivers
reassembly request datagrams
reassembly succeeded
reassembly failed
IP sent
forwards datagrams
9903 requests
discards
no routes
generated fragments
fragment succeeded
fragment failed
ICMP Statistics:
ICMP received
input
errors
destination unreachable messages
time exceeded messages
parameter problem message
echo request messages
echo reply messages
redirect messages
timestamp request messages
timestamp reply messages
source quench messages
address mask request messages
address mask reply messages
ICMP sent
output
errors
destination unreachable messages
time exceeded messages
parameter problem message
echo request messages
echo reply messages
redirect messages
timestamp request messages
timestamp reply messages
source quench messages
address mask request messages
address mask reply messages
UDP Statistics:
input
no port errors
other errors
output
TCP Statistics:
7841 input
– 812 –
Chapter 30 | IP Interface Commands
IPv4 Interface
input errors
9897 output
Console#
traceroute This command shows the route packets take to the specified destination.
Syntax
traceroute host
host - IP address or alias of the host.
Default Setting
None
Command Mode
Privileged Exec
Command Usage
◆ Use the traceroute command to determine the path taken to reach a specified
destination.
◆ The traceroute command first sends probe datagrams with the TTL value set at
one. This causes the first router to discard the datagram and return an error
message. The trace function then sends several probe messages at each
subsequent TTL level and displays the round-trip time for each message. Not all
devices respond correctly to probes by returning an “ICMP port unreachable”
message. If the timer goes off before a response is returned, the trace function
prints a series of asterisks and the “Request Timed Out” message. A long
sequence of these messages, terminating only when the maximum timeout
has been reached, may indicate this problem with the target device.
◆ If the target device does not respond or other errors are detected, the switch
will indicate this by one of the following messages:
■ * - No Response
■ H - Host Unreachable
■ N - Network Unreachable
■ P - Protocol Unreachable
■ O -Other
– 813 –
Chapter 30 | IP Interface Commands
IPv4 Interface
Example
Console#traceroute 192.168.0.99
Press "ESC" to abort.
Traceroute to 192.168.0.99, 30 hops max, timeout is 3 seconds
Hop Packet 1 Packet 2 Packet 3 IP Address
--- -------- -------- -------- ---------------
1 20 ms <10 ms <10 ms 192.168.0.99
Trace completed.
Console#
ping This command sends (IPv4) ICMP echo request packets to another node on the
network.
Syntax
ping host [count count] [size size]
host - IP address or alias of the host.
count - Number of packets to send. (Range: 1-16)
size - Number of bytes in a packet. (Range: 32-512)
The actual packet size will be eight bytes larger than the size specified
because the switch adds header information.
Default Setting
count: 5
size: 32 bytes
Command Mode
Normal Exec, Privileged Exec
Command Usage
◆ Use the ping command to see if another site on the network can be reached.
■ Destination does not respond - If the host does not respond, a “timeout”
appears in ten seconds.
– 814 –
Chapter 30 | IP Interface Commands
IPv4 Interface
◆ When pinging a host name, be sure the DNS server has been defined
(page 773) and host name-to-address translation enabled (page 771). If
necessary, local devices can also be specified in the DNS static host table
(page 772).
Example
Console#ping 10.1.0.9
Press ESC to abort.
PING to 10.1.0.9, by 5 32-byte payload ICMP packets, timeout is 5 seconds
response time: 10 ms
response time: 10 ms
response time: 10 ms
response time: 10 ms
response time: 0 ms
Ping statistics for 10.1.0.9:
5 packets transmitted, 5 packets received (100%), 0 packets lost (0%)
Approximate round trip times:
Minimum = 0 ms, Maximum = 10 ms, Average = 8 ms
Console#
Related Commands
interface (397)
ARP Configuration This section describes commands used to configure the Address Resolution
Protocol (ARP) on the switch.
arp timeout Sets the time a dynamic entry remains in the ARP cache GC
arp This command adds a static entry in the Address Resolution Protocol (ARP) cache.
Use the no form to remove an entry from the cache.
Syntax
arp ip-address hardware-address
no arp ip-address
ip-address - IP address to map to a specified hardware address.
hardware-address - Hardware address to map to a specified IP address. (The
format for this address is xx-xx-xx-xx-xx-xx or xxxxxxxxxxxx.)
– 815 –
Chapter 30 | IP Interface Commands
IPv4 Interface
Default Setting
No default entries
Command Mode
Global Configuration
Command Usage
◆ The ARP cache is used to map 32-bit IP addresses into 48-bit hardware (i.e.,
Media Access Control) addresses. This cache includes entries for hosts and
other routers on local network interfaces defined on this router.
◆ The maximum number of static entries allowed in the ARP cache is 128.
◆ You may need to put a static entry in the cache if there is no response to an ARP
broadcast message. For example, some applications may not respond to ARP
requests or the response arrives too late, causing network operations to time
out.
◆ Static entries will not be aged out nor deleted when power is reset. A static
entry can only be removed through the configuration interface.
Example
Console(config)#arp 10.1.0.19 01-02-03-04-05-06
Console(config)#
Related Commands
clear arp-cache (818)
show arp (818)
arp timeout This command sets the aging time for dynamic entries in the Address Resolution
Protocol (ARP) cache. Use the no form to restore the default timeout.
Syntax
arp timeout seconds
no arp timeout
seconds - The time a dynamic entry remains in the ARP cache.
(Range: 300-86400; 86400 seconds is one day)
Default Setting
1200 seconds (20 minutes)
Command Mode
Global Configuration
– 816 –
Chapter 30 | IP Interface Commands
IPv4 Interface
Command Usage
◆ When a ARP entry expires, it is deleted from the cache and an ARP request
packet is sent to re-establish the MAC address.
◆ The aging time determines how long dynamic entries remain in the cache. If
the timeout is too short, the router may tie up resources by repeating ARP
requests for addresses recently flushed from the table.
Example
This example sets the ARP cache timeout for 15 minutes (i.e., 900 seconds).
ip proxy-arp This command enables proxy Address Resolution Protocol (ARP). Use the no form
to disable proxy ARP.
Syntax
[no] ip proxy-arp
Default Setting
Disabled
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ Proxy ARP allows a non-routing device to determine the MAC address of a host
on another subnet or network.
◆ End stations that require Proxy ARP must view the entire network as a single
network. These nodes must therefore use a smaller subnet mask than that used
by the router or other relevant network devices.
◆ Extensive use of Proxy ARP can degrade router performance because it may
lead to increased ARP traffic and increased search time for larger ARP address
tables.
Example
Console(config)#interface vlan 3
Console(config-if)#ip proxy-arp
Console(config-if)#
– 817 –
Chapter 30 | IP Interface Commands
IPv4 Interface
clear arp-cache This command deletes all dynamic entries from the Address Resolution Protocol
(ARP) cache.
Command Mode
Privileged Exec
Example
This example clears all dynamic entries in the ARP cache.
Console#clear arp-cache
This operation will delete all the dynamic entries in ARP Cache.
Do you want to continue this operation (y/n)?
Console#
show arp This command displays entries in the Address Resolution Protocol (ARP) cache.
Command Mode
Privileged Exec
Command Usage
◆ This command displays information about the ARP cache. The first line shows
the cache timeout. It also shows each cache entry, including the IP address,
MAC address, type (static, dynamic, other), and VLAN interface. Note that entry
type “other” indicates local addresses for this router.
◆ Static entries are only displayed for VLANs that are up. In other words, static
entries are only displayed when configured for the IP subnet of a existing VLAN,
and that VLAN is linked up.
Example
This example displays all entries in the ARP cache.
Console#show arp
ARP Cache Timeout: 1200 (seconds)
Total entry : 4
Console#
– 818 –
Chapter 30 | IP Interface Commands
IPv6 Interface
IPv6 Interface
This switch supports the following IPv6 interface commands.
ipv6 default-gateway Sets an IPv6 default gateway for traffic with no known next GC
hop
ipv6 address eui-64 Configures an IPv6 global unicast address for an interface IC
using an EUI-64 interface ID in the low order 64 bits, and
enables IPv6 on the interface
ipv6 address link-local Configures an IPv6 link-local address for an interface and IC
enables IPv6 on the interface
ipv6 enable Enables IPv6 on an interface that has not been configured IC
with an explicit IPv6 address
ipv6 mtu Sets the size of the maximum transmission unit (MTU) for IC
IPv6 packets sent on an interface
show ipv6 interface Displays the usability and configured settings for IPv6 PE
interfaces
show ipv6 mtu Displays maximum transmission unit (MTU) information for PE
IPv6 interfaces
ping6 Sends IPv6 ICMP echo request packets to another node on NE, PE
the network
Neighbor Discovery
– 819 –
Chapter 30 | IP Interface Commands
IPv6 Interface
ipv6 nd reachable-time Configures the amount of time that a remote IPv6 node is IC
considered reachable after some reachability confirmation
event has occurred
clear ipv6 neighbors Deletes all dynamic entries in the IPv6 neighbor discovery PE
cache
show ipv6 neighbors Displays information in the IPv6 neighbor discovery cache PE
show ipv6 nd prefix Displays IPv6 neighbor discovery prefixes for a VLAN PE
ipv6 default-gateway This command sets an IPv6 default gateway to use for destinations with no known
next hop. Use the no form to remove a previously configured default gateway.
Syntax
ipv6 default-gateway ipv6-address
no ipv6 default-gateway
ipv6-address - The IPv6 address of the default next hop router to use for
destinations with no known next hop.
Default Setting
No default gateway is defined
Command Mode
Global Configuration
– 820 –
Chapter 30 | IP Interface Commands
IPv6 Interface
Command Usage
◆ All IPv6 addresses must be according to RFC 2373 “IPv6 Addressing
Architecture,” using 8 colon-separated 16-bit hexadecimal values. One double
colon may be used in the address to indicate the appropriate number of zeros
required to fill the undefined fields.
◆ An IPv6 default gateway should be defined if the destination has been assigned
an IPv6 address that is located in a different IP segment.
◆ An IPv6 default gateway can only be successfully set when a network interface
that directly connects to the gateway has been configured on the switch.
Example
The following example defines a default gateway for this device:
Related Commands
ip default-gateway (810)
ipv6 address This command configures an IPv6 global unicast address and enables IPv6 on an
interface. Use the no form without any arguments to remove all IPv6 addresses
from the interface, or use the no form with a specific IPv6 address to remove that
address from the interface.
Syntax
[no] ipv6 address ipv6-address[/prefix-length]
ipv6-address - A full IPv6 address including the network prefix and host
address bits.
prefix-length - A decimal value indicating how many contiguous bits (from
the left) of the address comprise the prefix (i.e., the network portion of the
address).
Default Setting
No IPv6 addresses are defined
Command Mode
Interface Configuration (VLAN)
– 821 –
Chapter 30 | IP Interface Commands
IPv6 Interface
Command Usage
◆ All IPv6 addresses must be according to RFC 2373 “IPv6 Addressing
Architecture,” using 8 colon-separated 16-bit hexadecimal values. One double
colon may be used in the address to indicate the appropriate number of zeros
required to fill the undefined fields.
◆ If a link-local address has not yet been assigned to this interface, this command
will assign the specified static global unicast address and also dynamically
generate a link-local unicast address for the interface. (The link-local address is
made with an address prefix of FE80 and a host portion based the switch’s MAC
address in modified EUI-64 format.)
Example
This example specifies a full IPv6 address and prefix length.
Console(config)#interface vlan 1
Console(config-if)#ipv6 address 2001:DB8:2222:7272::72/96
Console(config-if)#end
Console#show ipv6 interface
VLAN 1 is up
IPv6 is enabled
Link-local address:
fe80::7272:cfff:fe83:3466%1/64
Global unicast address(es):
2001:db8:2222:7272::72/96, subnet is 2001:db8:2222:7272::/96
Joined group address(es):
ff02::1:ff00:72
ff02::1:ff83:3466
ff02::1
IPv6 link MTU is 1500 bytes
ND DAD is enabled, number of DAD attempts: 3.
ND retransmit interval is 1000 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised router lifetime is 1800 seconds
Console#
Related Commands
ipv6 address eui-64 (825)
ipv6 address autoconfig (823)
show ipv6 interface (830)
ip address (808)
– 822 –
Chapter 30 | IP Interface Commands
IPv6 Interface
Syntax
[no] ipv6 address autoconfig
Default Setting
No IPv6 addresses are defined
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ If a link local address has not yet been assigned to this interface, this command
will dynamically generate a global unicast address (if a global prefix is included
in received router advertisements) and a link local address for the interface.
(The link-local address is made with an address prefix of FE80 and a host
portion based the switch’s MAC address in modified EUI-64 format.)
Example
This example assigns a dynamic global unicast address of to the switch.
– 823 –
Chapter 30 | IP Interface Commands
IPv6 Interface
Console#
Related Commands
ipv6 address (821)
show ipv6 interface (830)
ipv6 address dhcp This command enables IPv6 DHCP client functionality on an interface so that it can
acquire a stateful IPv6 address. Use the no form of the command to disabled the
IPv6 DHCP client.
Syntax
ipv6 address dhcp
no ipv6 address dhcp
Default Setting
Disabled
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ Once enabled on any interface, the interface will have the ability to have a
stateful IPv6 address assigned to it dynamically using the DHCPv6 protocol.
◆ If IPv6 router advertisements are enabled and this command is configured, the
IPv6 dhcp client will fail to be enabled on the interface.
Example
Console(config)#interface vlan 1
Console(config-if)#ipv6 address dhcp
Console(config-if)#
Related Commands
ipv6 address eui-64 (825)
ipv6 address link-local (827)
show ipv6 interface (830)
– 824 –
Chapter 30 | IP Interface Commands
IPv6 Interface
ipv6 address eui-64 This command configures an IPv6 address for an interface using an EUI-64 interface
ID in the low order 64 bits and enables IPv6 on the interface. Use the no form
without any arguments to remove all manually configured IPv6 addresses from the
interface. Use the no form with a specific address to remove it from the interface.
Syntax
ipv6 address ipv6-prefix/prefix-length eui-64
no ipv6 address [ipv6-prefix/prefix-length eui-64]
ipv6-prefix - The IPv6 network portion of the address assigned to the
interface.
prefix-length - A decimal value indicating how many contiguous bits (from
the left) of the address comprise the prefix (i.e., the network portion of the
address).
Default Setting
No IPv6 addresses are defined
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ The prefix must be formatted according to RFC 2373 “IPv6 Addressing
Architecture,” using 8 colon-separated 16-bit hexadecimal values. One double
colon may be used in the address to indicate the appropriate number of zeros
required to fill the undefined fields.
◆ If a link local address has not yet been assigned to this interface, this command
will dynamically generate a global unicast address and a link-local address for
this interface. (The link-local address is made with an address prefix of FE80 and
a host portion based the switch’s MAC address in modified EUI-64 format.)
◆ Note that the value specified in the ipv6-prefix may include some of the high-
order host bits if the specified prefix length is less than 64 bits. If the specified
prefix length exceeds 64 bits, then the network portion of the address will take
precedence over the interface identifier.
◆ IPv6 addresses are 16 bytes long, of which the bottom 8 bytes typically form a
unique host identifier based on the device’s MAC address. The EUI-64
specification is designed for devices that use an extended 8-byte MAC address.
For devices that still use a 6-byte MAC address (also known as EUI-48 format), it
must be converted into EUI-64 format by inverting the universal/local bit in the
address and inserting the hexadecimal number FFFE between the upper and
lower three bytes of the MAC address.
– 825 –
Chapter 30 | IP Interface Commands
IPv6 Interface
◆ This host addressing method allows the same interface identifier to be used on
multiple IP interfaces of a single device, as long as those interfaces are attached
to different subnets.
Example
This example uses the network prefix of 2001:0DB8:0:1::/64, and specifies that the
EUI-64 interface identifier be used in the lower 64 bits of the address.
Console(config)#interface vlan 1
Console(config-if)#ipv6 address 2001:0DB8:0:1::/64 eui-64
Console(config-if)#end
Console#show ipv6 interface
VLAN 1 is up
IPv6 is enabled
Link-local address:
fe80::7272:cfff:fe83:3466%1/64
Global unicast address(es):
2001:db8:0:1:7272:cfff:fe83:3466/64, subnet is 2001:db8:0:1::/64[EUI]
2001:db8:2222:7272::72/96, subnet is 2001:db8:2222:7272::/96
Joined group address(es):
ff02::1:ff00:72
ff02::1:ff83:3466
ff02::1
IPv6 link MTU is 1500 bytes
ND DAD is enabled, number of DAD attempts: 3.
ND retransmit interval is 1000 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised router lifetime is 1800 seconds
Console#
Related Commands
ipv6 address autoconfig (823)
show ipv6 interface (830)
– 826 –
Chapter 30 | IP Interface Commands
IPv6 Interface
ipv6 address link-local This command configures an IPv6 link-local address for an interface and enables
IPv6 on the interface. Use the no form without any arguments to remove all
manually configured IPv6 addresses from the interface. Use the no form with a
specific address to remove it from the interface.
Syntax
ipv6 address ipv6-address link-local
no ipv6 address [ipv6-address link-local]
ipv6-address - The IPv6 address assigned to the interface.
Default Setting
No IPv6 addresses are defined
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ The specified address must be formatted according to RFC 2373 “IPv6
Addressing Architecture,” using 8 colon-separated 16-bit hexadecimal values.
One double colon may be used in the address to indicate the appropriate
number of zeros required to fill the undefined fields. And the address prefix
must be in the range of FE80~FEBF.
◆ The address specified with this command replaces a link-local address that was
automatically generated for the interface.
◆ You can configure multiple IPv6 global unicast addresses per interface, but only
one link-local address per interface.
Example
This example assigns a link-local address of FE80::269:3EF9:FE19:6779 to VLAN 1.
Note that a prefix in the range of FE80~FEBF is required for link-local addresses, and
the first 16-bit group in the host address is padded with a zero in the form 0269.
Console(config)#interface vlan 1
Console(config-if)#ipv6 address FE80::269:3EF9:FE19:6779 link-local
Console(config-if)#end
Console#show ipv6 interface
VLAN 1 is up
IPv6 is enabled
Link-local address:
fe80::269:3ef9:fe19:6779%1/64
Global unicast address(es):
2001:db8:0:1:7272:cfff:fe83:3466/64, subnet is 2001:db8:0:1::/64[EUI]
2001:db8:2222:7272::72/96, subnet is 2001:db8:2222:7272::/96
Joined group address(es):
ff02::1:ff19:6779
ff02::1:ff00:72
ff02::1:ff83:3466
– 827 –
Chapter 30 | IP Interface Commands
IPv6 Interface
ff02::1
IPv6 link MTU is 1500 bytes
ND DAD is enabled, number of DAD attempts: 3.
ND retransmit interval is 1000 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised router lifetime is 1800 seconds
Console#
Related Commands
ipv6 enable (828)
show ipv6 interface (830)
ipv6 enable This command enables IPv6 on an interface that has not been configured with an
explicit IPv6 address. Use the no form to disable IPv6 on an interface that has not
been configured with an explicit IPv6 address.
Syntax
[no] ipv6 enable
Default Setting
IPv6 is disabled
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ This command enables IPv6 on the current VLAN interface and automatically
generates a link-local unicast address. The address prefix uses FE80, and the
host portion of the address is generated by converting the switch’s MAC
address to modified EUI-64 format (see page 825). This address type makes the
switch accessible over IPv6 for all devices attached to the same local subnet.
◆ The no ipv6 enable command does not disable IPv6 for an interface that has
been explicitly configured with an IPv6 address.
Example
In this example, IPv6 is enabled on VLAN 1, and the link-local address
FE80::2E0:CFF:FE00:FD/64 is automatically generated by the switch.
Console(config)#interface vlan 1
Console(config-if)#ipv6 enable
Console(config-if)#end
Console#show ipv6 interface
VLAN 1 is up
– 828 –
Chapter 30 | IP Interface Commands
IPv6 Interface
IPv6 is enabled
Link-local address:
fe80::269:3ef9:fe19:6779%1/64
Global unicast address(es):
2001:db8:0:1:7272:cfff:fe83:3466/64, subnet is 2001:db8:0:1::/64[EUI]
2001:db8:2222:7272::72/96, subnet is 2001:db8:2222:7272::/96
Joined group address(es):
ff02::1:ff19:6779
ff02::1:ff00:72
ff02::1:ff83:3466
ff02::1
IPv6 link MTU is 1500 bytes
ND DAD is enabled, number of DAD attempts: 3.
ND retransmit interval is 1000 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised router lifetime is 1800 seconds
Console#
Related Commands
ipv6 address link-local (827)
show ipv6 interface (830)
ipv6 mtu This command sets the size of the maximum transmission unit (MTU) for IPv6
packets sent on an interface. Use the no form to restore the default setting.
Syntax
ipv6 mtu size
no ipv6 mtu
size - Specifies the MTU size. (Range: 1280-65535 bytes)
Default Setting
1500 bytes
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ If a non-default value is configured, an MTU option is included in the router
advertisements sent from this device.
◆ The maximum value set by this command cannot exceed the MTU of the
physical interface, which is currently fixed at 1500 bytes.
◆ IPv6 routers do not fragment IPv6 packets forwarded from other routers.
However, traffic originating from an end-station connected to an IPv6 router
may be fragmented.
– 829 –
Chapter 30 | IP Interface Commands
IPv6 Interface
◆ All devices on the same physical medium must use the same MTU in order to
operate correctly.
Example
The following example sets the MTU for VLAN 1 to 1280 bytes:
Console(config)#interface vlan 1
Console(config-if)#ipv6 mtu 1280
Console(config-if)#
Related Commands
show ipv6 mtu (832)
jumbo frame (115)
show ipv6 interface This command displays the usability and configured settings for IPv6 interfaces.
Syntax
show ipv6 interface [brief [vlan vlan-id [ipv6-prefix/prefix-length]]]
brief - Displays a brief summary of IPv6 operational status and the
addresses configured for each interface.
vlan-id - VLAN ID (Range: 1-4094)
ipv6-prefix - The IPv6 network portion of the address assigned to the
interface. The prefix must be formatted according to RFC 2373 “IPv6
Addressing Architecture,” using 8 colon-separated 16-bit hexadecimal
values. One double colon may be used in the address to indicate the
appropriate number of zeros required to fill the undefined fields.
prefix-length - A decimal value indicating how many of the contiguous bits
(from the left) of the address comprise the prefix (i.e., the network portion
of the address).
Command Mode
Privileged Exec
Example
This example displays all the IPv6 addresses configured for the switch.
– 830 –
Chapter 30 | IP Interface Commands
IPv6 Interface
FF01::1/16
FF02::1/16
FF02::1:FF00:1/104
FF02::1:FF11:6770/104
FF02::1:FF32:2120/104
VLAN A VLAN is marked “up” if the switch can send and receive packets on this interface,
“down” if a line signal is not present, or “administratively down” if the interface has
been disabled by the administrator.
IPv6 IPv6 is marked “enable” if the switch can send and receive IP traffic on this
interface, “disable” if the switch cannot send and receive IP traffic on this interface,
or “stalled” if a duplicate link-local address is detected on the interface.
Global unicast Shows the global unicast address(es) assigned to this interface
address(es)
Joined group In addition to the unicast addresses assigned to an interface, a node is required to
address(es) join the all-nodes multicast addresses FF01::1 and FF02::1 for all IPv6 nodes within
scope 1 (interface-local) and scope 2 (link-local), respectively.
FF01::1/16 is the transient interface-local multicast address for all attached IPv6
nodes, and FF02::1/16 is the link-local multicast address for all attached IPv6
nodes. The interface-local multicast address is only used for loopback
transmission of multicast traffic. Link-local multicast addresses cover the same
types as used by link-local unicast addresses, including all nodes (FF02::1), all
routers (FF02::2), and solicited nodes (FF02::1:FFXX:XXXX) as described below.
A node is also required to compute and join the associated solicited-node
multicast addresses for every unicast and anycast address it is assigned. IPv6
addresses that differ only in the high-order bits, e.g. due to multiple high-order
prefixes associated with different aggregations, will map to the same solicited-
node address, thereby reducing the number of multicast addresses a node must
join. In this example, FF02::1:FF90:0/104 is the solicited-node multicast address
which is formed by taking the low-order 24 bits of the address and appending
those bits to the prefix.
IPv6 Link MTU Maximum transmission unit for this interface (bytes).
ND advertised The retransmit interval is included in all router advertisements sent out of an
retransmit interface so that nodes on the same link use the same time value.
interval
ND reachable The amount of time a remote IPv6 node is considered reachable after a
time reachability confirmation event has occurred
– 831 –
Chapter 30 | IP Interface Commands
IPv6 Interface
ND advertised The reachable time is included in all router advertisements sent out of an
reachable time interface so that nodes on the same link use the same time value.
ND advertised The length of time during which the prefix is valid for on-link determination.
router lifetime
ND managed- Shows if router advertisements indicate that attached hosts can use stateful
config-flag autoconfiguration to obtain addresses
ND other-config- Shows if router advertisements indicate that attached hosts can obtain
flag autoconfiguration information other than addresses
This example displays a brief summary of IPv6 addresses configured on the switch.
Console#
Related Commands
show ip interface (811)
show ipv6 mtu This command displays the maximum transmission unit (MTU) cache for
destinations that have returned an ICMP packet-too-big message along with an
acceptable MTU to this switch.
Command Mode
Normal Exec, Privileged Exec
Example
The following example shows the MTU cache for this device:
– 832 –
Chapter 30 | IP Interface Commands
IPv6 Interface
MTU Adjusted MTU contained in the ICMP packet-too-big message returned from this
destination, and now used for all traffic sent along this path.
Since Time since an ICMP packet-too-big message was received from this destination.
* No information is displayed if an IPv6 address has not been assigned to the switch.
show ipv6 traffic This command displays statistics about IPv6 traffic passing through this switch.
Command Mode
Privileged Exec
Example
The following example shows statistics for all IPv6 unicast and multicast traffic, as
well as ICMP, UDP and TCP statistics:
– 833 –
Chapter 30 | IP Interface Commands
IPv6 Interface
IPv6 Statistics
IPv6 received
total received The total number of input datagrams received by the interface,
including those received in error.
header errors The number of input datagrams discarded due to errors in their IPv6
headers, including version number mismatch, other format errors, hop
count exceeded, IPv6 options, etc.
too big errors The number of input datagrams that could not be forwarded because
their size exceeded the link MTU of outgoing interface.
address errors The number of input datagrams discarded because the IPv6 address in
their IPv6 header's destination field was not a valid address to be
received at this entity. This count includes invalid addresses (e.g., ::0)
and unsupported addresses (e.g., addresses with unallocated prefixes).
For entities which are not IPv6 routers and therefore do not forward
datagrams, this counter includes datagrams discarded because the
destination address was not a local address.
truncated packets The number of input datagrams discarded because datagram frame
didn't carry enough data.
– 834 –
Chapter 30 | IP Interface Commands
IPv6 Interface
discards The number of input IPv6 datagrams for which no problems were
encountered to prevent their continued processing, but which were
discarded (e.g., for lack of buffer space). Note that this counter does not
include any datagrams discarded while awaiting re-assembly.
reassembly succeeded The number of IPv6 datagrams successfully reassembled. Note that this
counter is incremented at the interface to which these datagrams were
addressed which might not be necessarily the input interface for some
of the fragments.
reassembly failed The number of failures detected by the IPv6 re-assembly algorithm (for
whatever reason: timed out, errors, etc.). Note that this is not necessarily
a count of discarded IPv6 fragments since some algorithms (notably
the algorithm in RFC 815) can lose track of the number of fragments by
combining them as they are received. This counter is incremented at
the interface to which these fragments were addressed which might
not be necessarily the input interface for some of the fragments.
IPv6 sent
forwards datagrams The number of output datagrams which this entity received and
forwarded to their final destinations. In entities which do not act as IPv6
routers, this counter will include only those packets which were Source-
Routed via this entity, and the Source-Route processing was successful.
Note that for a successfully forwarded datagram the counter of the
outgoing interface is incremented.
requests The total number of IPv6 datagrams which local IPv6 user-protocols
(including ICMP) supplied to IPv6 in requests for transmission. Note
that this counter does not include any datagrams counted in
ipv6IfStatsOutForwDatagrams.
discards The number of output IPv6 datagrams for which no problem was
encountered to prevent their transmission to their destination, but
which were discarded (e.g., for lack of buffer space). Note that this
counter would include datagrams counted in
ipv6IfStatsOutForwDatagrams if any such packets met this
(discretionary) discard criterion.
generated fragments The number of output datagram fragments that have been generated
as a result of fragmentation at this output interface.
fragment succeeded The number of IPv6 datagrams that have been successfully fragmented
at this output interface.
fragment failed The number of IPv6 datagrams that have been discarded because they
needed to be fragmented at this output interface but could not be.
– 835 –
Chapter 30 | IP Interface Commands
IPv6 Interface
ICMPv6 Statistics
ICMPv6 received
input The total number of ICMP messages received by the interface which
includes all those counted by ipv6IfIcmpInErrors. Note that this
interface is the interface to which the ICMP messages were addressed
which may not be necessarily the input interface for the messages.
errors The number of ICMP messages which the interface received but
determined as having ICMP-specific errors (bad ICMP checksums, bad
length, etc.).
packet too big messages The number of ICMP Packet Too Big messages received by the interface.
time exceeded messages The number of ICMP Time Exceeded messages received by the
interface.
parameter problem The number of ICMP Parameter Problem messages received by the
message interface.
echo request messages The number of ICMP Echo (request) messages received by the interface.
echo reply messages The number of ICMP Echo Reply messages received by the interface.
router solicit messages The number of ICMP Router Solicit messages received by the interface.
router advertisement The number of ICMP Router Advertisement messages received by the
messages interface.
neighbor solicit messages The number of ICMP Neighbor Solicit messages received by the
interface.
group membership query The number of ICMPv6 Group Membership Query messages received
messages by the interface.
ICMPv6 sent
output The total number of ICMP messages which this interface attempted to
send. Note that this counter includes all those counted by
icmpOutErrors.
destination unreachable The number of ICMP Destination Unreachable messages sent by the
messages interface.
packet too big messages The number of ICMP Packet Too Big messages sent by the interface.
time exceeded messages The number of ICMP Time Exceeded messages sent by the interface.
parameter problem The number of ICMP Parameter Problem messages sent by the
message interface.
echo request messages The number of ICMP Echo (request) messages sent by the interface.
– 836 –
Chapter 30 | IP Interface Commands
IPv6 Interface
echo reply messages The number of ICMP Echo Reply messages sent by the interface.
router solicit messages The number of ICMP Router Solicitation messages sent by the interface.
router advertisement The number of ICMP Router Advertisement messages sent by the
messages interface.
neighbor solicit messages The number of ICMP Neighbor Solicit messages sent by the interface.
neighbor advertisement The number of ICMP Router Advertisement messages sent by the
messages interface.
redirect messages The number of Redirect messages sent. For a host, this object will
always be zero, since hosts do not send redirects.
group membership query The number of ICMPv6 Group Membership Query messages sent by
messages the interface.
group membership The number of ICMPv6 Group Membership Response messages sent.
response messages
group membership The number of ICMPv6 Group Membership Reduction messages sent.
reduction messages
UDP Statistics
no port errors The total number of received UDP datagrams for which there was no
application at the destination port.
other errors The number of received UDP datagrams that could not be delivered for
reasons other than the lack of an application at the destination port.
output The total number of UDP datagrams sent from this entity.
Command Mode
Privileged Exec
Command Usage
This command resets all of the counters displayed by the show ipv6 traffic
command.
Example
Console#clear ipv6 traffic
Console#
– 837 –
Chapter 30 | IP Interface Commands
IPv6 Interface
ping6 This command sends (IPv6) ICMP echo request packets to another node on the
network.
Syntax
ping6 {ipv6-address | host-name} [count count] [size size]
ipv6-address - The IPv6 address of a neighbor device. You can specify either
a link-local or global unicast address formatted according to RFC 2373 “IPv6
Addressing Architecture,” using 8 colon-separated 16-bit hexadecimal
values. One double colon may be used in the address to indicate the
appropriate number of zeros required to fill the undefined fields.
host-name - A host name string which can be resolved into an IPv6 address
through a domain name server.
count - Number of packets to send. (Range: 1-16)
size - Number of bytes in a packet. (Range: 0-1500 bytes)
The actual packet size will be eight bytes larger than the size specified
because the router adds header information.
Default Setting
count: 5
size: 32 bytes
Command Mode
Normal Exec, Privileged Exec
Command Usage
◆ Use the ping6 command to see if another site on the network can be reached,
or to evaluate delays over the path.
◆ When pinging a host name, be sure the DNS server has been enabled (see
page 771). If necessary, local devices can also be specified in the DNS static host
table (see page 772).
◆ When using ping6 with a host name, the switch first attempts to resolve the
alias into an IPv6 address before trying to resolve it into an IPv4 address.
Example
Console#ping6 FE80::2E0:CFF:FE00:FC%1
Press ESC to abort.
PING to FE80::2E0:CFF:FE00:FC%1/64, by 5 32-byte payload ICMP packets,
timeout is 3 seconds
response time: 20 ms [FE80::2E0:CFF:FE00:FC] seq_no: 1
response time: 0 ms [FE80::2E0:CFF:FE00:FC] seq_no: 2
– 838 –
Chapter 30 | IP Interface Commands
IPv6 Interface
traceroute6 This command shows the route packets take to the specified destination.
Syntax
traceroute6 {ipv6-address | host-name} [max-failures failure-count]
ipv6-address - The IPv6 address of a neighbor device. You can specify either
a link-local or global unicast address formatted according to RFC 2373 “IPv6
Addressing Architecture,” using 8 colon-separated 16-bit hexadecimal
values. One double colon may be used in the address to indicate the
appropriate number of zeros required to fill the undefined fields.
host-name - A host name string which can be resolved into an IPv6 address
through a domain name server.
failure-count - The maximum number of failures before which the trace
route is terminated. (Range: 1-255)
Default Setting
Maximum failures: 5
Command Mode
Privileged Exec
Command Usage
◆ Use the traceroute6 command to determine the path taken to reach a
specified destination.
◆ The traceroute command first sends probe datagrams with the TTL value set at
one. This causes the first router to discard the datagram and return an error
message. The trace function then sends several probe messages at each
subsequent TTL level and displays the round-trip time for each message. Not all
devices respond correctly to probes by returning an “ICMP port unreachable”
message. If the timer goes off before a response is returned, the trace function
– 839 –
Chapter 30 | IP Interface Commands
IPv6 Interface
prints a series of asterisks and the “Request Timed Out” message. A long
sequence of these messages, terminating only when the maximum timeout
has been reached, may indicate this problem with the target device.
Example
Console#traceroute6 FE80::2E0:CFF:FE9C:CA10%1
Press "ESC" to abort.
Trace completed.
Console#
Neighbor Discovery
ipv6 hop-limit This command configures the maximum number of hops used in router
advertisements that are originated by this router. Use the no form to restore the
default setting.
Syntax
ipv6 hop-limit hops
no ipv6 hop-limit
hops - The maximum number of hops in router advertisements and all IPv6
packets. (Range: 1-255)
Default Setting
1
Command Mode
Global Configuration
Example
The following sets the hop limit for router advertisements to 64:
Console(config)#ipv6 hop-limit 64
Console(config)#
– 840 –
Chapter 30 | IP Interface Commands
IPv6 Interface
ipv6 neighbor This command configures a static entry in the IPv6 neighbor discovery cache. Use
the no form to remove a static entry from the cache.
Syntax
ipv6 neighbor ipv6-address vlan vlan-id hardware-address
no ipv6 neighbor ipv6-address vlan vlan-id
ipv6-address - The IPv6 address of a neighbor device that can be reached
through one of the network interfaces configured on this switch. You can
specify either a link-local or global unicast address formatted according to
RFC 2373 “IPv6 Addressing Architecture,” using 8 colon-separated 16-bit
hexadecimal values. One double colon may be used in the address to
indicate the appropriate number of zeros required to fill the undefined
fields.
vlan-id - VLAN ID (Range: 1-4094)
hardware-address - The 48-bit MAC layer address for the neighbor device.
This address must be formatted as six hexadecimal pairs separated by
hyphens.
Default Setting
None
Command Mode
Global Configuration
Command Usage
◆ Address Resolution Protocol (ARP) has been replaced in IPv6 with the Neighbor
Discovery Protocol (NDP). The ipv6 neighbor command is similar to the mac-
address-table static command that is implemented using ARP.
◆ The switch does not determine whether a static entry is reachable before
placing it in the IPv6 neighbor discovery cache.
◆ If the specified entry was dynamically learned through the IPv6 neighbor
discovery process, and already exists in the neighbor discovery cache, it is
converted to a static entry. Static entries in the IPv6 neighbor discovery cache
are not modified if subsequently detected by the neighbor discovery process.
– 841 –
Chapter 30 | IP Interface Commands
IPv6 Interface
Example
The following maps a static entry for global unicast address to a MAC address:
Related Commands
show ipv6 neighbors (853)
ipv6 nd dad attempts This command configures the number of consecutive neighbor solicitation
messages sent on an interface during duplicate address detection. Use the no form
to restore the default setting.
Syntax
ipv6 nd dad attempts count
no ipv6 nd dad attempts
count - The number of neighbor solicitation messages sent to determine
whether or not a duplicate address exists on this interface. (Range: 0-600)
Default Setting
1
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ Configuring a value of 0 disables duplicate address detection.
– 842 –
Chapter 30 | IP Interface Commands
IPv6 Interface
Example
The following configures five neighbor solicitation attempts for addresses
configured on VLAN 1. The show ipv6 interface command indicates that the
duplicate address detection process is still on-going.
Console(config)#interface vlan 1
Console(config-if)#ipv6 nd dad attempts 5
Console(config-if)#end
Console#show ipv6 interface
VLAN 1 is up
IPv6 is enabled.
Link-local address:
fe80::269:3ef9:fe19:6779%1/64
Global unicast address(es):
2001:db8:0:1:2e0:cff:fe02:fd/64, subnet is 2001:db8:0:1::/64[EUI]
2001:db8:2222:7272::72/96, subnet is 2001:db8:2222:7272::/96
Joined group address(es):
ff02::2
ff02::1:ff19:6779
ff02::1:ff00:0
ff02::1:ff00:72
ff02::1:ff02:fd
ff02::1:2
ff02::1
IPv6 link MTU is 1500 bytes
ND DAD is enabled, number of DAD attempts: 5.
ND retransmit interval is 1000 milliseconds
ND advertised retransmit interval is 0 milliseconds
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised router lifetime is 1800 seconds
Console#
Related Commands
ipv6 nd ns-interval (845)
show ipv6 neighbors (853)
– 843 –
Chapter 30 | IP Interface Commands
IPv6 Interface
ipv6 nd This command configures IPv6 router advertisements to indicate to attached hosts
managed-config-flag that they can use stateful autoconfiguration to obtain addresses. Use the no form
to clear this flag from router advertisements.
Syntax
[no] ipv6 nd managed-config-flag
Default Setting
Disabled
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ The “managed-address configuration” flag tells hosts that they should use
stateful autoconfiguration to obtain addresses from a DHCPv6 server.
◆ The ipv6 nd other-config-flag command is used to tell hosts that they should
use stateless address autoconfiguration to get IPv6 address (based on the IPv6
prefixes found in router advertisements) and stateful autoconfiguration to get
other non-address parameters (such as DNS server addresses) from DHCPv6
servers.
◆ The absence of the “managed-address configuration” flag tells hosts to use only
stateless address autoconfiguration (based on IPv6 prefixes found in router
advertisements).
Example
The following tells hosts to use stateful autoconfiguration to obtain addresses:
Console(config)#interface vlan 1
Console(config)#ipv6 nd managed-config-flag
Console(config)#
ipv6 nd This command configures IPv6 router advertisements to indicate to attached hosts
other-config-flag that they can obtain stateful autoconfiguration information other than addresses.
Use the no form to clear this flag from router advertisements.
SYNTAX
[no] ipv6 nd other-config-flag
– 844 –
Chapter 30 | IP Interface Commands
IPv6 Interface
Default Setting
Disabled
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ The “other-stateful-configuration” flag tells hosts that they should use stateful
autoconfiguration to obtain information other than addresses from a DHCPv6
server.
◆ Some hosts interpret the “other stateful configuration” flag to indicate that they
should use stateless address autoconfiguration to get IPv6 address (based on
the IPv6 prefixes found in router advertisements) and stateful
autoconfiguration to get other non-address parameters from DHCPv6 servers.
In this case, the absence of both the “managed address configuration” flag and
the “other stateful configuration” flag is interpreted to mean that they should
use only stateless autoconfiguration to obtain addresses.
Example
The following tells hosts to use stateful autoconfiguration to obtain other non-
address information from a DHCPv6 server:
Console(config)#interface vlan 1
Console(config)#ipv6 nd other-config-flag
Console(config)#
ipv6 nd ns-interval This command configures the interval between transmitting IPv6 neighbor
solicitation messages on an interface. Use the no form to restore the default value.
Syntax
ipv6 nd ns-interval milliseconds
no ipv6 nd ns-interval
milliseconds - The interval between transmitting IPv6 neighbor solicitation
messages. (Range: 1000-3600000)
Default Setting
1000 milliseconds is used for neighbor discovery operations
0 milliseconds is advertised in router advertisements
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ When a non-default value is configured, the specified interval is used both for
router advertisements and by the router itself.
– 845 –
Chapter 30 | IP Interface Commands
IPv6 Interface
◆ Setting the neighbor solicitation interval to 0 means that the configured time is
unspecified by this router.Setting the neighbor solicitation interval to 0 means
that the configured time is unspecified by this router.
Example
The following sets the interval between sending neighbor solicitation messages to
30000 milliseconds:
Console(config)#interface vlan 1
Console(config)#ipv6 nd ns-interval 30000
Console(config)#end
Console#show ipv6 interface
VLAN 1 is up
IPv6 is enabled.
Link-local address:
fe80::269:3ef9:fe19:6779%1/64
Global unicast address(es):
2001:db8:0:1:2e0:cff:fe02:fd/64, subnet is 2001:db8:0:1::/64[EUI][EIU]
2001:db8:2222:7272::72/96, subnet is 2001:db8:2222:7272::/96
Joined group address(es):
ff02::2
ff02::1:ff19:6779
ff02::1:ff00:0
ff02::1:ff00:72
ff02::1:ff02:fd
ff02::1:2
ff02::1
IPv6 link MTU is 1500 bytes
ND DAD is enabled, number of DAD attempts: 5.
ND retransmit interval is 30000 milliseconds
ND advertised retransmit interval is 30000 milliseconds
ND reachable time is 30000 milliseconds
ND advertised reachable time is 0 milliseconds
ND advertised router lifetime is 1800 seconds
Console#
Related Commands
show running-config (109)
ipv6 nd raguard This command blocks incoming Router Advertisement and Router Redirect
packets. Use the no form to disable this feature.
Syntax
[no] ipv6 nd raguard
Default Setting
Disabled
– 846 –
Chapter 30 | IP Interface Commands
IPv6 Interface
Command Mode
Interface Configuration (Ethernet, Port Channel)
Command Usage
◆ IPv6 Router Advertisements (RA) convey information that enables nodes to
auto-configure on the network. This information may include the default router
address taken from the observed source address of the RA message, as well as
on-link prefix information. However, unintended mis-configurations, or
possibly malicious attacks on the network, may lead to bogus RAs being sent,
which in turn can cause operational problems for hosts on the network.
◆ This command can be used to block RAs and Router Redirect (RR) messages on
the specified interface. Determine which interfaces are connected to known
routers, and enable RA Guard on all other untrusted interfaces.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ipv6 nd raguard
Console(config-if)#
show ipv6 nd raguard This command displays the configuration setting for RA Guard.
Syntax
show ipv6 nd raguard [interface]
interface
ethernet unit/port
unit - Unit identifier. (Range: 1)
port - Port number. (Range: 1-28)
port-channel channel-id (Range: 1-28)
Command Mode
Privileged Exec
Example
Console#show ipv6 nd raguard interface ethernet 1/1
Interface RA Guard
--------- --------
Eth 1/ 1 Yes
Console#
– 847 –
Chapter 30 | IP Interface Commands
IPv6 Interface
ipv6 nd This command configures the amount of time that a remote IPv6 node is
reachable-time considered reachable after some reachability confirmation event has occurred. Use
the no form to restore the default setting.
Syntax
ipv6 nd reachable-time milliseconds
no ipv6 nd reachable-time
milliseconds - The time that a node can be considered reachable after
receiving confirmation of reachability. (Range: 0-3600000)
Default Setting
30000 milliseconds is used for neighbor discovery operations
0 milliseconds is advertised in router advertisements
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ The time limit configured by this parameter allows the router to detect
unavailable neighbors. During the neighbor discover process, an IPv6 node will
multicast neighbor solicitation messages to search for neighbor nodes. For a
neighbor node to be considered reachable, it must respond to the neighbor
soliciting node with a neighbor advertisement message to become a
confirmed neighbor, after which the reachable timer will be considered in
effect for subsequent unicast IPv6 layer communications.
◆ This time limit is included in all router advertisements sent out through an
interface, ensuring that nodes on the same link use the same time value.
◆ Setting the time limit to 0 means that the configured time is unspecified by this
router.
Example
The following sets the reachable time for a remote node to 1000 milliseconds:
Console(config)#interface vlan 1
Console(config-if)ipv6 nd reachable-time 1000
Console(config-if)#
ipv6 nd prefix This command configures the IPv6 prefixes to include in router advertisements. Use
the no form to remove a prefix.
Syntax
ipv6 nd prefix ipv6-address/prefix-length {default |
[valid-lifetime preferred-lifetime [no-autoconfig | off-link]]}
– 848 –
Chapter 30 | IP Interface Commands
IPv6 Interface
Default Setting
valid-lifetime 2592000 seconds
preferred-lifetime 2592000 seconds
no-autoconfig Disabled
off-link Disabled
Command Mode
Interface Configuration (VLAN)
Command Usage
◆ Prefixes configured as addresses on an interface using the ipv6 address
command are advertised in router advertisements. If prefixes are configured for
advertisement using the ipv6 nd prefix command, then only these prefixes are
advertised.
◆ The preferred lifetime and valid lifetime are counted down in real time. After
the preferred lifetime expires, no new connections are made using this prefix.
When the valid lifetime expires, this prefix will no longer be advertised.
◆ All prefixes are inserted in the routing table as Connected (i.e., on-line), unless
specified with the off-link option. If the off-link option is specified, and the
prefix is already present in the routing table as a Connected prefix, it will be
removed.
– 849 –
Chapter 30 | IP Interface Commands
IPv6 Interface
Example
The following configures a network prefix with a valid lifetime of 1000 seconds, and
a preferred lifetime of 900 seconds:
Console(config)#interface vlan 1
Console(config)#ipv6 nd prefix 2011:0DBF::/35 1000 900
Console(config)#
ipv6 nd ra interval This command configures the interval between the transmission of IPv6 router
advertisements on an interface. Use the no form to restore the default interval.
Syntax
ipv6 nd ra interval minimum-interval [maximum-interval]
no ipv6 nd ra interval
minimum-interval - The maximum interval between IPv6 router
advertisements. (Range: 4-1800 seconds)
maximum-interval - The minimum interval between IPv6 router
advertisements. (Range: 3-1350 seconds)
Command Mode
Interface Configuration (VLAN)
Default Setting
maximum interval: 600 seconds
minimum interval: 198 seconds
Command Usage
◆ The interval between transmissions should be less than or equal to the IPv6
router advertisement lifetime if you configure a route as a default router by
using the ipv6 nd ra lifetime command.
◆ To prevent synchronization with other IPv6 nodes, the actual interval used is
randomly selected from a value between the minimum value set by the system
(33% of the maximum RA interval) and the maximum value set by the ipv6 nd
ra interval command.
Example
The following sets the maximum RA interval to 1800 seconds:
Console(config)#interface vlan 1
Console(config)#ipv6 nd ra interval 1800
Console(config)#
– 850 –
Chapter 30 | IP Interface Commands
IPv6 Interface
ipv6 nd ra lifetime This command configures the router lifetime value used in IPv6 router
advertisements sent from an interface. Use the no form to restore the default
setting.
Syntax
ipv6 nd ra lifetime lifetime
no ipv6 nd ra lifetime
lifetime - Router lifetime. (Range: 0-90000 seconds)
Command Mode
Interface Configuration (VLAN)
Default Setting
1800 seconds
Command Usage
◆ This command can be used to indicate the usefulness of this router as a default
router on this interface.
◆ Set the router lifetime to 0 to indicate that this router should not be considered
a default router. Set the lifetime to a non-zero value to indicate that it should be
considered a default router. When a non-zero value is used, the lifetime should
not be less than the router advertisement interval.
Example
The following sets the router lifetime to 8000 seconds:
Console(config)#interface vlan 1
Console(config)#ipv6 nd ra lifetime 8000
Console(config)#
ipv6 nd ra This command configures the default router preference for the router on an
router-preference interface. Use the no form to restore the default setting.
Syntax
ipv6 nd ra router-preference {high | medium | low}
no ipv6 nd ra router-preference
high - Preference for the router is high.
medium - Preference for the router is medium.
low - Preference for the router is low.
Command Mode
Interface Configuration (VLAN)
– 851 –
Chapter 30 | IP Interface Commands
IPv6 Interface
Default Setting
medium
Command Usage
Default router preference may be used to prioritize routers which provide
equivalent, but not equal-cost, routing, and policy dictates that hosts should prefer
one of the routers.
Example
The following sets the default router preference to high:
Console(config)#interface vlan 1
Console(config)#ipv6 nd ra router-preference high
Console(config)#
ipv6 nd ra suppress This command suppresses router advertisement transmissions on an interface. Use
the no form to re-enable router advertisements.
Syntax
[no] ipv6 nd ra suppress
Command Mode
Interface Configuration (VLAN, IPv6/v4 Tunnel)
Default Setting
Not suppressed
Command Usage
This command suppresses periodic unsolicited router advertisements. It does not
suppress advertisements sent in response to a router solicitation.
Example
The following suppresses router advertisements on the current interface:
Console(config)#interface vlan 1
Console(config)#ipv6 nd ra suppress
Console(config)#
– 852 –
Chapter 30 | IP Interface Commands
IPv6 Interface
clear ipv6 neighbors This command deletes all dynamic entries in the IPv6 neighbor discovery cache.
Command Mode
Privileged Exec
Example
The following deletes all dynamic entries in the IPv6 neighbor cache:
show ipv6 neighbors This command displays information in the IPv6 neighbor discovery cache.
Syntax
show ipv6 neighbors [vlan vlan-id | ipv6-address]
vlan-id - VLAN ID (Range: 1-4094)
ipv6-address - The IPv6 address of a neighbor device. You can specify either
a link-local or global unicast address formatted according to RFC 2373 “IPv6
Addressing Architecture,” using 8 colon-separated 16-bit hexadecimal
values. One double colon may be used in the address to indicate the
appropriate number of zeros required to fill the undefined fields.
Default Setting
All IPv6 neighbor discovery cache entries are displayed.
Command Mode
Privileged Exec
Example
The following shows all known IPv6 neighbors for this switch:
Age The time since the address was verified as reachable (in seconds). A static entry is
indicated by the value “Permanent.”
– 853 –
Chapter 30 | IP Interface Commands
IPv6 Interface
D (Delay) - More than the ReachableTime interval has elapsed since the last
positive confirmation was received that the forward path was functioning. A
packet was sent within the last DELAY_FIRST_PROBE_TIME interval. If no
reachability confirmation is received within this interval after entering the DELAY
state, the switch will send a neighbor solicitation message and change the state
to PROBE.
P1 (Probe) - A reachability confirmation is actively sought by resending neighbor
solicitation messages every RetransTimer interval until confirmation of
reachability is received.
U (Unknown) - Unknown state.
The following states are used for static entries:
I1 (Incomplete)-The interface for this entry is down.
R (Reachable) - The interface for this entry is up. Reachability detection is not
applied to static entries in the IPv6 neighbor discovery cache.
P2 (Permanent) - Indicates a static entry.
Related Commands
show mac-address-table (487)
show ipv6 nd prefix This command displays IPv6 prefixes in neighbor discovery router advertisements.
Syntax
show ipv6 nd prefix vlan vlan-id
vlan-id - VLAN ID (Range: 1-4094)
Default Setting
All IPv6 prefixes for the specified VLAN are displayed.
Command Mode
Privileged Exec
– 854 –
Chapter 30 | IP Interface Commands
ND Snooping
Example
The following shows all neighbor discovery IPv6 prefixes for VLAN 1:
Console#
ND Snooping
Neighbor Discover (ND) Snooping maintains an IPv6 prefix table and user address
binding table. These tables can be used for stateless address auto-configuration or
for address filtering by IPv6 Source Guard.
ND snooping can also detect if an IPv6 address binding is no longer valid. When a
binding has been timed out, it checks to see if the host still exists by sending an NS
packet to the target host. If it receives an NA packet in response, it knows that the
target still exists and updates the lifetime of the binding; otherwise, it deletes the
binding.
– 855 –
Chapter 30 | IP Interface Commands
ND Snooping
ipv6 nd snooping prefix Sets the time to wait for an RA message before deleting GC
timeout an entry in the prefix table
ipv6 nd snooping Sets the maximum number of address entries which can IC
max-binding be bound to a port
ipv6 nd snooping trust Configures a port as a trusted interface from which prefix IC
information in RA messages can be added to the prefix
table, or NS messages can be forwarded without
validation
clear ipv6 nd snooping Clears all entries in the address binding table PE
binding
clear ipv6 nd snooping prefix Clears all entries in the prefix table PE
ipv6 nd snooping This command enables ND snooping globally or on a specified VLAN or range of
VLANs. Use the no form to disable this feature.
Syntax
[no] ipv6 nd snooping [vlan {vlan-id | vlan-range}]
vlan-id - VLAN ID. (Range: 1-4094)
vlan-range - A consecutive range of VLANs indicated by the use a hyphen,
or a random group of VLANs with each entry separated by a comma.
Default Setting
Disabled
Command Mode
Global Configuration
Command Usage
◆ Use this command without any keywords to enable ND snooping globally on
the switch. Use the VLAN keyword to enable ND snooping on a specific VLAN or
a range of VLANs.
◆ Once ND snooping is enabled both globally and on the required VLANs, the
switch will start monitoring RA messages to build an address prefix table as
described below:
■ If an RA message is received on an untrusted interface, it is dropped. If
received on a trusted interface, the switch adds an entry in the prefix table
– 856 –
Chapter 30 | IP Interface Commands
ND Snooping
◆ Once ND snooping is enabled both globally and on the required VLANs, the
switch will start monitoring NS messages to build a dynamic user binding table
for use in Duplicate Address Detection (DAD) or for use by other security
filtering protocols (e.g., IPv6 Source Guard) as described below:
■ If an NS message is received on an trusted interface, it is forwarded without
further processing.
■ If an NS message is received on an untrusted interface, and the address
prefix does not match any entry in the prefix table, it drops the packet.
■ If the message does match an entry in the prefix table, it adds an entry to
the dynamic user binding table after a fixed delay, and forwards the packet.
Each entry in the dynamic binding table includes the link-layer address,
IPv6 address, lifetime, as well as the VLAN and port interface which received
the message.
■ If an RA message is received in response to the original NS message
(indicating a duplicate address) before the dynamic binding timeout period
expires, the entry is deleted. Otherwise, when the timeout expires, the
entry is dropped if the auto-detection process is not enabled.
■ If the auto-detection process is enabled, the switch periodically sends an
NS message to determine is the client still exists. If it does not receive an RA
message in response after the configured timeout, the entry is dropped. If
the switch receives an RA message before the timeout expires, it resets the
lifetime for the dynamic binding, and the auto-detection process resumes.
Example
This example enables ND snooping globally and on VLAN 1.
Console(config)#ipv6 nd snooping
Console(config)#ipv6 nd snooping vlan 1
Console(config)#
ipv6 nd snooping This command enables automatic validation of dynamic user binding table entries
auto-detect by periodically sending NS messages and awaiting NA replies. Use the no form to
disable this feature.
Syntax
[no] ipv6 nd snooping auto-detect
Default Setting
Disabled
– 857 –
Chapter 30 | IP Interface Commands
ND Snooping
Command Mode
Global Configuration
Command Usage
If auto-detection is enabled, the switch periodically sends an NS message to
determine is a client listed in the dynamic binding table still exists. If it does not
receive an RA message in response after the configured timeout, the entry is
dropped. If the switch receives an RA message before the timeout expires, it resets
the lifetime for the dynamic binding, and the auto-detection process resumes.
Example
Console(config)#ipv6 nd snooping auto-detect
Console(config)#
ipv6 nd snooping This command sets the number of times the auto-detection process sends an NS
auto-detect message to determine if a dynamic user binding is still valid. Use the no form to
retransmit count restore the default setting.
Syntax
ipv6 nd snooping auto-detect retransmit count retransmit-times
no ipv6 nd snooping auto-detect retransmit count
retransmit-times – The number of times to send an NS message to
determine if a client still exists. (Range: 1-5)
Default Setting
3
Command Mode
Global Configuration
Command Usage
The timeout after which the switch will delete a dynamic user binding if no RA
message is received is set to the retransmit count x the retransmit interval (see the
ipv6 nd snooping auto-detect retransmit interval command). Based on the default
settings, this is 3 seconds.
Example
Console(config)#ipv6 nd snooping auto-detect retransmit count 5
Console(config)#
– 858 –
Chapter 30 | IP Interface Commands
ND Snooping
ipv6 nd snooping This command sets the interval between which the auto-detection process sends
auto-detect NS messages to determine if a dynamic user binding is still valid. Use the no form to
retransmit interval restore the default setting.
Syntax
ipv6 nd snooping auto-detect retransmit interval retransmit-interval
no ipv6 nd snooping auto-detect retransmit interval
retransmit-interval – The interval between which the switch sends an NS
message to determine if a client still exists. (Range: 1-10 seconds)
Default Setting
1 second
Command Mode
Global Configuration
Command Usage
The timeout after which the switch will delete a dynamic user binding if no RA
message is received is set to the retransmit count (see the ipv6 nd snooping auto-
detect retransmit count command) x the retransmit interval. Based on the default
settings, this is 3 seconds.
Example
Console(config)#ipv6 nd snooping auto-detect retransmit interval 5
Console(config)#
ipv6 nd snooping This command sets the time to wait for an RA message before deleting an entry in
prefix timeout the prefix table. Use the no form to restore the default setting.
Syntax
ipv6 nd snooping prefix timeout timeout
no ipv6 nd snooping prefix timeout
timeout – The time to wait for an RA message to confirm that a prefix entry
is still valid. (Range: 3-1800 seconds)
Default Setting
None set
Command Mode
Global Configuration
Command Usage
If ND snooping is enabled and an RA message is received on a trusted interface, the
switch will add an entry in the prefix table based upon the Prefix Information
– 859 –
Chapter 30 | IP Interface Commands
ND Snooping
contained in the message. If an RA message is not received for a table entry with
the same prefix for the specified timeout period, the entry is deleted.
Example
Console(config)#ipv6 nd snooping prefix timeout 200
Console(config)#
ipv6 nd snooping This command sets the maximum number of address entries in the dynamic user
max-binding binding table which can be bound to a port. Use the no form to restore the default
setting.
Syntax
ipv6 nd snooping max-binding max-bindings
no ipv6 nd snooping max-binding
max-bindings – The maximum number of address entries in the dynamic
user binding table which can be bound to a port. (Range: 1-5)
Default Setting
5
Command Mode
Interface Configuration (Ethernet, Port Channel)
Example
Console(config)#interface ethernet 1/12
Console(config-if)#ipv6 nd snooping max-binding 5
Console(config-if)#
ipv6 nd snooping trust This command configures a port as a trusted interface from which prefix
information in RA messages can be added to the prefix table, or NS messages can
be forwarded without validation. Use the no form to restore the default setting.
Syntax
[no] ipv6 nd snooping trust
Default Setting
Not trusted
Command Mode
Interface Configuration (Ethernet, Port Channel)
– 860 –
Chapter 30 | IP Interface Commands
ND Snooping
Command Usage
◆ In general, interfaces facing toward to the network core, or toward routers
supporting the Network Discovery protocol, are configured as trusted
interfaces.
◆ RA messages received from a trusted interface are added to the prefix table and
forwarded toward their destination.
Example
Console(config)#interface ethernet 1/1
Console(config-if)#ipv6 nd snooping trust
Console(config-if)#
clear ipv6 nd This command clears all entries in the dynamic user address binding table.
snooping binding
Syntax
clear ipv6 nd snooping binding
Command Mode
Privileged Exec
Example
Console#clear ipv6 nd snooping binding
Console#show ipv6 nd snooping binding
MAC Address IPv6 Address Lifetime VLAN Interface
-------------- -------------------------------------- ---------- ---- ---------
Console#
clear ipv6 nd This command clears all entries in the address prefix table.
snooping prefix
Syntax
clear ipv6 nd snooping prefix [interface vlan vlan-id]
vlan-id - VLAN ID. (Range: 1-4094)
Command Mode
Privileged Exec
Example
Console#clear ipv6 nd snooping prefix
Console#show ipv6 nd snooping prefix
Prefix entry timeout: (seconds)
Prefix Len Valid-Time Expire VLAN Interface
– 861 –
Chapter 30 | IP Interface Commands
ND Snooping
Console#
show ipv6 nd This command shows the configuration settings for ND snooping.
snooping
Syntax
show ipv6 nd snooping
Command Mode
Privileged Exec
Example
Console#show ipv6 nd snooping
Global ND Snooping status: enabled
ND Snooping auto-detection: disabled
ND Snooping auto-detection retransmit count: 3
ND Snooping auto-detection retransmit interval: 1 (second)
ND Snooping is configured on the following VLANs:
VLAN 1,
Interface Trusted Max-binding
--------- --------- -----------
Eth 1/1 Yes 1
Eth 1/2 No 5
Eth 1/3 No 5
Eth 1/4 No 5
Eth
. 1/5 No 5
.
.
show ipv6 nd This command shows all entries in the dynamic user binding table.
snooping binding
Syntax
show ipv6 nd snooping binding
Command Mode
Privileged Exec
Example
Console#show ipv6 nd snooping binding
MAC Address IPv6 Address Lifetime VLAN Interface
-------------- -------------------------------------- ---------- ---- ---------
0013-49aa-3926 2001:b001::211:95ff:fe84:cb9e 100 1 Eth 1/1
0012-cf01-0203 2001::1 3400 2 Eth 1/2
Console#
– 862 –
Chapter 30 | IP Interface Commands
ND Snooping
show ipv6 nd This command shows all entries in the address prefix table.
snooping prefix
Syntax
show ipv6 nd snooping prefix [interface vlan vlan-id]
vlan-id - VLAN ID. (Range: 1-4094)
Command Mode
Privileged Exec
Example
Console#show ipv6 nd snooping prefix
Prefix entry timeout: 100 (second)
Prefix Len Valid-Time Expire VLAN Interface
-------------------------------------- --- ---------- ---------- ---- ---------
2001:b000:: 64 2592000 100 1 Eth 1/1
2001:: 64 600 34 2 Eth 1/2
Console#
– 863 –
Chapter 30 | IP Interface Commands
ND Snooping
– 864 –
28 IP Routing Commands
After network interfaces are configured for the switch, the paths used to send
traffic between different interfaces must be set. To forward traffic to devices on
other subnetworks, configure fixed paths with static routing commands. This
section includes commands for static routing. These commands are used to
connect between different local subnetworks or to connect the router to the
enterprise network.
Global Routing Configuration Configures global parameters for static routing, displays the
routing table
IPv4 Commands
show ip route summary Displays summary information for the routing table PE
show ip traffic Displays statistics for IP, ICMP, UDP, TCP and ARP protocols PE
IPv6 Commands
ECMP Commands
– 865 –
Chapter 28 | IP Routing Commands
Global Routing Configuration
IPv4 Commands
ip route This command configures static routes. Use the no form to remove static routes.
Syntax
ip route destination-ip netmask next-hop [distance]
no ip route {destination-ip netmask next-hop | *}
destination-ip – IP address of the destination network, subnetwork, or host.
netmask - Network mask for the associated IP subnet. This mask identifies
the host address bits used for routing to specific subnets.
next-hop – IP address of the next hop router used for this route.
distance – An administrative distance indicating that this route can be
overridden by dynamic routing information if the distance of the dynamic
route is less than that configured for the static route. (Range: 1-255,
Default: 1)
* – Removes all static routing table entries.
Default Setting
No static routes are configured.
Command Mode
Global Configuration
Command Usage
◆ Up to 56 static routes can be configured.
Example
This example forwards all traffic for subnet 192.168.1.0 to the gateway router
192.168.5.254, using the default metric of 1.
– 866 –
Chapter 28 | IP Routing Commands
Global Routing Configuration
show ip route This command displays information in the Forwarding Information Base (FIB).
Syntax
show ip route [connected | database | static | summary]
connected – Displays all currently connected entries.
database – All known routes, including inactive routes. See show ip route
database.
Command Mode
Privileged Exec
Command Usage
◆ The FIB contains information required to forward IP traffic. It contains the
interface identifier and next hop information for each reachable destination
network prefix based on the IP routing table. When routing or topology
changes occur in the network, the routing table is updated, and those changes
are immediately reflected in the FIB.
The FIB is distinct from the routing table (or, Routing Information Base), which
holds all routing information received from routing peers. The forwarding
information base contains unique paths only. It does not contain any secondary
paths. A FIB entry consists of the minimum amount of information necessary to
make a forwarding decision on a particular packet. The typical components
within a forwarding information base entry are a network prefix, a router port
identifier, and next hop information.
◆ This command only displays routes which are currently accessible for
forwarding. The router must be able to directly reach the next hop, so the VLAN
interface associated with any static route entry must be up. Note that routes
currently not accessible for forwarding, may still be displayed by using the
show ip route database command.
Example
Console#show ip route
Codes: C - connected, S - static, R - RIP, B - BGP
O - OSPF, IA - OSPF inter area
N1 - OSPF NSSA external type 1, N2 - OSPF NSSA external type 2
E1 - OSPF external type 1, E2 - OSPF external type 2
i - IS-IS, L1 - IS-IS level-1, L2 - IS-IS level-2, ia - IS-IS inter area
* - candidate default
– 867 –
Chapter 28 | IP Routing Commands
Global Routing Configuration
The RIB contains all available routes learned through directly attached networks,
and any additionally configured routes such as static routes. The RIB contains the
set of all available routes from which optimal entries are selected for use by the
Forwarding Information Base (see Command Usage under the show ip route
command).
In the following example, the numeric identifier following the routing table name
(0) indicates the Forwarding Information Base identifier.
show ip host-route This command displays the interface associated with known routes.
Syntax
show ip host-route
Command Mode
Privileged Exec
Example
Console#show ip host-route
IP Address MAC Address VLAN Port
--------------- ----------------- ---- -------
192.168.0.99 00-E0-29-94-34-64 1 1/1
192.168.1.250 00-00-30-01-01-01 3 1/ 1
10.2.48.2 00-00-30-01-01-02 1 1/ 1
10.2.5.6 00-00-30-01-01-03 1 1/ 2
10.3.9.1 00-00-30-01-01-04 2 1/ 3
– 868 –
Chapter 28 | IP Routing Commands
Global Routing Configuration
Console#
MAC Address The physical layer address associated with the IP address.
show ip route This command displays entries in the Routing Information Base (RIB).
database
Command Mode
Privileged Exec
Command Usage
The RIB contains all available routes learned through dynamic routing protocols,
directly attached networks, and any additionally configured routes such as static
routes. The RIB contains the set of all available routes from which optimal entries
are selected for use by the Forwarding Information Base (see Command Usage
under the show ip route command).
Example
Console#show ip route database
Codes: C - connected, S - static, R - RIP, B - BGP
O - OSPF, IA - OSPF inter area
N1 - OSPF NSSA external type 1, N2 - OSPF NSSA external type 2
E1 - OSPF external type 1, E2 - OSPF external type 2
i - IS-IS, L1 - IS-IS level-1, L2 - IS-IS level-2, ia - IS-IS inter area
> - selected route, * - FIB route, p - stale info
Console#
show ip route This command displays summary information for the routing table.
summary
Command Mode
Privileged Exec
Example
In the following example, the numeric identifier following the routing table name
(0) indicates the Forwarding Information Base (FIB) identifier.
– 869 –
Chapter 28 | IP Routing Commands
Global Routing Configuration
show ip traffic This command displays statistics for IP, ICMP, UDP, TCP and ARP protocols.
Command Mode
Privileged Exec
Example
Console#show ip traffic
IP Statistics:
IP received
4877 total received
header errors
unknown protocols
address errors
discards
4763 delivers
reassembly request datagrams
reassembled succeeded
reassembled failed
IP sent
forwards datagrams
5927 requests
discards
no routes
generated fragments
fragment succeeded
fragment failed
ICMP Statistics:
ICMP received
input
errors
destination unreachable messages
time exceeded messages
parameter problem message
echo request messages
echo reply messages
redirect messages
timestamp request messages
timestamp reply messages
source quench messages
address mask request messages
address mask reply messages
ICMP sent
output
errors
destination unreachable messages
time exceeded messages
parameter problem message
echo request messages
echo reply messages
redirect messages
timestamp request messages
timestamp reply messages
– 870 –
Chapter 28 | IP Routing Commands
Global Routing Configuration
Console#
IPv6 Commands
ipv6 route This command configures static IPv6 routes. Use the no form to remove static
routes.
Syntax
[no] ipv6 route destination-ipv6-address/prefix-length
{gateway-address [distance] |
link-local-address%zone-id [distance]}
destination-ipv6-address – The IPv6 address of a destination network,
subnetwork, or host. This must be a full IPv6 address including the network
prefix and host address bits.
prefix-length - A decimal value indicating how many contiguous bits (from
the left) of the address comprise the prefix (i.e., the network portion of the
address).
gateway-address – IP address of the next hop router used for this route.
link-local-address%zone-id – a link-local address, including a zone-id
indicating the VLAN identifier after the % delimiter.
distance – An administrative distance indicating that this route can be
overridden by dynamic routing information if the distance of the dynamic
route is less than that configured for the static route. Note that the default
administrative distances used by the dynamic unicast routing protocols is
110 for OSPF, 120 for RIP, 20 for eBGP, and 200 for iBGP. (Range: 1-255,
Default: 1)
Default Setting
No static routes are configured.
Command Mode
Global Configuration
Command Usage
◆ Up to 1K static routes can be configured.
– 871 –
Chapter 28 | IP Routing Commands
Global Routing Configuration
◆ The default distance of 1 will take precedence over any other type of route,
except for local routes.
◆ If both static and dynamic paths have the same lowest cost, the first route
stored in the routing table, either statically configured or dynamically learned
via a routing protocol, will be used.
Example
This example forwards all traffic for subnet 2001::/64 to the next hop router
2001:DB8:2222:7272::254, using the default metric of 1.
Related Commands
show ip route summary (869)
show ipv6 route This command displays information in the Forwarding Information Base (FIB).
Syntax
show ipv6 route [ipv6-address[/prefix-length] | database | interface [vlan vlan-
id] | local | static]
ipv6-address - A full IPv6 address including the network prefix and host
address bits.
prefix-length - A decimal value indicating how many contiguous bits (from
the left) of the address comprise the prefix (i.e., the network portion of the
address).
database – All known routes, including inactive routes.
interface – Displays all routes that be accessed through this interface.
local – Displays all entries for destinations attached directly to this router.
static – Displays all static entries.
vlan-id - VLAN ID. (Range: 1-4093)
Command Mode
Privileged Exec
Command Usage
◆ The FIB contains information required to forward IP traffic. It contains the
interface identifier and next hop information for each reachable destination
network prefix based on the IP routing table. When routing or topology
– 872 –
Chapter 28 | IP Routing Commands
Global Routing Configuration
changes occur in the network, the routing table is updated, and those changes
are immediately reflected in the FIB.
The FIB is distinct from the routing table (or, Routing Information Base), which
holds all routing information received from routing peers. The forwarding
information base contains unique paths only. It does not contain any secondary
paths. A FIB entry consists of the minimum amount of information necessary to
make a forwarding decision on a particular packet. The typical components
within a forwarding information base entry are a network prefix, a router port
identifier, and next hop information.
◆ This command only displays routes which are currently accessible for
forwarding. The router must be able to directly reach the next hop, so the VLAN
interface associated with any dynamic or static route entry must be up.
Example
In the following example, note that the last entry displays both the distance and
metric for this route.
Console#
ECMP Commands
maximum-paths This command sets the maximum number of paths allowed. Use the no form to
restore the default settings.
Syntax
maximum-paths path-count
no maximum-paths
path-count - The maximum number of equal-cost paths to the same
destination that can be installed in the routing table. (Range: 1-8)
Command Mode
Global Configuration
– 873 –
Chapter 28 | IP Routing Commands
Global Routing Configuration
Example
Console(config)#maximum-paths 8
Console(config)#
– 874 –
Section III
Appendices
– 875 –
Section III | Appendices
– 876 –
A Troubleshooting
Cannot connect using ◆ If you cannot connect using SSH, you may have exceeded the
Secure Shell maximum number of concurrent Telnet/SSH sessions permitted. Try
connecting again at a later time.
◆ Be sure the control parameters for the SSH server are properly
configured on the switch, and that the SSH client software is
properly configured on the management station.
◆ Be sure you have generated an RSA public key on the switch,
exported this key to the SSH client, and enabled the SSH service. Try
using another SSH client or check for updates to your SSH client
application.
◆ Be sure you have set up an account on the switch for each SSH user,
including user name, authentication level, and password.
◆ Be sure you have imported the client’s public key to the switch (if
public key authentication is used).
Cannot access the on- ◆ Be sure you have set the terminal emulator program to VT100
board configuration compatible, 8 data bits, 1 stop bit, no parity, and the baud rate set to
program via a serial port 115200 bps.
connection ◆ Verify that you are using the RJ-45 to DB-9 null-modem serial cable
supplied with the switch. If you use any other cable, be sure that it
conforms to the pin-out connections provided in the Installation
Guide.
– 877 –
Appendix A | Troubleshooting
Using System Logs
1. Enable logging.
3. Enable SNMP.
6. Repeat the sequence of commands or other actions that lead up to the error.
7. Make a list of the commands or circumstances that led to the fault. Also make a
list of any error messages displayed.
8. Set up your terminal emulation software so that it can capture all console
output to a file. Then enter the “show tech-support” command to record all
system settings in this file.
For example:
Console(config)#logging on
Console(config)#logging history flash 7
Console(config)#snmp-server host 192.168.1.23
.
.
.
– 878 –
B License Information
This product includes copyrighted third-party software subject to the terms of the GNU General Public
License (GPL), GNU Lesser General Public License (LGPL), or other related free software licenses.
The GPL code used in this product is distributed WITHOUT ANY WARRANTY and is subject to the
copyrights of one or more authors. For details, refer to the section "The GNU General Public License"
below, or refer to the applicable license as included in the source-code archive.
Preamble
The licenses for most software are designed to take away your freedom to share and change it. By
contrast, the GNU General Public License is intended to guarantee your freedom to share and
change free software--to make sure the software is free for all its users. This General Public License
applies to most of the Free Software Foundation's software and to any other program whose authors
commit to using it. (Some other Free Software Foundation software is covered by the GNU Library
General Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses
are designed to make sure that you have the freedom to distribute copies of free software (and
charge for this service if you wish), that you receive source code or can get it if you want it, that you
can change the software or use pieces of it in new free programs; and that you know you can do
these things.
To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to
ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the
recipients all the rights that you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which
gives you legal permission to copy, distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain that everyone understands that
there is no warranty for this free software. If the software is modified by someone else and passed on,
we want its recipients to know that what they have is not the original, so that any problems introduced
by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We wish to avoid the danger
that redistributors of a free program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any patent must be licensed for
everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification follow.
– 879 –
Appendix B | License Information
The GNU General Public License
GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION
AND MODIFICATION
1. This License applies to any program or other work which contains a notice placed by the
copyright holder saying it may be distributed under the terms of this General Public License. The
"Program", below, refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law: that is to say, a work
containing the Program or a portion of it, either verbatim or with modifications and/or translated
into another language. (Hereinafter, translation is included without limitation in the term
"modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not covered by this License; they
are outside its scope. The act of running the Program is not restricted, and the output from the
Program is covered only if its contents constitute a work based on the Program (independent of
having been made by running the Program). Whether that is true depends on what the Program
does.
2. You may copy and distribute verbatim copies of the Program's source code as you receive it, in
any medium, provided that you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to
this License and to the absence of any warranty; and give any other recipients of the Program a
copy of this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer
warranty protection in exchange for a fee.
3. You may modify your copy or copies of the Program or any portion of it, thus forming a work
based on the Program, and copy and distribute such modifications or work under the terms of
Section 1 above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that you changed the
files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in part contains or is
derived from the Program or any part thereof, to be licensed as a whole at no charge to all
third parties under the terms of this License.
c) If the modified program normally reads commands interactively when run, you must cause
it, when started running for such interactive use in the most ordinary way, to print or display
an announcement including an appropriate copyright notice and a notice that there is no
warranty (or else, saying that you provide a warranty) and that users may redistribute the
program under these conditions, and telling the user how to view a copy of this License.
(Exception: if the Program itself is interactive but does not normally print such an
announcement, your work based on the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If identifiable sections of that work
are not derived from the Program, and can be reasonably considered independent and separate
works in themselves, then this License, and its terms, do not apply to those sections when you
distribute them as separate works. But when you distribute the same sections as part of a whole
which is a work based on the Program, the distribution of the whole must be on the terms of this
License, whose permissions for other licensees extend to the entire whole, and thus to each and
every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written
entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or
with a work based on the Program) on a volume of a storage or distribution medium does not
bring the other work under the scope of this License.
4. You may copy and distribute the Program (or a work based on it, under Section 2) in object code
or executable form under the terms of Sections 1 and 2 above provided that you also do one of
the following:
a) Accompany it with the complete corresponding machine-readable source code, which must
be distributed under the terms of Sections 1 and 2 above on a medium customarily used for
software interchange; or,
– 880 –
Appendix B | License Information
The GNU General Public License
b) Accompany it with a written offer, valid for at least three years, to give any third party, for a
charge no more than your cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be distributed under the terms
of Sections 1 and 2 above on a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute corresponding
source code. (This alternative is allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such an offer, in accord with
Subsection b above.)
The source code for a work means the preferred form of the work for making modifications to it.
For an executable work, complete source code means all the source code for all modules it
contains, plus any associated interface definition files, plus the scripts used to control
compilation and installation of the executable. However, as a special exception, the source code
distributed need not include anything that is normally distributed (in either source or binary form)
with the major components (compiler, kernel, and so on) of the operating system on which the
executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated
place, then offering equivalent access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not compelled to copy the source
along with the object code.
5. You may not copy, modify, sublicense, or distribute the Program except as expressly provided
under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program
is void, and will automatically terminate your rights under this License. However, parties who
have received copies, or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
6. You are not required to accept this License, since you have not signed it. However, nothing else
grants you permission to modify or distribute the Program or its derivative works. These actions
are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the
Program (or any work based on the Program), you indicate your acceptance of this License to do
so, and all its terms and conditions for copying, distributing or modifying the Program or works
based on it.
7. Each time you redistribute the Program (or any work based on the Program), the recipient
automatically receives a license from the original licensor to copy, distribute or modify the
Program subject to these terms and conditions. You may not impose any further restrictions on
the recipients' exercise of the rights granted herein. You are not responsible for enforcing
compliance by third parties to this License.
8. If, as a consequence of a court judgment or allegation of patent infringement or for any other
reason (not limited to patent issues), conditions are imposed on you (whether by court order,
agreement or otherwise) that contradict the conditions of this License, they do not excuse you
from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your
obligations under this License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent license would not permit royalty-
free redistribution of the Program by all those who receive copies directly or indirectly through
you, then the only way you could satisfy both it and this License would be to refrain entirely from
distribution of the Program.
If any portion of this section is held invalid or unenforceable under any particular circumstance,
the balance of the section is intended to apply and the section as a whole is intended to apply in
other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right
claims or to contest validity of any such claims; this section has the sole purpose of protecting
the integrity of the free software distribution system, which is implemented by public license
practices. Many people have made generous contributions to the wide range of software
distributed through that system in reliance on consistent application of that system; it is up to the
author/donor to decide if he or she is willing to distribute software through any other system and
a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the
rest of this License.
– 881 –
Appendix B | License Information
The GNU General Public License
9. If the distribution and/or use of the Program is restricted in certain countries either by patents or
by copyrighted interfaces, the original copyright holder who places the Program under this
License may add an explicit geographical distribution limitation excluding those countries, so
that distribution is permitted only in or among countries not thus excluded. In such case, this
License incorporates the limitation as if written in the body of this License.
10. The Free Software Foundation may publish revised and/or new versions of the General Public
License from time to time. Such new versions will be similar in spirit to the present version, but
may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies a version
number of this License which applies to it and "any later version", you have the option of
following the terms and conditions either of that version or of any later version published by the
Free Software Foundation. If the Program does not specify a version number of this License,
you may choose any version ever published by the Free Software Foundation.
11. If you wish to incorporate parts of the Program into other free programs whose distribution
conditions are different, write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free Software Foundation; we
sometimes make exceptions for this. Our decision will be guided by the two goals of preserving
the free status of all derivatives of our free software and of promoting the sharing and reuse of
software generally.
NO WARRANTY
1. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH
YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR OR CORRECTION.
2. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR
DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL
DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING
BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO
OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY
HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
– 882 –
List of Commands
– 883 –
List of Commands
– 884 –
List of Commands
– 885 –
List of Commands
– 886 –
List of Commands
– 887 –
List of Commands
– 888 –
List of Commands
– 889 –
List of Commands
– 890 –
List of Commands
– 891 –
List of Commands
– 892 –